enableGunLights: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\|gr([0-9]+) = " to "|gr$1= ")
(merged enableGunLights pages)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


|game1= arma3
|game1= arma2oa


|version1= 1.00
|version1= 1.51
 
|game2= tkoh
 
|version2= 1.00
 
|game3= arma3
 
|version3= 0.50


|gr1= Lights
|gr1= Lights
Line 13: Line 21:
|eff= global
|eff= global


|descr= Sets AI group option how to use gun lights.
|descr= Toggles target's gun light.
{{Feature|arma3 | This syntax is for {{arma3}}. For {{arma2}} syntax, see [[enableGunLights Arma 2]].}}
 
|s1= target [[enableGunLights]] state {{Since|arma2oa|1.51|y}}, ''also available in {{tkoh}} v1.00''
 
|p1= target : [[Group]] or [[Object]] - The group forced to use gun lights. If unit is supplied as argument, unit's group is used


| group [[enableGunLights]] mode
|p2= state: [[Boolean]] - [[true|True]] to enable, [[false]] to disable


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


|p2= mode: [[String]] - Can be:
|s2= target [[enableGunLights]] mode {{Since|arma3|0.50|y}}
 
|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:
* <tt>"Auto"</tt> - Depends on combat mode  
* <tt>"Auto"</tt> - Depends on combat mode  
* <tt>"ForceOn"</tt> - Always on
* <tt>"ForceOn"</tt> - Always on
* <tt>"ForceOff"</tt> - Always off
* <tt>"ForceOff"</tt> - Always off


|r1= [[Nothing]]
|r2= [[Nothing]]
   
   
|x1= <code>_group [[enableGunLights]] "ForceOn";</code>
|x1= <code>_group [[enableGunLights]] "ForceOn";</code>

Revision as of 00:16, 18 April 2021

Hover & click on the images for description

Description

Description:
Toggles target's gun light.
Groups:
LightsWeapons

Syntax

Syntax:
target enableGunLights state Template:Since, also available in Take On Helicopters v1.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 Template:Since
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 "ForceOn";
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