@falloutmp/types 0.2.0 → 0.2.1

package/generated/server-api.d.ts

@@ -254,6 +254,27 @@ declare global {
   /** Names of native events available in this scripting environment. */
   type EventName = keyof EventMap;
 
+  /**
+   * The game this server runs, and the systems only some games have.
+   */
+  const Game: {
+    /**
+     * The game, as server.json's `mod.game` names it.
+     */
+    readonly id: "fo4" | "fo76";
+
+    /**
+     * The game's display name: "Fallout 4" or "Fallout 76".
+     */
+    readonly name: string;
+
+    /**
+     * Whether this game has the system. Settlements, companions, the perk chart and the SPECIAL creation menu are Fallout 4's; C.A.M.P., perk cards, teams and mutations are Fallout 76's. Every other binding exists on both.
+     * @param feature A system only some games have.
+     */
+    has(feature: "settlements" | "companions" | "perkChart" | "specialMenu" | "camp" | "perkCards" | "teams" | "mutations"): boolean;
+  };
+
   /**
    * Where a player is: the worldspace it stands in, or the interior cell, which has none.
    */
@@ -804,6 +825,40 @@ declare global {
      */
     static xpForLevel(level: number): number;
 
+    /**
+     * The factions the server put the player in, each with its rank. The factions their character holds from the game's own data, such as PlayerFaction, are not listed.
+     * @returns One entry per faction, in the order they were joined; empty when the player is gone.
+     */
+    getFactions(): { faction: number; rank: number }[];
+
+    /**
+     * The player's rank in a faction the server put them in.
+     * @param faction A TESFaction form ID, as a number or hex string.
+     * @returns The rank; null when the server did not put them in it.
+     */
+    getFactionRank(faction: number | string): number | null;
+
+    /**
+     * Puts the player in a faction at a rank, or re-ranks them, as `Actor.SetFactionRank` does: their own game and every other player's give their character the membership, so the game's hostility follows it. NPCs of the faction and its allies treat them as one of their own; its enemies attack them. Up to 16 factions per player; whether a player's hits on another land stays `playerHit`'s say.
+     * @param faction A TESFaction form ID, as a number or hex string.
+     * @param rank 0 to 127; 0 when left out.
+     * @returns True when set; false when the player is gone or already in 16 factions.
+     */
+    setFactionRank(faction: number | string, rank?: number): boolean;
+
+    /**
+     * Takes the player out of a faction the server put them in, as `Actor.RemoveFromFaction` does.
+     * @param faction A TESFaction form ID, as a number or hex string.
+     * @returns True when they were in it; false otherwise or when the player is gone.
+     */
+    removeFromFaction(faction: number | string): boolean;
+
+    /**
+     * Takes the player out of every faction the server put them in. The factions their character holds from the game's own data stay.
+     * @returns True when sent; false when the player is gone.
+     */
+    removeFromAllFactions(): boolean;
+
     /**
      * Every connected player.
      * @returns One handle per player, in no particular order.
@@ -1052,6 +1107,38 @@ declare global {
     inventory: { form: string; count: number }[];
   }
 
+  /**
+   * How the game's factions react to each other, on every client. Combined with `Player.setFactionRank` it decides who the game treats as friend or foe: NPCs, turrets and companions alike.
+   */
+  const Faction: {
+    /**
+     * How one faction reacts to another, where the server overrides it.
+     * @param faction A TESFaction form ID, as a number or hex string.
+     * @param other The faction it reacts to, as a number or hex string.
+     * @returns The reaction; null when the game's data files decide.
+     */
+    getReaction(faction: number | string, other: number | string): "neutral" | "enemy" | "ally" | "friend" | null;
+
+    /**
+     * Overrides how one faction reacts to another on every client, as `Faction.SetAlly` and `Faction.SetEnemy` do, until it is cleared or the server stops. A faction can be its own enemy. Up to 64 directions are overridden at once.
+     * @param faction A TESFaction form ID, as a number or hex string.
+     * @param other The faction it reacts to, as a number or hex string.
+     * @param reaction Enemies fight on sight; allies and friends help each other, friends also in combat.
+     * @param mutual Both directions, as `Faction.SetAlly` and `Faction.SetEnemy` do; true when left out.
+     * @returns True when set; false when the table is full.
+     */
+    setReaction(faction: number | string, other: number | string, reaction: "neutral" | "enemy" | "ally" | "friend", mutual?: boolean): boolean;
+
+    /**
+     * Gives a reaction back to the game's data files on every client.
+     * @param faction A TESFaction form ID, as a number or hex string.
+     * @param other The faction it reacts to, as a number or hex string.
+     * @param mutual Both directions, as `Faction.SetAlly` and `Faction.SetEnemy` do; true when left out.
+     * @returns True when one was overridden.
+     */
+    clearReaction(faction: number | string, other: number | string, mutual?: boolean): boolean;
+  };
+
   /**
    * An armed mine a player laid. Its owner's game holds the mine and sets it off; the server decides when. Once it goes off or is removed the handle reads nothing. Mines go with their owner when they leave.
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@falloutmp/types",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "TypeScript declarations for the Fallout Multiplayer scripting API: @falloutmp/types/server and @falloutmp/types/client",
   "license": "UNLICENSED",
   "exports": {