getRespawnVehicleInfo

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.

Syntax

Syntax 1

getRespawnVehicleInfo vehicle

Parameters:

vehicle: Object - transport

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

Syntax 2

vehicle getRespawnVehicleInfo index

Parameters:

vehicle: Object - transport
index: Number - property index (see main syntax, for example 10 for isRespawning)

Returns: Anything - depends on the requested property, or Nothing

Examples

Example 1

private _vehInfo = getRespawnVehicleInfo veh1;

Example 2

private _isRespawning = veh1 getRespawnVehicleInfo 10;