enableGunLights: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (formatting)
m (Switched to {{GVI}}, changed Example 1 to Main Syntax)
Line 21: Line 21:
|eff= global
|eff= global


|descr= Toggles target's gun light. {{Feature|arma3|Since {{arma3}} v0.50 the '''first syntax got replaced by the alternative syntax'''. The '''first syntax is not available anymore in {{arma3}}!'''}}
|descr= Toggles the target group's gun light(s).
{{Feature|arma3|In {{arma3}}, only the [[#Alternative Syntax|Alternative Syntax]] is available.}}


|s1= target [[enableGunLights]] state ''Available in {{arma2oa}} v1.51 and {{tkoh}} v1.00''
|s1= target [[enableGunLights]] state {{GVI|arma2oa|1.51}}{{GVI|tkoh|1.00}}


|p1= target : [[Group]] or [[Object]] - The group forced to use gun lights. If unit is supplied as argument, unit's group is used
|p1= target: [[Group]] or [[Object]] - The group forced to use gun lights. If unit is supplied as argument, unit's group is used


|p2= state: [[Boolean]] - [[true|True]] to enable, [[false]] to disable
|p2= state: [[Boolean]] - [[true|True]] to enable, [[false]] to disable
Line 31: Line 32:
|r1= [[Nothing]]
|r1= [[Nothing]]


|s2= target [[enableGunLights]] mode ''Available since {{arma3}} v0.50''
|s2= target [[enableGunLights]] mode {{GVI|arma3|0.50}}


|p21= target : [[Group]] or [[Object]] - The group forced to use gun lights. If unit is supplied as argument, unit's group is used
|p21= target: [[Group]] or [[Object]] - The group forced to use gun lights. If unit is supplied as argument, unit's group is used


|p22= mode: [[String]] - Can be:
|p22= mode: [[String]] - Can be:
Line 42: Line 43:
|r2= [[Nothing]]
|r2= [[Nothing]]
   
   
|x1= <code>_group [[enableGunLights]] "ForceOn";</code>
|x1= <code>_group [[enableGunLights]] [[false]];</code>


|x2= <code>_unit [[enableGunLights]] "Auto";</code>
|x2= <code>_unit [[enableGunLights]] "Auto";</code>

Revision as of 11:16, 18 April 2021

A2 OA Logo.png1.51tkoh logo small.png1.00Arma 3 logo black.png0.50
LALocalGEGlobal
Hover & click on the images for description

Description

Description:
Toggles the target group's gun light(s).
Arma 3
In Arma 3, only the Alternative Syntax is available.
Groups:
LightsWeapons

Syntax

Syntax:
target enableGunLights state A2 OA Logo.png1.51tkoh logo small.png1.00
Parameters:
target: Group or Object - The group forced to use gun lights. If unit is supplied as argument, unit's group is used
state: Boolean - True to enable, false to disable
Return Value:
Nothing

Alternative Syntax

Syntax:
target enableGunLights mode Arma 3 logo black.png0.50
Parameters:
target: Group or Object - The group forced to use gun lights. If unit is supplied as argument, unit's group is used
mode: String - Can be:
  • "Auto" - Depends on combat mode
  • "ForceOn" - Always on
  • "ForceOff" - Always off
Return Value:
Nothing

Examples

Example 1:
_group enableGunLights false;
Example 2:
_unit enableGunLights "Auto";
Example 3:
_unit enableGunLights "ForceOff";

Additional Information

See also:
isFlashlightOn

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
Retrieved from "https://community.bistudio.com/wiki?title=enableGunLights&oldid=255552"