currentVisionMode

Description

Returns current vision mode of unit's weapon. Vision mode could be one of:

• 0 - normal vision
• 1 - night vision
• 2 - thermal vision

Alternative syntaxes additionally return FLIR index (see setCamUseTI) of the thermal vision mode (See also "VisionModeChanged" entity event handler)

Syntax

Syntax 1

currentVisionMode entity

Parameters:

• entity: Object - unit or vehicle. Unit query returns current vision mode of the unit. Vehicle query returns driver seat vision mode

Returns: Number - vision mode (0 on error, e.g on objNull)

Syntax 2

since arma3 2.08

currentVisionMode [entity]

Parameters:

• entity: Object - unit or vehicle. Unit query returns current vision mode of the unit. Vehicle query returns driver seat vision mode

Returns: Array format [visionMode, flirIndex] where:

• visionMode: Number
• flirIndex: Number

[-1, -1] on error

Syntax 3

since arma3 2.08

vehicle currentVisionMode turretPath

Parameters:

• vehicle: Object - vehicle with vision modes
• turretPath: Turret Path - path to vehicle's turret. Use [-1] for driver turret, [] for default primary gunner turret

Returns: Array format [visionMode, flirIndex] where:

• visionMode: Number
• flirIndex: Number

[-1, -1] on error

Syntax 4

since arma3 2.08

unit currentVisionMode weapon

Parameters:

• unit: Object - soldier
• weapon: String - unit's weapon. Use "" for current weapon

Returns: Array format [visionMode, flirIndex] where:

• visionMode: Number
• flirIndex: Number

[-1, -1] on error

Examples

Example 1

_visionMode = currentVisionMode gunner _tank;

Example 2

if (currentVisionMode player == 1) then
{
    hint "nightvision active";
};

Example 3

private _detailedVisionMode = currentVisionMode [gunner _tank];
_detailedVisionMode params ["_mode", "_flirIndex"];

Example 4

private _detailedGunnerVisionMode = _tank currentVisionMode [0];

Example 5

private _detailedWeaponVisionMode = player currentVisionMode "";

See also

disableNVGEquipment · disableTIEquipment · camUseNVG · setCamUseTI · currentMagazine · currentWeapon · currentMuzzle · currentWeaponMode · currentZeroing · magazinesTurret · weaponsTurret