@types/gimloader 1.8.2 → 1.9.0

gimloader/README.md

@@ -8,7 +8,7 @@ This package contains type definitions for gimloader (https://github.com/Gimload
 Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gimloader.
 
 ### Additional Details
- * Last updated: Tue, 21 Oct 2025 22:34:08 GMT
+ * Last updated: Thu, 06 Nov 2025 23:33:31 GMT
  * Dependencies: [@dimforge/rapier2d-compat](https://npmjs.com/package/@dimforge/rapier2d-compat), [@types/react](https://npmjs.com/package/@types/react), [@types/react-dom](https://npmjs.com/package/@types/react-dom), [eventemitter2](https://npmjs.com/package/eventemitter2), [phaser](https://npmjs.com/package/phaser)
 
 # Credits

gimloader/index.d.ts

@@ -452,6 +452,8 @@ declare global {
                 setCanInteractThroughColliders(canInteract: boolean): void;
                 setForceDisabled(forceDisabled: boolean): void;
                 setInfo(info: any): void;
+                remove(zone: CircleShort | Rect): void;
+                onInteraction?(): void;
             }
 
             interface DeviceInput {
@@ -515,6 +517,11 @@ declare global {
                 update(): void;
             }
 
+            interface SkinSetupOptions extends SkinOptions {
+                x?: number;
+                y?: number;
+            }
+
             interface SkinOptions {
                 id: string;
                 editStyles?: Record<string, string>;
@@ -527,7 +534,7 @@ declare global {
                 scene: Scene;
                 skinId: string;
                 applyEditStyles(options: SkinOptions): void;
-                setupSkin(position: Vector): void;
+                setupSkin(position: SkinSetupOptions): void;
                 updateSkin(options: SkinOptions): void;
             }
 
@@ -1077,6 +1084,8 @@ declare global {
                 device: Device;
                 scene: Scene;
                 angle: number;
+                x: number;
+                y: number;
             } & Partial<RectShort & CircleShort & Ellipse>;
 
             interface ColliderEntry {
@@ -2110,6 +2119,118 @@ declare global {
             }
         }
 
+        type SettingsChangeCallback = (value: any, remote: boolean) => void;
+
+        interface CustomSection {
+            type: "customsection";
+            id: string;
+            default?: any;
+            onChange?: (value: any, remote: boolean) => void;
+            render: (
+                container: HTMLElement,
+                currentValue: any,
+                onChange: (newValue: any) => void,
+                // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+            ) => (() => void) | void;
+        }
+
+        interface CustomSetting extends BaseSetting<any> {
+            type: "custom";
+            // eslint-disable-next-line @typescript-eslint/no-invalid-void-type
+            render: (container: HTMLElement, currentValue: any, update: (newValue: any) => void) => (() => void) | void;
+        }
+
+        interface ColorSetting extends BaseSetting<string> {
+            type: "color";
+            rgba?: boolean;
+        }
+
+        interface RadioSetting extends BaseSetting<string> {
+            type: "radio";
+            options: {
+                label: string;
+                value: string;
+            }[];
+        }
+
+        interface SliderSetting extends BaseSetting<number> {
+            type: "slider";
+            min: number;
+            max: number;
+            step?: number;
+            ticks?: number[];
+            formatter?: (value: number) => string;
+        }
+
+        interface TextSetting extends BaseSetting<string> {
+            type: "text";
+            placeholder?: string;
+            maxLength?: number;
+        }
+
+        interface ToggleSetting extends BaseSetting<boolean> {
+            type: "toggle";
+        }
+
+        interface NumberSetting extends BaseSetting<number> {
+            type: "number";
+            min?: number;
+            max?: number;
+            step?: number;
+        }
+
+        interface MultiselectSetting extends BaseSetting<string[]> {
+            type: "multiselect";
+            options: {
+                label: string;
+                value: string;
+            }[];
+        }
+
+        interface BaseSetting<T> {
+            id: string;
+            default?: T;
+            title: string;
+            description?: string;
+            onChange?: (value: T, remote: boolean) => void;
+        }
+
+        interface DropdownSetting extends BaseSetting<string> {
+            type: "dropdown";
+            options: {
+                label: string;
+                value: string;
+            }[];
+            allowNone?: boolean;
+        }
+
+        type PluginSetting =
+            | DropdownSetting
+            | MultiselectSetting
+            | NumberSetting
+            | ToggleSetting
+            | TextSetting
+            | SliderSetting
+            | RadioSetting
+            | ColorSetting
+            | CustomSetting
+            | CustomSection;
+
+        interface SettingGroup {
+            type: "group";
+            title: string;
+            settings: PluginSetting[];
+        }
+
+        type PluginSettingsDescription = (PluginSetting | SettingGroup)[];
+
+        interface SettingsMethods {
+            create: (description: PluginSettingsDescription) => void;
+            listen: (key: string, callback: SettingsChangeCallback) => () => void;
+        }
+
+        type PluginSettings = SettingsMethods & Record<string, any>;
+
         class PluginsApi {
             /** A list of all the plugins installed */
             get list(): string[];
@@ -2128,6 +2249,7 @@ declare global {
                 needsLib: string[];
                 optionalLib: string[];
                 syncEval: string;
+                deprecated: string | null;
                 gamemode: string[];
                 hasSettings: string;
             };
@@ -2160,6 +2282,7 @@ declare global {
                 needsLib: string[];
                 optionalLib: string[];
                 syncEval: string;
+                deprecated: string | null;
                 gamemode: string[];
                 hasSettings: string;
             };
@@ -2653,6 +2776,8 @@ declare global {
             storage: Readonly<ScopedStorageApi>;
             /** Functions for intercepting the arguments and return values of functions */
             patcher: Readonly<ScopedPatcherApi>;
+            /** A utility for creating persistent settings menus, only available to plugins */
+            settings: PluginSettings;
             /** Methods for getting info on libraries */
             libs: Readonly<LibsApi>;
             /** Gets the exported values of a library */

gimloader/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@types/gimloader",
-    "version": "1.8.2",
+    "version": "1.9.0",
     "description": "TypeScript definitions for gimloader",
     "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/gimloader",
     "license": "MIT",
@@ -32,6 +32,6 @@
         "eventemitter2": "~6.4.9"
     },
     "peerDependencies": {},
-    "typesPublisherContentHash": "00185cb0abd4d14a410df466c7eeef441bb7b6494c9e50ffe82655f048731fc6",
+    "typesPublisherContentHash": "17bb3b6f1003e40d46d5e9d210551fa4ac23d991e3e8f1533f549fe4434d08fe",
     "typeScriptVersion": "5.2"
 }