@wayward/types 2.13.3-beta.dev.20230627.1 → 2.13.3-beta.dev.20230627.2

package/definitions/game/game/meta/prompt/PromptDescriptionFactory.d.ts

@@ -14,15 +14,19 @@ import type InterruptChoice from "language/dictionary/InterruptChoice";
 import type { TranslationGenerator } from "ui/component/IComponent";
 import type { MenuId } from "ui/screen/screens/menu/component/IMenu";
 export declare const promptDescriptions: Descriptions<PromptType, IPromptDescriptionBase<any>>;
-declare class PromptDescriptionFactory {
+export default class PromptDescriptionFactory {
     private readonly _priority?;
     constructor(_priority?: PromptPriority | undefined);
+    static priority(priority: PromptPriority): PromptDescriptionFactory;
+    /**
+     * @deprecated Use {@link PromptDescriptionFactory.priority}
+     */
     priority(priority: PromptPriority): PromptDescriptionFactory;
-    info<A extends any[] = []>(type: Prompt): IPromptInfoDescription<A>;
-    confirm<A extends any[] = []>(type: Prompt, yesTranslation?: TranslationGenerator<InterruptChoice>, noTranslation?: TranslationGenerator<InterruptChoice>): IPromptConfirmDescription<A>;
-    choice<A extends any[], CHOICES extends PromptChoices<A>>(type: Prompt, choices: CHOICES): IPromptChoiceDescription<A, CHOICES>;
+    info<A extends any[] = []>(type: SupplierOr<Prompt>): IPromptInfoDescription<A>;
+    confirm<A extends any[] = []>(type: SupplierOr<Prompt>, yesTranslation?: TranslationGenerator<InterruptChoice>, noTranslation?: TranslationGenerator<InterruptChoice>): IPromptConfirmDescription<A>;
+    choice<A extends any[], CHOICES extends PromptChoices<A>>(type: SupplierOr<Prompt>, choices: CHOICES): IPromptChoiceDescription<A, CHOICES>;
     input<A extends any[] = []>(type: Prompt, configure?: IPromptInputDescription<A>["configure"], canCancel?: true): IPromptInputDescription<A>;
     menu<MENU extends MenuId, A extends any[] = []>(type: Prompt, menu: MENU, configure?: IPromptMenuDescription<MENU, A>["configure"]): IPromptMenuDescription<MENU, A>;
+    private create;
 }
 export declare const promptDescriptionFactory: PromptDescriptionFactory;
-export {};

package/definitions/game/mod/BaseMod.d.ts

@@ -172,7 +172,7 @@ export declare abstract class BaseMod extends EventEmitter.Host<IModEvents> {
      * Allocates an enum for this mod.
      * @param id The enum type.
      * @param name The name of the enumeration value.
-     * @param objectValue An object to register with the enum. For example, all values in the creature enumeration have a corresponding
+     * @param description An object to register with the enum. For example, all values in the creature enumeration have a corresponding
      * `description` object.
      * @param onAllocate A callback for when the enum has been allocated.
      * @param onUnallocate A callback for when the enum has been unallocated.

package/definitions/game/mod/ModRegistry.d.ts

@@ -38,7 +38,8 @@ import type { InspectionClass } from "game/inspection/InspectionTypeMap";
 import type { IItemDescription, IItemGroupDescription, ItemTag, ItemType, ItemTypeGroup } from "game/item/IItem";
 import type { IMagicalPropertyDescription, MagicalPropertyType } from "game/magic/MagicalPropertyType";
 import type { ILoadingDescription } from "game/meta/Loading";
-import type { Prompt } from "game/meta/prompt/IPrompt";
+import type { IPromptDescriptionBase, Prompt } from "game/meta/prompt/IPrompt";
+import type PromptDescriptionFactory from "game/meta/prompt/PromptDescriptionFactory";
 import type { TempType } from "game/temperature/ITemperature";
 import type { ITerrainDescription, OverlayType, TerrainType } from "game/tile/ITerrain";
 import type { ITileEventDescription, TileEventType } from "game/tile/ITileEvent";
@@ -329,9 +330,11 @@ export interface IQuestRequirementRegistration extends IBaseModRegistration {
     name: string;
     description: QuestRequirement;
 }
+export type PromptConstructorFunction<DESCRIPTION extends IPromptDescriptionBase<any[]>> = (type: Prompt, factory: PromptDescriptionFactory) => DESCRIPTION;
 export interface IPromptRegistration extends IBaseModRegistration {
     type: ModRegistrationType.Prompt;
     name: string;
+    construct: PromptConstructorFunction<IPromptDescriptionBase<any[]>>;
 }
 export interface ILoadRegistration extends IBaseModRegistration {
     type: ModRegistrationType.Load;
@@ -620,7 +623,7 @@ declare module Register {
      *
      * The decorated property will be injected with the id of the registered prompt.
      */
-    export function prompt(name: string): <K extends string | number | symbol, T extends Record<K, Prompt>>(target: T, key: K) => void;
+    export function prompt<DESCRIPTION extends IPromptDescriptionBase<any[]>>(name: string, construct: PromptConstructorFunction<DESCRIPTION>): <K extends string | number | symbol, T extends Record<K, DESCRIPTION>>(target: T, key: K) => void;
     /**
      * Registers an interrupt choice.
      * @param name The name of the interrupt choice.

package/definitions/game/utilities/enum/EnumManager.d.ts

@@ -19,7 +19,8 @@ declare module EnumManager {
      */
     function clearCacheForMod(modIndex: number): void;
     function reset(): void;
-    function allocate(modIndex: number, id: EnumId, name: string, objectValue?: ((enumNumber: number) => any) | any, onAllocate?: ((enumNumber: number) => void), onUnallocate?: ((enumNumber: number) => void)): EnumInfo | undefined;
+    function allocate<DESCRIPTION extends object | undefined>(modIndex: number, id: EnumId, name: string, description: DESCRIPTION, onAllocate?: ((enumNumber: number, description: DESCRIPTION) => void), onUnallocate?: ((enumNumber: number) => void)): EnumInfo | undefined;
+    function allocate<DESCRIPTION extends object | undefined>(modIndex: number, id: EnumId, name: string, description?: DESCRIPTION, onAllocate?: ((enumNumber: number, description?: DESCRIPTION) => void), onUnallocate?: ((enumNumber: number) => void)): EnumInfo | undefined;
     function unallocate(enumInfo: EnumInfo): void;
     function unallocateMod(modIndex: number): void;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@wayward/types",
 	"description": "TypeScript declarations for Wayward, used for modding.",
-	"version": "2.13.3-beta.dev.20230627.1",
+	"version": "2.13.3-beta.dev.20230627.2",
 	"license": "MIT",
 	"repository": {
 		"type": "git",