@nativewrappers/redm 0.0.85 → 0.0.86

package/RawControls.d.ts

@@ -1,7 +1,28 @@
 import type { RawKeys } from "./enums/RawKeys";
 export declare class RawControls {
-    static IsKeyDown(rawKey: RawKeys): boolean;
-    static IsKeyPressed(rawKey: RawKeys): boolean;
-    static IsKeyReleased(rawKey: RawKeys): boolean;
-    static IsKeyUp(rawKey: RawKeys): boolean;
+    /**
+     * Disables the raw key this frame, making any calls return false even if they
+     * are currently pressed/released.
+     */
+    static DisableKeyThisFrame(rawKey: RawKeys): void;
+    /**
+     * If the raw key is was just pressed down, will return false if disabled with {@link DisableKeyThisFrame}
+     * and {@link canBeDisabled} is set to true
+     */
+    static WasJustPressed(rawKey: RawKeys, canBeDisabled?: boolean): boolean;
+    /**
+     * If the raw key is currently pressed down, will return false if disabled with {@link DisableKeyThisFrame}
+     * and {@link canBeDisabled} is set to true
+     */
+    static IsKeyPressed(rawKey: RawKeys, canBeDisabled?: boolean): boolean;
+    /**
+     * If the raw key is in its up state, will return false if disabled with {@link DisableKeyThisFrame}
+     * and {@link canBeDisabled} is set to true
+     */
+    static IsKeyReleased(rawKey: RawKeys, canBeDisabled?: boolean): boolean;
+    /**
+     * If the raw key is was just released, will return false if disabled with {@link DisableKeyThisFrame}
+     * and {@link canBeDisabled} is set to true
+     */
+    static WasJustReleased(rawKey: RawKeys, canBeDisabled?: boolean): boolean;
 }

package/RawControls.js

