add IsRunningOnSteamDeck

Author: Armaldio

.gitattributes

@@ -0,0 +1 @@
+* text=auto

README.md

@@ -5,7 +5,7 @@ A plugin that integrate with Pipelab <br>
 Author: Armaldio <br>
 Website: https://github.com/CynToolkit/construct-plugin <br>
 Addon Url: https://github.com/CynToolkit/construct-plugin <br>
-Download Latest Version : [Version: 2.1.0](https://github.com/CynToolkit/construct-plugin/releases/latest) <br>
+Download Latest Version : [Version: 2.1.1](https://github.com/CynToolkit/construct-plugin/releases/latest) <br>
 <sub>Made using [c3ide2-framework](https://github.com/ConstructFund/c3ide2-framework) </sub><br>
 
 ## Table of Contents
@@ -451,6 +451,7 @@ The main files you may want to look at would be instance.js
 | SteamUsername | Get the Steam username. | string |  | 
 | SteamLevel | Get the Steam level. | number |  | 
 | SteamIpCountry | Get the Steam IP country. | string |  | 
+| SteamIsRunningOnSteamDeck | Return true if the app is running on a Steam Deck. | number |  | 
 
 ## Paths
 **ProjectFilesFolder**: Direct path to your games's content

examples/example.c3p

@@ -209,7 +209,7 @@ export const fullscreenPipelabStateToC3State = (/** @type {import('@pipelab/core
 const defaultSteamId = {
   accountId: -1,
   steamId32: '',
-  steamId64: BigInt(-1),
+  steamId64: '',
 }
 
 /**
@@ -319,14 +319,16 @@ export function getInstanceJs(parentClass, addonTriggers, C3) {
     /** @type {import("./sdk.js").IsFullScreenState} */
     _fullscreenState = 0;
 
-    /** @type {import('@pipelab/core').NamespacedFunctionReturnType<'localplayer', 'getSteamId'>} */
+    /** @type {{accountId: number, steamId32: string, steamId64: string}} */
     _steam_SteamId = defaultSteamId
     /** @type {import('@pipelab/core').NamespacedFunctionReturnType<'localplayer', 'getName'>} */
     _steam_Name = ""
     /** @type {import('@pipelab/core').NamespacedFunctionReturnType<'localplayer', 'getLevel'>} */
     _steam_Level = -1
     /** @type {import('@pipelab/core').NamespacedFunctionReturnType<'localplayer', 'getIpCountry'>} */
     _steam_IpCountry = ''
+    /** @type {import('@pipelab/core').NamespacedFunctionReturnType<'utils', 'isSteamRunningOnSteamDeck'>} */
+    _steam_IsRunningOnSteamDeck = false
 
     /** @type {string} */
     _platform = ''
@@ -522,19 +524,19 @@ export function getInstanceJs(parentClass, addonTriggers, C3) {
         }
 
         // TODO: BigInt support
-        // promises.push(async () => {
-        //   /** @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').SteamRaw<'localplayer', 'getSteamId'>, 'input'>} */
-        //   const order = {
-        //     url: '/steam/raw',
-        //     body: {
-        //       namespace: 'localplayer',
-        //       method: 'getSteamId',
-        //       args: [],
-        //     },
-        //   };
-        //   const response = await this.ws?.sendAndWaitForResponse(order);
-        //   this._steam_SteamId = response?.body.data ?? defaultSteamId
-        // })
+        promises.push(async () => {
+          /** @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').SteamRaw<'localplayer', 'getSteamId'>, 'input'>} */
+          const order = {
+            url: '/steam/raw',
+            body: {
+              namespace: 'localplayer',
+              method: 'getSteamId',
+              args: [],
+            },
+          };
+          const response = await this.ws?.sendAndWaitForResponse(order);
+          this._steam_SteamId = response?.body.data ?? defaultSteamId
+        })
 
         promises.push(async () => {
           /** @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').SteamRaw<'localplayer', 'getName'>, 'input'>} */
@@ -580,6 +582,20 @@ export function getInstanceJs(parentClass, addonTriggers, C3) {
           this._steam_IpCountry = response?.body.data ?? '';
         })
 
+        promises.push(async () => {
+          /** @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').SteamRaw<'utils', 'isSteamRunningOnSteamDeck'>, 'input'>} */
+          const order = {
+            url: '/steam/raw',
+            body: {
+              namespace: 'utils',
+              method: 'isSteamRunningOnSteamDeck',
+              args: [],
+            },
+          };
+          const response = await this.ws?.sendAndWaitForResponse(order);
+          this._steam_IsRunningOnSteamDeck = response?.body.data ?? false;
+        })
+
         promises.push(async () => {
           /** @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').MessageInfos, 'input'>} */
           const order = {
@@ -2417,6 +2433,9 @@ export function getInstanceJs(parentClass, addonTriggers, C3) {
     _SteamIpCountry = this.exprs(super._SteamIpCountry, () => {
       return this._steam_IpCountry
     })
+    _SteamIsRunningOnSteamDeck = this.exprs(super._SteamIsRunningOnSteamDeck, () => {
+      return this._steam_IsRunningOnSteamDeck ? 1 : 0
+    })
 
     _InitializeError = this.exprs(super._InitializeError, () => {
       return this._InitializeErrorValue

src/instance.js

@@ -1666,7 +1666,6 @@ const Config = /** @type {const} */({
       description: "Return the fullscreen state of the window.",
     },
 
-    // Steam
     CurrentPlatform: {
       category: "general",
       forward: "_CurrentPlatform",
@@ -1683,6 +1682,7 @@ const Config = /** @type {const} */({
       returnType: 'string',
       description: "Get the current architecture (e.g., 'x64', 'arm64').",
     },
+    // Steam
     SteamAccountId: {
       category: "steam",
       forward: "_SteamAccountId",
@@ -1731,6 +1731,14 @@ const Config = /** @type {const} */({
       returnType: 'string',
       description: "Get the Steam IP country.",
     },
+    SteamIsRunningOnSteamDeck: {
+      category: "steam",
+      forward: "_SteamIsRunningOnSteamDeck",
+      highlight: false,
+      deprecated: false,
+      returnType: 'number',
+      description: "Return true if the app is running on a Steam Deck.",
+    },
   },
 });