@mafiahub/types 0.1.8 → 0.1.10

package/framework/execution_environment.d.ts

@@ -0,0 +1,11 @@
+/** Runtime-side flags. Available on server and client. */
+declare const ExecutionEnvironment: {
+    /** True in the sandboxed client scripting runtime. */
+    readonly isClient: boolean;
+    /** True in the authoritative server scripting runtime. */
+    readonly isServer: boolean;
+    /** Local Framework release version. */
+    readonly frameworkVersion: string;
+    /** Local mod version from InstanceOptions.modVersion; empty when unset. */
+    readonly modVersion: string;
+};

package/framework/key.d.ts

@@ -17,6 +17,9 @@
  * - Numpad `numpad0`–`numpad9` (aliases `num0`–`num9`)
  * - Mouse `mouse1` (left) `mouse2` (right) `mouse3` (middle) `mouse4` `mouse5`
  *
+ * Letters and digits identify physical positions on a US keyboard. Use
+ * `getLabel` to show the corresponding label in the player's current layout.
+ *
  * @example
  * // Toggle a HUD on key-down:
  * Key.bind("f6", "down", () => toggleHud());
@@ -52,4 +55,17 @@ declare const Key: {
      * game window is in the background (same gate as bind dispatch).
      */
     isDown(key: string): boolean;
+
+    /**
+     * Display label for a physical key using the current keyboard layout.
+     * For example, `getLabel("y")` returns `"Z"` on German QWERTZ.
+     * Works while menus/web views own input and without registering a binding.
+     * Query again when refreshing a prompt so layout changes are reflected.
+     * Labels are display text; keep using the original key name for bindings.
+     * @returns Uppercase printable text, or an English name such as `"Enter"`
+     *   or `"Mouse 1"`. Falls back to the uppercase canonical key name if the
+     *   layout cannot translate it. Ignores held modifiers and Caps Lock.
+     * @throws If the key is unknown or the argument is not a string.
+     */
+    getLabel(key: string): string;
 };

package/index.d.ts

@@ -9,3 +9,4 @@
 /// <reference path="framework/exports.d.ts" />
 /// <reference path="framework/key.d.ts" />
 /// <reference path="framework/discord.d.ts" />
+/// <reference path="framework/execution_environment.d.ts" />

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mafiahub/types",
-    "version": "0.1.8",
+    "version": "0.1.10",
     "description": "TypeScript type definitions for the MafiaHub Framework scripting API",
     "types": "index.d.ts",
     "files": [