currentVisionMode: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
Line 26: Line 26:
|r1= [[Number]] - vision mode
|r1= [[Number]] - vision mode


|s2= [[currentVisionMode]] [entity]        ''Since Arma 3 v2.07.148193''
|s2= [[currentVisionMode]] [entity]
 
|s2since= arma3 2.08


|p21= entity: [[Object]] - unit or vehicle. Unit query returns current vision mode of the unit. Vehicle query returns driver seat vision mode
|p21= entity: [[Object]] - unit or vehicle. Unit query returns current vision mode of the unit. Vehicle query returns driver seat vision mode
Line 32: Line 34:
|r2= [[Array]] - in format [vision mode, FLIR index]
|r2= [[Array]] - in format [vision mode, FLIR index]


|s3= vehicle [[currentVisionMode]] turret        ''Since Arma 3 v2.07.148193''
|s3= vehicle [[currentVisionMode]] turret
 
|s3since= arma3 2.08


|p41= vehicle: [[Object]] - vehicle with vision modes
|p41= vehicle: [[Object]] - vehicle with vision modes
|p42= turret: [[Array]] - path to vehicle's turret. Use [-1] for driver turret, [] for default primary gunner turret
|p42= turret: [[Array]] - path to vehicle's turret. Use [-1] for driver turret, [] for default primary gunner turret


|r3= [[Array]] - in format [vision mode, FLIR index]
|r3= [[Array]] - in format [vision mode, FLIR index]


|s4= unit [[currentVisionMode]] weapon        ''Since Arma 3 v2.07.148193''
|s4= unit [[currentVisionMode]] weapon
 
|s4since= arma3 2.08


|p61= unit: [[Object]] - soldier
|p61= unit: [[Object]] - soldier
|p62= weapon: [[String]] - unit's weapon. Use "" for current weapon
|p62= weapon: [[String]] - unit's weapon. Use "" for current weapon


Line 57: Line 65:
}}
}}


<dl class="command_description">
{{Note
 
|user= AgentRev
<dt></dt>
|timestamp= 20160429213100
<dd class="notedate">Posted on April 29, 2016 - 21:31 (UTC)</dd>
|text= {{Feature|obsolete||arma3|2.08}}
<dt class="note">[[User:AgentRevolution|AgentRev]]</dt>
The return value is somewhat erratic for UAVs. For example, if you are connected to a UAV, with the turret set to thermal vision and PIP feed enabled, "currentVisionMode gunner _uav" returns 2 when controlling the turret, but returns 0 after releasing control, even thought the PIP feed is still in thermal mode. WIth nightvision, it will return 1 whether or not you are controlling the turret, but if you switch from 1st to 3rd person before releasing control, then it returns 0 afterwards...
<dd class="note">
}}
EDIT: REMOVE AFTER 2.08 The return value is somewhat erratic for UAVs. For example, if you are connected to a UAV, with the turret set to thermal vision and PIP feed enabled, "currentVisionMode gunner _uav" returns 2 when controlling the turret, but returns 0 after releasing control, even thought the PIP feed is still in thermal mode. WIth nightvision, it will return 1 whether or not you are controlling the turret, but if you switch from 1st to 3rd person before releasing control, then it returns 0 afterwards...
</dd>
 
</dl>

Revision as of 12:21, 13 September 2021

Hover & click on the images for description

Description

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)
Groups:
Weapons

Syntax 1

Syntax:
currentVisionMode entity
Parameters:
entity: Object - unit or vehicle. Unit query returns current vision mode of the unit. Vehicle query returns driver seat vision mode
Return Value:
Number - vision mode

Syntax 2

Syntax:
currentVisionMode [entity]
Parameters:
entity: Object - unit or vehicle. Unit query returns current vision mode of the unit. Vehicle query returns driver seat vision mode
Return Value:
Array - in format [vision mode, FLIR index]

Syntax 3

Syntax:
vehicle currentVisionMode turret
Parameters:
vehicle: Object - vehicle with vision modes
turret: Array - path to vehicle's turret. Use [-1] for driver turret, [] for default primary gunner turret
Return Value:
Array - in format [vision mode, FLIR index]

Syntax 4

Syntax:
unit currentVisionMode weapon
Parameters:
unit: Object - soldier
weapon: String - unit's weapon. Use "" for current weapon
Return Value:
Array - in format [vision mode, FLIR index]

Examples

Example 1:
_currMode = currentVisionMode gunner _tank
Example 2:
if (currentVisionMode player == 1) then { hint "nightvision active"; };

Additional Information

See also:
disableNVGEquipmentdisableTIEquipmentcamUseNVGsetCamUseTIcurrentMagazinecurrentWeaponcurrentMuzzlecurrentWeaponModecurrentZeroingmagazinesTurretweaponsTurret

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
AgentRev - c
Posted on Apr 29, 2016 - 21:31 (UTC)
🕖
The following information is obsolete as of Arma 3 v2.08.

The return value is somewhat erratic for UAVs. For example, if you are connected to a UAV, with the turret set to thermal vision and PIP feed enabled, "currentVisionMode gunner _uav" returns 2 when controlling the turret, but returns 0 after releasing control, even thought the PIP feed is still in thermal mode. WIth nightvision, it will return 1 whether or not you are controlling the turret, but if you switch from 1st to 3rd person before releasing control, then it returns 0 afterwards...