drawLaser: Difference between revisions

Revision as of 19:45, 2 October 2021

Hover & click on the images for description

⚠

Only available in Development branch(es) until its release with Arma 3 patch v2.08.

Description:: Draws a laserbeam and a lightpoint at the impact location of the laser.
This command has to be executed every frame - see Arma 3: Mission Event Handlers - Draw3D.
Lasers drawn with this command are subject to the same limitations as weapon attachment lasers. These limitations are defined in the CfgIRLaserSettings config class.
Groups:: Interaction Lights

Syntax:: drawLaser [position, direction, beamColor, dotColor, dotSize, beamThickness, beamMaxLength, isIR]
Parameters:: position: PositionASL - the laser's origin position
: direction: Array format Vector3D - the laser's direction vector
: beamColor: Array format Color (RGB) - laser beam color. The values can go way above the usual 0..1 range as they also act as emissivity brightness
: dotColor: Array format Color (RGB) - impact dot color. Set to [] to use the same value as beamColor.
: dotSize: Number - impact dot size; if set to 0 the impact dot will not render
: beamThickness: Number - laser beam's thickness scale; if set to 0, the beam will not render
: beamMaxLength: Number - (Optional, default: -1) laser beam's maximum length. -1 means maximum length (defined in CfgIRLaserSettings), 0 means no length at all and the command is ignored
: isIR: Boolean - (Optional, default: true) whether the laser and impact dot are only visible with Night Vision / Thermal Imaging
Return Value:: Nothing

Example 1:: Give the player a laser eye: addMissionEventHandler ["Draw3D", { drawLaser [ eyePos player vectorAdd [0, 0, 0.1], getCameraViewDirection player, [1000, 0, 0], // Bright red [], 5, 20, -1, false ]; }];

: 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

@@ Line 29: / Line 29: @@
 |p5= dotSize: [[Number]] - impact dot size; if set to 0 the impact dot will not render
-|p6= beamThickness: [[Number]] - laser beam thickness scale; if set to 0, the beam will not render
+|p6= beamThickness: [[Number]] - laser beam's thickness scale; if set to 0, the beam will not render
-|p7= beamMaxLength (Optional, default: -1): [[Number]] - the maximum length of the laser beam. Special values:
+|p7= beamMaxLength: [[Number]] - (Optional, default: -1) laser beam's maximum length. <tt>-1</tt> means maximum length (defined in <tt>CfgIRLaserSettings</tt>), <tt>0</tt> means no length at all and the command is ignored
-* '''-1:''' No limit other than that defined in <tt>CfgIRLaserSettings</tt>
-* '''0:''' The [[drawLaser]] command is ignored
-The maximum length of laser beams defined in <tt>CfgIRLaserSettings</tt> can not be exceeded, not even by setting this parameter to -1.
-|p8= isIR (Optional, default: [[true]]): [[Boolean]] - whether the laser and impact dot are only visible with Night Vision / Thermal Imaging
+|p8= isIR: [[Boolean]] - (Optional, default: [[true]]) whether the laser and impact dot are only visible with Night Vision / Thermal Imaging
 |r1= [[Nothing]]