enableGunLights: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Made A2OA/A3 difference clearer, add examples, comment cleanup)
m (Text replacement - "{{Feature|Important|" to "{{Feature|important|")
 
(53 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{TabView
____________________________________________________________________________________________


| arma2oa |= Game name
|selected= 2


|1.51|= 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


| Force the AI to use gun lights |= Description
|game2= tkoh
____________________________________________________________________________________________
|version2= 1.00


| thing '''enableGunLights''' value |= Syntax
|gr1= Lights
|gr2= Weapons


|p1= thing: [[Object]] or [[Group]] - the unit or the group forced to use gun lights |= Parameter 1
|arg= local
|p2= value:<br />
|eff= global
{{GVI|arma2oa|1.51}} [[Boolean]] - true/false<br />
{{GVI|arma3|1.00}} [[String]] - "AUTO", "forceOn", "forceOff" |= Parameter 2


| [[Nothing]] |= Return value
|descr= Toggles the target group's gun light(s).
____________________________________________________________________________________________
 
|x1= <code>_group [[enableGunLights]] [[true]]; {{codecomment|// Arma 2 OA}}
_group [[enableGunLights]] "forceOn"; {{codecomment|// Arma 3}}</code> |= Example 1


|x2= <code>_unit [[enableGunLights]] [[false]]; {{codecomment|// Arma 2 OA}}
|s1= target [[enableGunLights]] state
_unit [[enableGunLights]] "AUTO"; {{codecomment|// Arma 3}}</code> |= Example 2


|x3= <code>_unit [[enableGunLights]] "forceOff"; {{codecomment|// Arma 3 only}}</code> |= Example 3
|p1= target: [[Group]] or [[Object]] - the group forced to use gun lights. If unit is supplied as argument, unit's group is used
____________________________________________________________________________________________


| [[isFlashlightOn]] |= See also
|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 -->
 
{{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.


<dd class="notedate">Posted on 27 July, 2011
{{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.}}
<dt class="note">[[User:kju|kju]]
<dd class="note">This command can be used to force lights on, but not to force lights off.


<!-- Note Section END -->
</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 ArmA2|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
|p2= mode: [[String]] - can be:
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
* {{hl|"Auto"}} - Depends on combat mode
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
* {{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 00: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
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=351992"