BIS fnc moveToRespawnPosition: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\[\[Category\:Function Group\: Respawn(\|\{\{[a-zA-Z0-9_:]+\}\})?\]\]" to "")
m (Text replacement - "_{10,} " to "")
Line 1: Line 1:
{{Function|Comments=
{{Function|Comments=
____________________________________________________________________________________________


| arma3 |Game name=
| arma3 |Game name=
Line 7: Line 6:


|gr1= Respawn |GROUP1=
|gr1= Respawn |GROUP1=
____________________________________________________________________________________________


| 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=
| 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]] |SYNTAX=
| [unit, position, canBeDead] call [[BIS_fnc_moveToRespawnPosition]] |SYNTAX=
Line 25: Line 22:


| [[Boolean]] - [[true]]: move succeeded, [[false]]: move failed|RETURNVALUE=
| [[Boolean]] - [[true]]: move succeeded, [[false]]: move failed|RETURNVALUE=
____________________________________________________________________________________________


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


| |SEEALSO=
| |SEEALSO=

Revision as of 23:22, 16 January 2021

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 (Optional): Boolean - Whether or not dead are allowed:
  • 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
Return Value:
PARAMETER3

Examples

Example 1:
[player, "SpawnMarker1"] call BIS_fnc_moveToRespawnPosition;

Additional Information

See also:
Boolean - true: move succeeded, false: move failed

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

Notes

Bottom Section