enableGunLights: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Parameter 2)
m (Text replacement - "{{Feature|Important|" to "{{Feature|important|")
 
(65 intermediate revisions by 15 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{TabView
____________________________________________________________________________________________


| arma2oa |= Game name
|selected= 2


|1.52|= Game version
|title1= {{TabView/GameTitle|arma2oa|tkoh}}
____________________________________________________________________________________________
|content1=


| Force the AI to use gun lights |= Description
{{RV|type=command
____________________________________________________________________________________________


| thing '''enableGunLights''' value |= Syntax
|game1= arma2oa
|version1= 1.50


|p1= thing: [[Object]] or [[Group]] - the unit or the group forced to use gun lights |= Parameter 1
|game2= tkoh
|p2= value: [[Boolean]] - true/false |= Parameter 2
|version2= 1.00


| [[Nothing]] |= Return value
|gr1= Lights
____________________________________________________________________________________________
|gr2= Weapons
 
|x1= <pre>(units group player) enableGunLights true</pre> |= Example 1
____________________________________________________________________________________________


| |= See also
|arg= local
|eff= global


|descr= Toggles the target group's gun light(s).
|s1= target [[enableGunLights]] state
|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]] to enable, [[false]] to disable
|r1= [[Nothing]]
|x1= <sqf>_group enableGunLights false;</sqf>
|seealso= [[isFlashlightOn]]
}}
}}


<h3 style="display:none">Notes</h3>
|title2= {{Icon|arma3|24|link=}} {{arma3}}
<dl class="command_description">
|content2=
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>


<h3 style="display:none">Bottom Section</h3>
{{RV|type=command


[[Category:ArmA 2 OA: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
|game1= arma3
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
|version1= 0.50
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 
|gr1= Lights
|gr2= Weapons
 
|arg= local
|eff= global
 
|descr= Toggles the target group's gun lights. [[disableAI]] "LIGHTS" will disable the use of gun lights.
 
{{Feature|important|This command acts on each unit of the provided group or provided unit's group; there is no need to apply it on each unit.}}
 
 
|s1= target [[enableGunLights]] mode
 
|p1= target: [[Group]] or [[Object]] - the group forced to use gun lights. If unit is supplied as argument, unit's group is used
 
|p2= mode: [[String]] - can be:
* {{hl|"Auto"}} - Depends on combat mode
* {{hl|"ForceOn"}} - Always on
* {{hl|"ForceOff"}} - Always off
 
|r1= [[Nothing]]
 
|x1= <sqf>_groupA enableGunLights "Auto";</sqf>
 
|x2= <sqf>_unit1 enableGunLights "ForceOff"; // sets _unit1's GROUP behaviour to not use gun lights</sqf>
 
|seealso= [[isFlashlightOn]] [[enableIRLasers]]
}}
 
}}

Latest revision as of 01:23, 2 February 2024

A2 OA Logo.png Arma 2: Operation Arrowhead to tkoh logo small.png Take On Helicopters
Arma 3 logo black.png Arma 3
Hover & click on the images for description

Description

Description:
Toggles the target group's gun light(s).
Groups:
LightsWeapons

Syntax

Syntax:
target enableGunLights state
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

Examples

Example 1:
_group enableGunLights false;

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
Hover & click on the images for description

Description

Description:
Toggles the target group's gun lights. disableAI "LIGHTS" will disable the use of gun lights.
This command acts on each unit of the provided group or provided unit's group; there is no need to apply it on each unit.
Groups:
LightsWeapons

Syntax

Syntax:
target enableGunLights mode
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:
_groupA enableGunLights "Auto";
Example 2:
_unit1 enableGunLights "ForceOff"; // sets _unit1's GROUP behaviour to not use gun lights

Additional Information

See also:
isFlashlightOn enableIRLasers

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