@@ -4,17 +4,40 @@ class RawControls {
   static {
     __name(this, "RawControls");
   }
-  static IsKeyDown(rawKey) {
-    return IsRawKeyDown(rawKey);
+  /**
+   * Disables the raw key this frame, making any calls return false even if they
+   * are currently pressed/released.
+   */
+  static DisableKeyThisFrame(rawKey) {
+    DisableRawKeyThisFrame(rawKey);
   }
-  static IsKeyPressed(rawKey) {
-    return IsRawKeyPressed(rawKey);
+  /**
+   * If the raw key is was just pressed down, will return false if disabled with {@link DisableKeyThisFrame}
+   * and {@link canBeDisabled} is set to true
+   */
+  static WasJustPressed(rawKey, canBeDisabled = true) {
+    return canBeDisabled ? IsRawKeyDown(rawKey) : IsDisabledRawKeyDown(rawKey);
   }
-  static IsKeyReleased(rawKey) {
-    return IsRawKeyReleased(rawKey);
+  /**
+   * If the raw key is currently pressed down, will return false if disabled with {@link DisableKeyThisFrame}
+   * and {@link canBeDisabled} is set to true
+   */
+  static IsKeyPressed(rawKey, canBeDisabled = true) {
+    return canBeDisabled ? IsRawKeyPressed(rawKey) : IsDisabledRawKeyPressed(rawKey);
   }
-  static IsKeyUp(rawKey) {
-    return IsRawKeyUp(rawKey);
+  /**
+   * If the raw key is in its up state, will return false if disabled with {@link DisableKeyThisFrame}
+   * and {@link canBeDisabled} is set to true
+   */
+  static IsKeyReleased(rawKey, canBeDisabled = true) {
+    return canBeDisabled ? IsRawKeyReleased(rawKey) : IsDisabledRawKeyReleased(rawKey);
+  }
+  /**
+   * If the raw key is was just released, will return false if disabled with {@link DisableKeyThisFrame}
+   * and {@link canBeDisabled} is set to true
+   */
+  static WasJustReleased(rawKey, canBeDisabled = true) {
+    return canBeDisabled ? IsRawKeyUp(rawKey) : IsDisabledRawKeyUp(rawKey);
   }
 }
 export {

package/RawKeymaps.d.ts

@@ -0,0 +1,49 @@
+import type { RawKeys } from "./enums/RawKeys";
+export type KeymapFunction = () => void;
+/**
+ * A builder for RawKeymap, you should call {@link finish} to actually register the raw keymap
+ * This should be usable across resource bounds, so you can create the keymap
+ * and pass the object to a manager to handle rebinding the maps with calls.
+ */
+export declare class RawKeymap {
+    #private;
+    /**
+     * @param keymapName the name of the keymap to register to, this should be unique across all resources.
+     * @param rawKey the key to bind to initially, this can be rebound with {@link setRawKey}
+     * @param canBeDisabled if the key can be disabled with {@link RawControls.DisableKeyThisFrame}
+     */
+    constructor(keymapName: string, rawKey: RawKeys, canBeDisabled: boolean);
+    getKeymapName: () => string;
+    /**
+     * Gets the current raw keymap
+     */
+    getRawKeymap: () => RawKeys;
+    /**
+     * Sets the function to be used onKeyUp
+     */
+    setOnKeyUp: (fn: KeymapFunction) => void;
+    /**
+     * Sets the function to be used on onKeyDown
+     */
+    setOnKeyDown: (fn: KeymapFunction) => void;
+    /**
+     * Remaps the current {@link RawKeymap}'s raw key to {@link key}
+     */
+    setRawKey: (key: RawKeys) => void;
+    /**
+     * Sets the function to be used on onKeyUp, if you need to use this across
+     * resource bounds you should use {@link setOnKeyUp}
+     */
+    set OnKeyUp(fn: KeymapFunction);
+    /**
+     * Sets the function to be used on onKeyDown, if you need to use this across
+     * resource bounds you should use {@link setOnKeyDown}
+     */
+    set OnKeyDown(fn: KeymapFunction);
+    /**
+     * Changes the {@link RawKeymap} to use the {@link key} for its keymap
+     */
+    set RawKey(key: RawKeys);
+    get KeymapName(): string;
+    finish(): void;
+}

package/RawKeymaps.js

@@ -0,0 +1,79 @@
+var __defProp = Object.defineProperty;
+var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
+class RawKeymap {
+  static {
+    __name(this, "RawKeymap");
+  }
+  #keymapName;
+  #rawKey;
+  #canBeDisabled;
+  #onKeyUp = null;
+  #onKeyDown = null;
+  /**
+   * @param keymapName the name of the keymap to register to, this should be unique across all resources.
+   * @param rawKey the key to bind to initially, this can be rebound with {@link setRawKey}
+   * @param canBeDisabled if the key can be disabled with {@link RawControls.DisableKeyThisFrame}
+   */
+  constructor(keymapName, rawKey, canBeDisabled) {
+    this.#keymapName = keymapName;
+    this.#rawKey = rawKey;
+    this.#canBeDisabled = canBeDisabled;
+  }
+  getKeymapName = /* @__PURE__ */ __name(() => {
+    return this.#keymapName;
+  }, "getKeymapName");
+  /**
+   * Gets the current raw keymap
+   */
+  getRawKeymap = /* @__PURE__ */ __name(() => {
+    return this.#rawKey;
+  }, "getRawKeymap");
+  /**
+   * Sets the function to be used onKeyUp
+   */
+  setOnKeyUp = /* @__PURE__ */ __name((fn) => {
+    this.#onKeyUp = fn;
+  }, "setOnKeyUp");
+  /**
+   * Sets the function to be used on onKeyDown
+   */
+  setOnKeyDown = /* @__PURE__ */ __name((fn) => {
+    this.#onKeyDown = fn;
+  }, "setOnKeyDown");
+  /**
+   * Remaps the current {@link RawKeymap}'s raw key to {@link key}
+   */
+  setRawKey = /* @__PURE__ */ __name((key) => {
+    this.#rawKey = key;
+    RemapRawKeymap(this.#keymapName, key);
+  }, "setRawKey");
+  /**
+   * Sets the function to be used on onKeyUp, if you need to use this across
+   * resource bounds you should use {@link setOnKeyUp}
+   */
+  set OnKeyUp(fn) {
+    this.#onKeyUp = fn;
+  }
+  /**
+   * Sets the function to be used on onKeyDown, if you need to use this across
+   * resource bounds you should use {@link setOnKeyDown}
+   */
+  set OnKeyDown(fn) {
+    this.#onKeyDown = fn;
+  }
+  /**
+   * Changes the {@link RawKeymap} to use the {@link key} for its keymap
+   */
+  set RawKey(key) {
+    this.setRawKey(key);
+  }
+  get KeymapName() {
+    return this.#keymapName;
+  }
+  finish() {
+    RegisterRawKeymap(this.#keymapName, this.#onKeyUp, this.#onKeyDown, this.#rawKey, this.#canBeDisabled);
+  }
+}
+export {
+  RawKeymap
+};

package/index.d.ts

@@ -4,6 +4,7 @@ export * from "./Game";
 export * from "./GameConstants";
 export * from "./Model";
 export * from "./RawControls";
+export * from "./RawKeymaps";
 export * from "./RelationshipGroup";
 export * from "./Volume";
 export * from "./world/createDraftVehicle";

package/index.js

@@ -4,6 +4,7 @@ export * from "./Game";
 export * from "./GameConstants";
 export * from "./Model";
 export * from "./RawControls";
+export * from "./RawKeymaps";
 export * from "./RelationshipGroup";
 export * from "./Volume";
 export * from "./world/createDraftVehicle";

package/package.json

@@ -8,7 +8,7 @@
   ],
   "license": "MIT",
   "type": "module",
-  "version": "0.0.85",
+  "version": "0.0.86",
   "repository": {
     "type": "git",
     "url": "https://github.com/nativewrappers/nativewrappers.git"
@@ -28,6 +28,7 @@
     "./**/*.js",
     "./**/*.d.ts"
   ],
+  "sideEffects": false,
   "exports": {
     ".": "./index.js",
     "./*": "./*"