getRespawnVehicleInfo: Difference between revisions

From Bohemia Interactive Community
No edit summary
mNo edit summary
 
(7 intermediate revisions by 4 users not shown)
Line 5: Line 5:


|arg= global
|arg= global
|branch= dev


|gr1= Multiplayer
|gr1= Multiplayer


|descr= Returns various properties for the respawning vehicle. All properties are synched over the network and should be the same on every client including JIP
|descr= Returns various properties for the respawning vehicle (see [[Vehicle Respawn]]). All properties are synched over the network and should be the same on every client including [[JIP]].


|s1= [[getRespawnVehicleInfo]] vehicle
|s1= [[getRespawnVehicleInfo]] vehicle
Line 16: Line 14:
|p1= vehicle: [[Object]] - transport
|p1= vehicle: [[Object]] - transport


|r1= [[Array]] in format [respawnDelay, respawnCount, deleteOldWreck, respawnOnServer, respawnFlying, respawnUnit, respawnMode, respawnSide, useRespawnMarkerDir, canRespawn, isRespawning, respawnMarkerName, respawnTimeRemaining, missionRespawnDelay, missionRespawnMode], where:
|r1= [[Array]] with [respawnDelay, respawnCount, deleteOldWreck, respawnOnServer, respawnFlying, respawnUnit, respawnMode, respawnSide, useRespawnMarkerDir, canRespawn, isRespawning, respawnMarkerName, respawnTimeRemaining, missionRespawnDelay, missionRespawnMode]
* respawnDelay: [[Number]] - how long the vehicle will be in respawn queue after death. -1 - 'missionRespawnDelay' value is used.
* respawnCount: [[Number]] - how many times left for the vehicle to respawn. -1 - indefinite, 0 - no more respawns
* deleteOldWreck: [[Boolean]] - if [[true]] then the old wreck will be deleted when vehicle respawns.
* respawnOnServer: [[Boolean]] - if [[true]] the wreck will be transfered to the server and vehicle will respawn on server.
* respawnFlying: [[Boolean]] - if [[true]] vehicle will not be forced to the ground and if can fly and has pilot will be spawned flying.
* respawnUnit: [[Object]] - pilot/driver unit that will be placed into the new vehicle.
* respawnMode: [[Number]] - individual respawn mode for this vehicle. Any mode other than 2,3 or -1 means disabled respawn. -1 - use 'missionRespawnMode'
* respawnSide: [[Side]] - what side markers to use for respawn. For example if 'respawnSide' set to [[east]] the markers with names 'respawn_vehicle_eastXXX' and 'respawn_eastXXX' will be used.
* useRespawnMarkerDir: [[Boolean]] - align respawned vehicle with respawn marker direction or with wreck direction if no marker found or "INSTANT" mode is used. Otherwise, direction is random.
* canRespawn: [[Boolean]] - [[true]] if vehicle is respawnable (all conditions for respawn are ok)
* isRespawning: [[Boolean]] - [[true]] if vehicle is currently in the respawn queue awaiting respawn.
* respawnMarkerName: [[String]] - Chosen vehicle respawn marker, when vehicle respawns it will use the marker params. The respawn marker is processed instantly uppon vehicle's death.
* respawnTimeRemaining: [[Number]] - how long left before the respawn. -1 after vehicle has respawned or has respawn disabled.
* missionRespawnDelay: [[Number]] - global mission vehicle respawn delay. script command > mission param > 3DEN param
* missionRespawnMode: [[Number]] - global mission vehicle respawn mode. script command > mission param > 3DEN param


* 0 - respawnDelay: [[Number]] - how long the vehicle will be in respawn queue after death. -1 - 'missionRespawnDelay' value is used.
|s2= vehicle [[getRespawnVehicleInfo]] index
* 1 - respawnCount: [[Number]] - how many times left for the vehicle to respawn. -1 - indefinite, 0 - no more respawns
* 2 - deleteOldWreck: [[Boolean]] - if [[true]] then the old wreck will be deleted when vehicle respawns.
* 3 - respawnOnServer: [[Boolean]] - if [[true]] the wreck will be transfered to the server and vehicle will respawn on server.
* 4 - respawnFlying: [[Boolean]] - if [[true]] vehicle will not be forced to the ground and if can fly and has pilot will be spawned flying.
* 5 - respawnUnit: [[Object]] - pilot/driver unit that will be placed into the new vehicle.
* 6 - respawnMode: [[Number]] - individual respawn mode for this vehicle. Any mode other than 2,3 or -1 means disabled respawn. -1 - use 'missionRespawnMode'
* 7 - respawnSide: [[Side]] - what side markers to use for respawn. For example if 'respawnSide' set to [[east]] the markers with names 'respawn_vehicle_eastXXX' and 'respawn_eastXXX' will be used.
* 8 - useRespawnMarkerDir: [[Boolean]] - align respawned vehicle with respawn marker direction or with wreck direction if no marker found or "INSTANT" mode is used. Otherwise, direction is random.
* 9 - canRespawn: [[Boolean]] - [[true]] if vehicle is respawnable (all conditions for respawn are ok)
* 10 - isRespawning: [[Boolean]] - [[true]] if vehicle is currently in the respawn queue awaiting respawn.
* 11 - respawnMarkerName: [[String]] - Chosen vehicle respawn marker, when vehicle respawns it will use the marker params. The respawn marker is processed instantly uppon vehicle's death.
* 12 - respawnTimeRemaining: [[Number]] - how long left before the respawn. -1 after vehicle has respawned or has respawn disabled.
* 13 - missionRespawnDelay: [[Number]] - global mission vehicle respawn delay. script command > mission param > 3DEN param
* 14 - missionRespawnMode: [[Number]] - global mission vehicle respawn mode. script command > mission param > 3DEN param


