BIS fnc moveToRespawnPosition: Difference between revisions
Jump to navigation
Jump to search
Killzone Kid (talk | contribs) No edit summary |
m (template:command argument fix) |
||
| Line 8: | Line 8: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Move given unit to given respawn position. Units moved to height <nowiki>>=</nowiki> 30m will start on parachute. Position [0,0,0] is blacklisted. This function must be executed where unit to be moved is [[local]] |= | | Move given unit to given respawn position. Units moved to height <nowiki>>=</nowiki> 30m will start on parachute. Position [0,0,0] is blacklisted. This function must be executed where unit to be moved is [[local]] |DESCRIPTION= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| [unit, position, canBeDead] call [[BIS_fnc_moveToRespawnPosition]] |= | | [unit, position, canBeDead] call [[BIS_fnc_moveToRespawnPosition]] |SYNTAX= | ||
|p1= unit: [[Object]] - unit to move |= | |p1= unit: [[Object]] - unit to move |PARAMETER1= | ||
|p2= position: [[Object]], [[Group]], [[String]] or [[Array]] | |p2= position: [[Object]], [[Group]], [[String]] or [[Array]] | ||
* [[Object]] or [[Group]] - Object or Group to move unit to. Move to the object position or inside an object if the object is a vehicle, or if group or unit is in vehicle and there is an empty seat | * [[Object]] or [[Group]] - Object or Group to move unit to. Move to the object position or inside an object if the object is a vehicle, or if group or unit is in vehicle and there is an empty seat | ||
* [[String]] - Marker to move unit to. Marker size will be used for random placement area and marker direction for unit direction | * [[String]] - Marker to move unit to. Marker size will be used for random placement area and marker direction for unit direction | ||
* [[Array]] - Precise [[PositionAGL]] to move unit to. [x,y] array will be converted to [x,y,0]|= | * [[Array]] - Precise [[PositionAGL]] to move unit to. [x,y] array will be converted to [x,y,0]|PARAMETER1= | ||
|p3= canBeDead (Optional): [[Boolean]] - Whether or not dead are allowed: | |p3= canBeDead (Optional): [[Boolean]] - Whether or not dead are allowed: | ||
* [[true]] (Default) - Moved unit and/or object to which unit is moved can be dead | * [[true]] (Default) - Moved unit and/or object to which unit is moved can be dead | ||
* [[false]] - Both moved unit and vehicle or unit at position (if any) must be alive |= | * [[false]] - Both moved unit and vehicle or unit at position (if any) must be alive |PARAMETER1= | ||
| [[Boolean]] - [[true]]: move succeeded, [[false]]: move failed|= | | [[Boolean]] - [[true]]: move succeeded, [[false]]: move failed|RETURNVALUE= | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| Line 28: | Line 28: | ||
____________________________________________________________________________________________ | ____________________________________________________________________________________________ | ||
| |= | | |SEEALSO= | ||
}} | }} | ||
Revision as of 15:32, 7 April 2019
Description
- Description:
- Move given unit to given respawn position. Units moved to height >= 30m will start on parachute. Position [0,0,0] is blacklisted. This function must be executed where unit to be moved is local
- Execution:
- call
- Groups:
- Uncategorised
Syntax
- Syntax:
- [unit, position, canBeDead] call BIS_fnc_moveToRespawnPosition
- Parameters:
- unit: Object - unit to move
- position: Object, Group, String or Array
- Object or Group - Object or Group to move unit to. Move to the object position or inside an object if the object is a vehicle, or if group or unit is in vehicle and there is an empty seat
- String - Marker to move unit to. Marker size will be used for random placement area and marker direction for unit direction
- Array - Precise PositionAGL to move unit to. [x,y] array will be converted to [x,y,0]
- canBeDead (Optional): Boolean - Whether or not dead are allowed:
- Return Value:
- Boolean - true: move succeeded, false: move failed
Examples
- Example 1:
[player, "SpawnMarker1"] call BIS_fnc_moveToRespawnPosition;
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