BIS fnc wpWinchLoad: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|Game|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Arguments in MP|Multiplayer Arguments( \("local" or "global"\))?|Effects|Execution|Effects? in MP|Multiplayer Effects(...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| TKOH |Game name=
| TKOH


|1.00|Game version=
|1.00


|gr1= Waypoints |GROUP1=
|gr1= Waypoints


| WINCH LOAD [[Custom_Waypoints|custom waypoint]].
| 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=


|p1= limitHeight: [[Number]] - height tolerance from waypoint's height (default: 10m) |Parameter1=
| [[Custom_Waypoints#Function|arguments]]: [limitHeight,winchID,crewman,failCode,loadCode]


|p2= winchID: [[Number]] - ID of vehicle's winch position. Positions are defined in vehicle's config under RopePositions >> Winch (default: 0) |Parameter2=
|p1= limitHeight: [[Number]] - height tolerance from waypoint's height (default: 10m)


|p3= crewman: [[Object]] - person going down on a rope (default: 2nd person in vehicle's [[crew]]) |Parameter3=
|p2= winchID: [[Number]] - ID of vehicle's winch position. Positions are defined in vehicle's config under RopePositions >> Winch (default: 0)


|p4= failCode: [[Code]] - code executed when anything happens to persons on rope (default: {}) |Parameter4=
|p3= crewman: [[Object]] - person going down on a rope (default: 2nd person in vehicle's [[crew]])


|p5= loadCode: [[Code]] - code executed everytime person from a group is selected to be loaded into helicopter (default: {}) |Parameter5=
|p4= failCode: [[Code]] - code executed when anything happens to persons on rope (default: {})


| [[Nothing]] |RETURNVALUE=
|p5= loadCode: [[Code]] - code executed everytime person from a group is selected to be loaded into helicopter (default: {})
 
| [[Nothing]]
   
   
|x1= <code><nowiki>[</nowiki>[[player]], dude, 50, 5, 1, rescuer, {[[hintC]] "Rescuer died!"}, {[[hintC]] "Dude saved"}] [[spawn]] BIS_fnc_wpWinchLoad;</code> |EXAMPLE1=
|x1= <code><nowiki>[</nowiki>[[player]], dude, 50, 5, 1, rescuer, {[[hintC]] "Rescuer died!"}, {[[hintC]] "Dude saved"}] [[spawn]] BIS_fnc_wpWinchLoad;</code>


| exec=spawn
| exec=spawn


| |SEEALSO=
|


}}
}}

Revision as of 11:11, 18 January 2021

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:
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