add example for shooting auto turrets

Author: liamcottle

camera.js

@@ -363,6 +363,41 @@ class Camera extends EventEmitter {
 
     }
 
+    /**
+     * Shoots a PTZ controllable Auto Turret.
+     */
+    async shoot() {
+
+        // press left mouse button to shoot
+        await this.move(Camera.Buttons.FIRE_PRIMARY, 0, 0);
+
+        // release all mouse buttons
+        await this.move(Camera.Buttons.NONE, 0, 0);
+
+    }
+
+    /**
+     * Reloads a PTZ controllable Auto Turret
+     */
+    async reload() {
+
+        // press reload button to reload turret
+        await this.move(Camera.Buttons.RELOAD, 0, 0);
+
+        // release all mouse buttons
+        await this.move(Camera.Buttons.NONE, 0, 0);
+
+    }
+
+    /**
+     * Check if camera is an auto turret
+     * @returns {boolean}
+     */
+    isAutoTurret() {
+        const crosshairControlFlag = Camera.ControlFlags.CROSSHAIR;
+        return (this.cameraSubscribeInfo?.controlFlags & crosshairControlFlag) === crosshairControlFlag;
+    }
+
 }
 
 class IndexGenerator {

examples/10_shoot_autoturret.js

@@ -0,0 +1,100 @@
+const RustPlus = require('../rustplus');
+const Camera = require("../camera");
+var rustplus = new RustPlus('ip', 'port', 'playerId', 'playerToken');
+
+function delay(time) {
+    return new Promise(resolve => setTimeout(resolve, time));
+}
+
+rustplus.on('connected', async () => {
+
+    console.log("connected");
+
+    // get a camera (should be an autoturret for this example)
+    const turret = rustplus.getCamera("TURRET1");
+
+    // wait until subscribed to autoturret camera
+    turret.on('subscribed', async () => {
+
+        // check if camera is an auto turret
+        if(!turret.isAutoTurret()){
+            console.log("Camera is not an auto turret!");
+            await rustplus.disconnect();
+            return;
+        }
+
+        console.log("subscribed to autoturret camera");
+        await delay(500);
+
+        const shootCount = 3;
+        const shootDelay = 250;
+        const moveDelay = 500;
+        const moveAmount = 5;
+
+        // shoot autoturret
+        console.log("shooting");
+        for(let i = 0; i < shootCount; i++){
+            await delay(shootDelay);
+            await turret.shoot();
+        }
+
+        // move autoturret left
+        console.log("moving left");
+        await delay(moveDelay);
+        await turret.move(Camera.Buttons.NONE, -moveAmount, 0);
+
+        // shoot autoturret
+        console.log("shooting");
+        for(let i = 0; i < shootCount; i++){
+            await delay(shootDelay);
+            await turret.shoot();
+        }
+
+        // move autoturret up
+        console.log("moving up");
+        await delay(moveDelay);
+        await turret.move(Camera.Buttons.NONE, 0, moveAmount);
+
+        // shoot autoturret
+        console.log("shooting");
+        for(let i = 0; i < shootCount; i++){
+            await delay(shootDelay);
+            await turret.shoot();
+        }
+
+        // move autoturret right
+        console.log("moving right");
+        await delay(moveDelay);
+        await turret.move(Camera.Buttons.NONE, moveAmount, 0);
+
+        // shoot autoturret
+        console.log("shooting");
+        for(let i = 0; i < shootCount; i++){
+            await delay(shootDelay);
+            await turret.shoot();
+        }
+
+        // move autoturret down
+        console.log("moving down");
+        await delay(moveDelay);
+        await turret.move(Camera.Buttons.NONE, 0, -moveAmount);
+
+        // shoot autoturret
+        console.log("shooting");
+        for(let i = 0; i < shootCount; i++){
+            await delay(shootDelay);
+            await turret.shoot();
+        }
+
+        console.log("disconnecting");
+        await rustplus.disconnect();
+
+    });
+
+    // subscribe to autoturret camera
+    await turret.subscribe();
+
+});
+
+// connect to rust server
+rustplus.connect();