BIS fnc moveToRespawnPosition: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<code>([^<]*)<nowiki\/>\[\[([a-zA-Z0-9_]+)\]\](.*)<\/code>" to "<code>$1$2$3</code>")
m (Text replacement - "= <code>([^<]*)\[\[([a-zA-Z][a-zA-Z0-_]+)\]\]([^<]*)<\/code>" to "= <code>$1$2$3</code>")
Line 25: Line 25:
|r1= [[Boolean]] - [[true]]: move succeeded, [[false]]: move failed
|r1= [[Boolean]] - [[true]]: move succeeded, [[false]]: move failed


|x1= <code>[player, "SpawnMarker1"] [[call]] [[BIS_fnc_moveToRespawnPosition]];</code>
|x1= <code>[player, "SpawnMarker1"] call [[BIS_fnc_moveToRespawnPosition]];</code>


|seealso=
|seealso=
}}
}}

Revision as of 17:56, 13 July 2022

Hover & click on the images for description

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

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: Boolean - (Optional, default true) whether or not dead are allowed:
  • true - 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
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