feat: add ApplyAdvancedGameSettings

Author: Shinigami92

README.md

@@ -73,4 +73,16 @@ client.v1
   .then((response) => {
     console.log("PasswordLogin Response:", response);
   });
+
+client.v1
+  .ApplyAdvancedGameSettings({
+    data: {
+      appliedAdvancedGameSettings: {
+        "FG.GameRules.NoPower": "False",
+      },
+    },
+  })
+  .then((response) => {
+    console.log("ApplyAdvancedGameSettings Response:", typeof response);
+  });
 ```

src/index.ts

@@ -4,6 +4,8 @@ export { PrivilegeLevel } from "./v1/common.js";
 export type {
   ApiRequest,
   ApiSuccessResponse,
+  ApplyAdvancedGameSettingsRequest,
+  ApplyAdvancedGameSettingsResponse,
   BooleanString,
   ErrorResponse,
   GetAdvancedGameSettingsRequest,

src/v1/ApplyAdvancedGameSettings.ts

@@ -0,0 +1,35 @@
+import type { ApiRequest, BooleanString } from "./common.js";
+import { buildApiRequest } from "./common.js";
+
+export type ApplyAdvancedGameSettingsRequest = ApiRequest<
+  "ApplyAdvancedGameSettings",
+  {
+    /**
+     * Key is the name of the Advanced Game Setting, and the Value is the new setting value as string.
+     */
+    appliedAdvancedGameSettings: {
+      "FG.GameRules.NoPower"?: BooleanString;
+      "FG.GameRules.DisableArachnidCreatures"?: BooleanString;
+      "FG.GameRules.NoUnlockCost"?: BooleanString;
+      "FG.GameRules.SetGamePhase"?: string;
+      "FG.GameRules.GiveAllTiers"?: BooleanString;
+      "FG.GameRules.UnlockAllResearchSchematics"?: BooleanString;
+      "FG.GameRules.UnlockInstantAltRecipes"?: BooleanString;
+      "FG.GameRules.UnlockAllResourceSinkSchematics"?: BooleanString;
+      "FG.GameRules.GiveItems"?: string;
+      "FG.PlayerRules.NoBuildCost"?: BooleanString;
+      "FG.PlayerRules.GodMode"?: BooleanString;
+      "FG.PlayerRules.FlightMode"?: BooleanString;
+      [key: string]: string | BooleanString | undefined;
+    };
+  }
+>;
+
+export type ApplyAdvancedGameSettingsResponse = string;
+
+export const buildApplyAdvancedGameSettings = buildApiRequest<
+  ApplyAdvancedGameSettingsRequest,
+  ApplyAdvancedGameSettingsResponse
+>("v1", {
+  function: "ApplyAdvancedGameSettings",
+});

src/v1/index.ts

@@ -1,3 +1,4 @@
+import { buildApplyAdvancedGameSettings } from "./ApplyAdvancedGameSettings.js";
 import type { InternalClientOptions } from "./common.js";
 import { buildGetAdvancedGameSettings } from "./GetAdvancedGameSettings.js";
 import { buildGetServerOptions } from "./GetServerOptions.js";
@@ -47,9 +48,16 @@ export function buildV1(options: InternalClientOptions) {
      * Retrieves currently applied advanced game settings.
      */
     GetAdvancedGameSettings: buildGetAdvancedGameSettings(options),
+    /**
+     * Applies new values to the provided Advanced Game Settings properties.
+     *
+     * Will automatically enable Advanced Game Settings for the currently loaded save if they are not enabled already.
+     */
+    ApplyAdvancedGameSettings: buildApplyAdvancedGameSettings(options),
   };
 }
 
+export type * from "./ApplyAdvancedGameSettings.js";
 export type * from "./common.js";
 export type * from "./error.js";
 export type * from "./GetAdvancedGameSettings.js";

test.js

@@ -54,3 +54,15 @@ client.v1
   .then((response) => {
     console.log("PasswordLogin Response:", response);
   });
+
+client.v1
+  .ApplyAdvancedGameSettings({
+    data: {
+      appliedAdvancedGameSettings: {
+        "FG.GameRules.NoPower": "False",
+      },
+    },
+  })
+  .then((response) => {
+    console.log("ApplyAdvancedGameSettings Response:", typeof response);
+  });