isLaserOn: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
m (Text replacement - "Samatra" to "Sa-Matra")
 
(4 intermediate revisions by 4 users not shown)
Line 10: Line 10:
|gr1= Weapons
|gr1= Weapons


|descr= 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.


|s1= [[isLaserOn]] vehicle
|s1= [[isLaserOn]] entity


|p1= vehicle: [[Object]]
|p1= entity: [[Object]] - unit or vehicle
 
|r1= [[Boolean]] - [[true]] when laser is on, [[false]] otherwise
 
|s2= vehicle [[isLaserOn]] turret
|s2since=Arma3 2.12
 
|p21= vehicle: [[Object]] - transport
 
|p22= turret: [[Array]] format [[Turret Path]] - [-1] for driver turret
 
|r2= [[Boolean]] - [[true]] when laser is on, [[false]] otherwise


|x1= <sqf>if (isLaserOn _vehicle) then { hint "target ready" };</sqf>
|x1= <sqf>if (isLaserOn _vehicle) then { hint "target ready" };</sqf>


|r1= [[Boolean]] - [[true]] when laser is on, [[false]] otherwise
|seealso= [[laserTarget]] [[enableIRLasers]] [[isIRLaserOn]]
}}


|seealso= [[enableIRLasers]] [[isIRLaserOn]]
{{Note
|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.
}}
}}

Latest revision as of 20:58, 4 July 2024

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

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.