BIS fnc wpWinchLoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Comments" to "|Comments=")
m (Some wiki formatting)
 
(27 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
____________________________________________________________________________________________


| WINCH LOAD [[Custom_Waypoints|custom waypoint]].
|exec= spawn
 
|descr= WINCH LOAD [[Custom_Waypoints|custom waypoint]].


Load a group into helicopter cargo using winch.
Load a group into helicopter cargo using winch.
|DESCRIPTION=
____________________________________________________________________________________________


| [[Custom_Waypoints#Function|arguments]]: [limitHeight,winchID,crewman,failCode,loadCode] |SYNTAX=
|s1= [[Custom Waypoints#Function|Custom Waypoint arguments]]: [limitHeight, winchID, crewman, failCode, loadCode]


|p1= limitHeight: [[Number]] - height tolerance from waypoint's height (default: 10m) |=
|p1= limitHeight: [[Number]] - height tolerance from waypoint's height (default: 10m)


|p2= winchID: [[Number]] - ID of vehicle's winch position. Positions are defined in vehicle's config under RopePositions >> Winch (default: 0) |=
|p2= winchID: [[Number]] - ID of vehicle's winch position. Positions are defined in vehicle's config under RopePositions >> Winch (default: 0)


|p3= crewman: [[Object]] - person going down on a rope (default: 2nd person in vehicle's [[crew]]) |=
|p3= crewman: [[Object]] - person going down on a rope (default: 2nd person in vehicle's [[crew]])


|p4= failCode: [[Code]] - code executed when anything happens to persons on rope (default: {}) |=
|p4= failCode: [[Code]] - code executed when anything happens to persons on rope (default: {})


|p5= loadCode: [[Code]] - code executed everytime person from a group is selected to be loaded into helicopter (default: {}) |=
|p5= loadCode: [[Code]] - code executed everytime person from a group is selected to be loaded into helicopter (default: {})


| [[Nothing]] |RETURNVALUE=
|r1= [[Nothing]]
____________________________________________________________________________________________
 
|x1= <code><nowiki>[</nowiki>[[player]], dude, 50, 5, 1, rescuer, {[[hintC]] "Rescuer died!"}, {[[hintC]] "Dude saved"}] [[spawn]] BIS_fnc_wpWinchLoad;</code> |EXAMPLE1=


____________________________________________________________________________________________
|x1= <sqf>[player, dude, 50, 5, 1, rescuer, {hintC "Rescuer died!"}, {hintC "Dude saved"}] spawn BIS_fnc_wpWinchLoad;</sqf>
| exec=spawn |=
 
| |SEEALSO=


|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|wpWinchLoad]]
[[Category:Function Group: Waypoints|wpWinchLoad]]

Latest revision as of 12:29, 1 July 2022

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

Description

Description:
WINCH LOAD custom waypoint. Load a group into helicopter cargo using winch.
Execution:
spawn
Groups:
Waypoints

Syntax

Syntax:
Custom Waypoint arguments: [limitHeight, winchID, crewman, failCode, loadCode]
Parameters:
limitHeight: Number - height tolerance from waypoint's height (default: 10m)
winchID: Number - ID of vehicle's winch position. Positions are defined in vehicle's config under RopePositions >> Winch (default: 0)
crewman: Object - person going down on a rope (default: 2nd person in vehicle's crew)
failCode: Code - code executed when anything happens to persons on rope (default: {})
loadCode: Code - code executed everytime person from a group is selected to be loaded into helicopter (default: {})
Return Value:
Nothing

Examples

Example 1:
[player, dude, 50, 5, 1, rescuer, {hintC "Rescuer died!"}, {hintC "Dude saved"}] spawn BIS_fnc_wpWinchLoad;

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_wpWinchLoad&oldid=323179"