Laser - Public getter and setter for laser codes (#9772)

* Getter and setter for laser codes * Documentation * Sanitising input
acemod · Feb 7, 2024 · 28e45c2 · 28e45c2
1 parent ae532c7
commit 28e45c2
Show file tree

Hide file tree

Showing 4 changed files with 81 additions and 0 deletions.
diff --git a/addons/laser/XEH_PREP.hpp b/addons/laser/XEH_PREP.hpp
@@ -3,6 +3,7 @@ PREP(addLaserTarget);
 PREP(addMapHandler);
 PREP(dev_drawVisibleLaserTargets);
 PREP(findLaserSource);
+PREP(getLaserCode);
 PREP(handleLaserTargetCreation);
 PREP(keyLaserCodeChange);
 PREP(laserOff);
@@ -13,6 +14,7 @@ PREP(onLaserDesignatorDraw);
 PREP(rotateVectLine);
 PREP(rotateVectLineGetMap);
 PREP(seekerFindLaserSpot);
+PREP(setLaserCode);
 PREP(shootCone);
 PREP(shootRay);
 PREP(showVehicleHud);

diff --git a/addons/laser/functions/fnc_getLaserCode.sqf b/addons/laser/functions/fnc_getLaserCode.sqf
@@ -0,0 +1,24 @@
+#include "..\script_component.hpp"
+/*
+ * Author: johnb43
+ * Gets the laser code of a laser source.
+ *
+ * Argument:
+ * 0: Laser source <OBJECT>
+ *
+ * Return Value:
+ * Laser code <NUMBER>
+ *
+ * Example:
+ * player call ace_laser_fnc_getLaserCode;
+ *
+ * Public: Yes
+ */
+
+params [["_laserSource", objNull, [objNull]]];
+
+if (isNull _laserSource) exitWith {
+    -1
+};
+
+_laserSource getVariable [QGVAR(code), ACE_DEFAULT_LASER_CODE]
diff --git a/addons/laser/functions/fnc_setLaserCode.sqf b/addons/laser/functions/fnc_setLaserCode.sqf
@@ -0,0 +1,21 @@
+#include "..\script_component.hpp"
+/*
+ * Author: johnb43
+ * Sets the laser code on a laser source.
+ *
+ * Argument:
+ * 0: Laser source <OBJECT>
+ * 1: Laser code <NUMBER>
+ *
+ * Return Value:
+ * None
+ *
+ * Example:
+ * [player, 1111] call ace_laser_fnc_setLaserCode;
+ *
+ * Public: Yes
+ */
+
+params [["_laserSource", objNull, [objNull]], ["_laserCode", ACE_DEFAULT_LASER_CODE, [0]]];
+
+_laserSource setVariable [QGVAR(code), _laserCode, true];
diff --git a/docs/wiki/framework/laser-framework.md b/docs/wiki/framework/laser-framework.md
@@ -0,0 +1,34 @@
+---
+layout: wiki
+title: Laser
+description: Explains the functions available for laser designators.
+group: framework
+order: 5
+parent: wiki
+mod: ace
+version:
+  major: 3
+  minor: 16
+  patch: 4
+---
+
+## 1. Scripting
+
+### 1.1. Get object's laser code
+
+`ace_laser_fnc_getLaserCode`
+
+|   | Arguments | Type | Optional (default value)
+---| --------- | ---- | ------------------------
+0  | Unit/Vehicle | Object | Required
+**R** | Laser code | Number | Return value
+
+### 1.2. Set object's laser code
+
+`ace_laser_fnc_setLaserCode`
+
+|   | Arguments | Type | Optional (default value)
+---| --------- | ---- | ------------------------
+0  | Unit/Vehicle | Object | Required
+1  | Laser code | Number | Required
+**R** | None | None | Return value