BIS fnc wpSlingLoadAttach: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *T([a-z ])" to "$1 - t$2")
 
(24 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|= Comments
{{RV|type=function
____________________________________________________________________________________________


| TKOH |= Game name
|game1= tkoh
|version1= 1.00


|1.00|= Game version
|gr1= Waypoints
____________________________________________________________________________________________


| ATTACH SLINGLOAD [[Custom_Waypoints|custom waypoint]].
|descr= ATTACH SLINGLOAD [[Custom_Waypoints|custom waypoint]].


Load an object to rope.
Load an object to rope.
|DESCRIPTION=
____________________________________________________________________________________________


| [[Custom_Waypoints#Function|arguments]]: [posLimit,failCode,weight] |SYNTAX=
|exec= spawn


|p1= posLimit: [[Number]] or [[Boolean]] - Time in seconds it takes to attach the cargo. When [[true]], cargo is attached immediately (default: -1). |=
|s1= [[Custom Waypoints#Function|Custom Waypoint arguments]]: [posLimit, failCode, weight]


|p2= failCode: [[Code]] - code executed if rope is cut by accident (e.g. collision with another object) (default: {}) |=
|p1= posLimit: [[Number]] or [[Boolean]] - time in seconds it takes to attach the cargo. When [[true]], cargo is attached immediately (default: -1)


|p3= weight: [[Number]] - cargo weight (default: model weight) |=
|p2= failCode: [[Code]] - code executed if rope is cut by accident (e.g. collision with another object) (default: {})


| [[Nothing]] |RETURNVALUE=
|p3= weight: [[Number]] - cargo weight (default: model weight)
____________________________________________________________________________________________
 
|x1= <code><nowiki>[</nowiki>[[player]], dude, 50, 10, {[[hintC]] "You lost the cargo!"}, 1000] [[spawn]] BIS_fnc_wpSlingLoadAttach;</code> |=


|x2= <code><nowiki>[</nowiki>[[player]], dude, 0, [[true]]] [[spawn]] BIS_fnc_wpSlingLoadAttach;</code>
|r1= [[Nothing]]
Attach the cargo immediately |=


____________________________________________________________________________________________
|x1= <sqf>[player, dude, 50, 10, { hintC "You lost the cargo!" }, 1000] spawn BIS_fnc_wpSlingLoadAttach;</sqf>
| exec=spawn |=


| |SEEALSO=
|x2= <sqf>[player, dude, 0, true] spawn BIS_fnc_wpSlingLoadAttach; // attaches the cargo immediately</sqf>


|seealso=
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Take_On_Helicopters:_Functions|wpSlingLoadAttach]]
[[Category:Function Group: Waypoints|wpSlingLoadAttach]]

Latest revision as of 15:51, 8 November 2023

tkoh logo small.png1.00
Hover & click on the images for description

Description

Description:
ATTACH SLINGLOAD custom waypoint. Load an object to rope.
Execution:
spawn
Groups:
Waypoints

Syntax

Syntax:
Custom Waypoint arguments: [posLimit, failCode, weight]
Parameters:
posLimit: Number or Boolean - time in seconds it takes to attach the cargo. When true, cargo is attached immediately (default: -1)
failCode: Code - code executed if rope is cut by accident (e.g. collision with another object) (default: {})
weight: Number - cargo weight (default: model weight)
Return Value:
Nothing

Examples

Example 1:
[player, dude, 50, 10, { hintC "You lost the cargo!" }, 1000] spawn BIS_fnc_wpSlingLoadAttach;
Example 2:
[player, dude, 0, true] spawn BIS_fnc_wpSlingLoadAttach; // attaches the cargo immediately

Additional Information

See also:
See also needed

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_wpSlingLoadAttach&oldid=349275"