|s2= vehicle [[getRespawnVehicleInfo]] index
|p21= vehicle: [[Object]] - transport
|p21= vehicle: [[Object]] - transport
|p22= index: [[Number]] - property index (see main syntax, for example 10 for isRespawning)
|p22= index: [[Number]] - property index (see main syntax, for example 10 for isRespawning)
|r2= [[Anything]] - depends on the requested property, or [[Nothing]]
|r2= [[Anything]] - depends on the requested property, or [[Nothing]]


|x1= <sqf>private _vehInfo = getRespawnVehicleInfo veh1;</sqf>
|x1= <sqf>private _vehInfo = getRespawnVehicleInfo veh1;</sqf>
|x2= <sqf>private _isRespawning = veh1 getRespawnVehicleInfo 10;</sqf>
|x2= <sqf>private _isRespawning = veh1 getRespawnVehicleInfo 10;</sqf>


|seealso= [[respawnVehicle]], [[playerRespawnTime]], [[getEntityInfo]]
|seealso= [[Vehicle Respawn]] [[respawnVehicle]], [[playerRespawnTime]], [[getEntityInfo]]
}}
}}

Latest revision as of 04:52, 3 January 2026

Arma 3 logo black.png 2.18
GAGlobal
Hover & click on the images for description

Description

Description:
Returns various properties for the respawning vehicle (see Vehicle Respawn). All properties are synched over the network and should be the same on every client including JIP.
Groups:
Multiplayer

Syntax

Syntax:
getRespawnVehicleInfo vehicle
Parameters:
vehicle: Object - transport
Return Value:
Array with [respawnDelay, respawnCount, deleteOldWreck, respawnOnServer, respawnFlying, respawnUnit, respawnMode, respawnSide, useRespawnMarkerDir, canRespawn, isRespawning, respawnMarkerName, respawnTimeRemaining, missionRespawnDelay, missionRespawnMode]
  • respawnDelay: Number - how long the vehicle will be in respawn queue after death. -1 - 'missionRespawnDelay' value is used.
  • respawnCount: Number - how many times left for the vehicle to respawn. -1 - indefinite, 0 - no more respawns
  • deleteOldWreck: Boolean - if true then the old wreck will be deleted when vehicle respawns.
  • respawnOnServer: Boolean - if true the wreck will be transfered to the server and vehicle will respawn on server.
  • respawnFlying: Boolean - if true vehicle will not be forced to the ground and if can fly and has pilot will be spawned flying.
  • respawnUnit: Object - pilot/driver unit that will be placed into the new vehicle.
  • respawnMode: Number - individual respawn mode for this vehicle. Any mode other than 2,3 or -1 means disabled respawn. -1 - use 'missionRespawnMode'
  • respawnSide: Side - what side markers to use for respawn. For example if 'respawnSide' set to east the markers with names 'respawn_vehicle_eastXXX' and 'respawn_eastXXX' will be used.
  • useRespawnMarkerDir: Boolean - align respawned vehicle with respawn marker direction or with wreck direction if no marker found or "INSTANT" mode is used. Otherwise, direction is random.
  • canRespawn: Boolean - true if vehicle is respawnable (all conditions for respawn are ok)
  • isRespawning: Boolean - true if vehicle is currently in the respawn queue awaiting respawn.
  • respawnMarkerName: String - Chosen vehicle respawn marker, when vehicle respawns it will use the marker params. The respawn marker is processed instantly uppon vehicle's death.
  • respawnTimeRemaining: Number - how long left before the respawn. -1 after vehicle has respawned or has respawn disabled.
  • missionRespawnDelay: Number - global mission vehicle respawn delay. script command > mission param > 3DEN param
  • missionRespawnMode: Number - global mission vehicle respawn mode. script command > mission param > 3DEN param

Alternative Syntax

Syntax:
vehicle getRespawnVehicleInfo index
Parameters:
vehicle: Object - transport
index: Number - property index (see main syntax, for example 10 for isRespawning)
Return Value:
Anything - depends on the requested property, or Nothing

Examples

Example 1:
private _vehInfo = getRespawnVehicleInfo veh1;
Example 2:
private _isRespawning = veh1 getRespawnVehicleInfo 10;

Additional Information

See also:
Vehicle Respawn respawnVehicleplayerRespawnTimegetEntityInfo

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note
Retrieved from "https://community.bistudio.com/wiki?title=getRespawnVehicleInfo&oldid=377795"