isLaserOn: Difference between revisions

Latest revision as of 20:58, 4 July 2024

1.78

LALocal GEGlobal

Hover & click on the images for description

Description

Description:: Returns true if the vehicle has its laser turned on. Not to be confused with isIRLaserOn which is for units. Main syntax is for primary gunner turret.
Groups:: Weapons

Syntax

Syntax:: isLaserOn entity
Parameters:: entity: Object - unit or vehicle
Return Value:: Boolean - true when laser is on, false otherwise

2.12

Alternative Syntax

Syntax:: vehicle isLaserOn turret
Parameters:: vehicle: Object - transport
: turret: Array format Turret Path - [-1] for driver turret
Return Value:: Boolean - true when laser is on, false otherwise

Examples

Example 1:: if (isLaserOn _vehicle) then { hint "target ready" };

Additional Information

See also:: laserTarget enableIRLasers isIRLaserOn

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

Sa-Matra - c: Posted on Dec 27, 2022 - 08:27 (UTC)
: Does not mean there is actual laser object present. Returns laser designator weapon's toggle state. In other words isLaserOn can return true while laserTarget returns <NULL-object>, for example in case laser was turned on and unit left the vehicle, there would be no laser target entity anymore, while designator is still turned on.

@@ Line 1: / Line 1: @@
-{{Command
+{{RV|type=command
-| arma3
+|game1= arma3
+|version1= 1.78
-|1.78
+|arg= local
-|arg=local |Multiplayer Arguments("local" or "global")=
+|eff= global
-|eff=global
-|serverExec=
 |gr1= Weapons
-| Returns true if the vehicle has its laser turned on. Not to be confused with [[isIRLaserOn]] which is for units
+|descr= Returns true if the vehicle has its laser turned on. Not to be confused with [[isIRLaserOn]] which is for units. Main syntax is for primary gunner turret.
-| '''isLaserOn''' vehicle
+|s1= [[isLaserOn]] entity
-|p1=vehicle: [[Object]]
+|p1= entity: [[Object]] - unit or vehicle
-|x1= <code>_on = [[isLaserOn]] _vehicle;</code>
+|r1= [[Boolean]] - [[true]] when laser is on, [[false]] otherwise
-| [[Boolean]]: True when laser is on, otherwise false
+|s2= vehicle [[isLaserOn]] turret
+|s2since=Arma3 2.12
-| [[enableIRLasers]] [[isIRLaserOn]]
+|p21= vehicle: [[Object]] - transport
-}}
+|p22= turret: [[Array]] format [[Turret Path]] - [-1] for driver turret
-<dl class="command_description">
+|r2= [[Boolean]] - [[true]] when laser is on, [[false]] otherwise
-<!-- BEGIN Note Section -->
-<!-- For example:
-<dd class="notedate">Posted on Month Day, Year - Time (UTC)</dd>
-<dt class="note">[[User:User Name|User Name]]</dt>
-<dd class="note">This is an example note. It is true and verifiable, and contains a little code snippet.
-<code>[[if]] ([[_this]] == anExample) [[then]] { [[hint]] "Leave it here for others to read"; };</code></dd>
--->
-<!-- END Note Section -->
-</dl>
+|x1= <sqf>if (isLaserOn _vehicle) then { hint "target ready" };</sqf>
+|seealso= [[laserTarget]] [[enableIRLasers]] [[isIRLaserOn]]
+}}
-{{GameCategory|arma3|Scripting Commands}}
+{{Note
-[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
+|user= Sa-Matra
+|timestamp= 20221227082727
+|text= Does not mean there is actual laser object present. Returns laser designator weapon's toggle state. In other words [[isLaserOn]] can return <sqf inline>true</sqf> while [[laserTarget]] returns {{hl|<NULL-object>}}, for example in case laser was turned on and unit left the vehicle, there would be no laser target entity anymore, while designator is still turned on.
+}}