@falloutmp/types 0.2.4 → 0.2.5

package/generated/client-api.d.ts

@@ -286,6 +286,16 @@ declare global {
      */
     isMenuOpen(name: string): boolean;
 
+    /**
+     * Holds the game's loading screen up until hideLoadingScreen. Called as this resource starts it takes over the join's loading screen, which otherwise goes once the server's world is in, so the player goes from it straight to whatever the resource shows first; in a session it shows the loading screen. The hold ends when this resource stops, and after a minute regardless.
+     */
+    showLoadingScreen(): void;
+
+    /**
+     * Ends this resource's hold on the loading screen; it goes as soon as the join no longer needs it, which in a session is at once.
+     */
+    hideLoadingScreen(): void;
+
     /**
      * Queues one of the game's message boxes; they show one at a time. False when the game refused it: too many queued, or a duplicate under `unique`.
      * @param options The text, an optional title, one to ten button labels (default ["$OK"]; localisation keys are resolved; a blank label is left out but keeps its index), and whether to skip it while a box with the same body is queued.
@@ -2201,7 +2211,7 @@ declare global {
     getLabel(key: string): string;
 
     /**
-     * Binds a resource-owned handler that fires while the game has foreground input and no UI is capturing it.
+     * Binds a resource-owned handler that fires while the game has foreground input and no UI is capturing it. Each wheelup/wheeldown notch fires down, then up.
      * @param key Case-insensitive supported keyboard or mouse key name.
      * @param stateOrHandler Trigger state, or the handler itself to use the default down state.
      * @param handler Handler required when an explicit trigger state is provided.
@@ -2221,7 +2231,7 @@ declare global {
     /**
      * Queries live physical key state using the same foreground and UI-input gate as binding dispatch.
      * @param key Case-insensitive supported key name.
-     * @returns False when the key is up, the game is backgrounded, UI owns input, or the key name is invalid.
+     * @returns False when the key is up, the game is backgrounded, UI owns input, or the key name is invalid. Always false for the wheel, which is never held.
      */
     isDown(key: string): boolean;
   };
@@ -2492,7 +2502,7 @@ declare global {
     getTier(): number;
 
     /**
-     * Rebinds push-to-talk. Unknown key names throw.
+     * Rebinds push-to-talk. Unknown key names and the wheel, which is never held, throw.
      * @param key Case-insensitive key name, using the same names as Key.bind.
      */
     setPushToTalkKey(key: string): void;

package/generated/server-api.d.ts

@@ -500,9 +500,10 @@ declare global {
      * @param position Where to, in the space the player goes to.
      * @param heading Facing in radians; the current one when left out.
      * @param space Another worldspace or an interior cell, exactly one of the two; the one the player is in when left out.
+     * @param options loadScreen: whether the player's game may show its loading screen when the destination is not loaded (default true). With false the destination streams in with no loading screen, as the game's own "No Load Screen" doors do: their game stalls for the load instead, so fade the screen first (`Hud.fade`).
      * @returns True when sent; false when the player is gone, or the interior has no reference to land at. Throws for a position that is not a finite Vector3.
      */
-    teleport(position: Vector3, heading?: number, space?: { worldSpace?: number | string; interiorCell?: number | string }): boolean;
+    teleport(position: Vector3, heading?: number, space?: { worldSpace?: number | string; interiorCell?: number | string }, options?: { loadScreen?: boolean }): boolean;
 
     /**
      * Brings a dead player back at full health. Nothing respawns a player on its own: call this from `playerDeath`, at once or later.

package/package.json

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