enableGunLights: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (template:command argument fix)
m (Some wiki formatting)
(45 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{TabView
____________________________________________________________________________________________


| arma3 |= Game name
|selected= 2


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


|arg= local |= Arguments in MP
{{RV|type=command


|eff= global |= Effects in MP
|game1= arma2oa
____________________________________________________________________________________________
|version1= 1.50


| Sets AI group option how to use gun lights. The string argument can be:
|game2= tkoh
* <tt>"Auto"</tt> - Depends on combat mode
|version2= 1.00
* <tt>"ForceOn"</tt> - Always on
* <tt>"ForceOff"</tt> - Always off<br><br>


{{ Informative | For Arma 2 syntax see [[enableGunLights Arma 2]] }} |DESCRIPTION=
|gr1= Lights
____________________________________________________________________________________________
|gr2= Weapons


| group '''enableGunLights''' mode |SYNTAX=
|arg= local
|eff= global


|p1= group: [[Group]] or [[Object]] - the group forced to use gun lights. If unit is supplied as argument, unit's group is used  |PARAMETER1=
|descr= Toggles the target group's gun light(s).
|p2= mode: [[String]] - <tt>"Auto"</tt>, <tt>"ForceOn"</tt>, <tt>"ForceOff"</tt> |PARAMETER2=


| [[Nothing]] |RETURNVALUE=
|s1= target [[enableGunLights]] state
____________________________________________________________________________________________
 
|x1= <code>_group [[enableGunLights]] "ForceOn";</code> |EXAMPLE1=


|x2= <code>_unit [[enableGunLights]] "Auto";</code> |EXAMPLE2=
|p1= target: [[Group]] or [[Object]] - The group forced to use gun lights. If unit is supplied as argument, unit's group is used


|x3= <code>_unit [[enableGunLights]] "ForceOff";</code> |EXAMPLE3=
|p2= state: [[Boolean]] - [[true]] to enable, [[false]] to disable
____________________________________________________________________________________________


| [[isFlashlightOn]] |SEEALSO=
|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=
 
{{RV|type=command
 
|game1= arma3
|version1= 0.50
 
|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.}}


</dl>


<h3 style="display:none">Bottom Section</h3>
|s1= target [[enableGunLights]] mode


[[Category:ArmA 2 OA: New Scripting Commands List|{{uc:{{PAGENAME}}}}]]
|p1= target: [[Group]] or [[Object]] - The group forced to use gun lights. If unit is supplied as argument, unit's group is used
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|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]]
}}
 
}}

Revision as of 14:30, 22 May 2022

A2 OA Logo.png Arma 2: Operation Arrowhead to tkoh logo small.png Take On Helicopters
Arma 3 logo black.png Arma 3
A2 OA Logo.png1.50tkoh logo small.png1.00
LALocalGEGlobal
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
Arma 3 logo black.png0.50
LALocalGEGlobal
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
Retrieved from "https://community.bistudio.com/wiki?title=enableGunLights&oldid=321916"