BIS fnc moveToRespawnPosition: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
| Line 1: | Line 1: | ||
{{RV|type=function | {{RV|type=function | ||
| arma3 | |game1= arma3 | ||
|version1= 1.00 | |||
|arg= local | |arg= local | ||
|gr1= Respawn | |gr1= Respawn | ||
| 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]]. | |descr= 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]]. | ||
|s1=[unit, position, canBeDead] call [[BIS_fnc_moveToRespawnPosition]] | |s1= [unit, position, canBeDead] call [[BIS_fnc_moveToRespawnPosition]] | ||
|p1= unit: [[Object]] - unit to move | |p1= unit: [[Object]] - unit to move | ||
|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 | ||
| Line 17: | Line 19: | ||
* [[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] | ||
|p3= canBeDead | |p3= canBeDead: [[Boolean]] - (Optional, default [[true]]) whether or not dead are allowed: | ||
* [[true]] | * [[true]] - moved unit and/or object to which unit is moved can be dead | ||
* [[false]] - | * [[false]] - both moved unit and vehicle or unit at position (if any) must be alive | ||
|r1=[[Boolean]] - [[true]]: move succeeded, [[false]]: move failed | |r1= [[Boolean]] - [[true]]: move succeeded, [[false]]: move failed | ||
|x1= <code>[<nowiki/>[[player]], "SpawnMarker1"] [[call]] [[BIS_fnc_moveToRespawnPosition]];</code> | |x1= <code>[<nowiki/>[[player]], "SpawnMarker1"] [[call]] [[BIS_fnc_moveToRespawnPosition]];</code> | ||
|seealso= | |||
}} | }} | ||
Revision as of 19:44, 13 June 2021
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:
- 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