@wayward/types 2.12.0-beta.dev.20220821.1 → 2.12.0-beta.dev.20220824.1

package/definitions/game/event/EventBuses.d.ts

@@ -37,6 +37,8 @@ import type Multiplayer from "multiplayer/Multiplayer";
 import type WorldRenderer from "renderer/world/WorldRenderer";
 import type SaveManager from "save/SaveManager";
 import type Steamworks from "steamworks/Steamworks";
+import type ActionBar from "ui/screen/screens/game/static/ActionBar";
+import type MovementHandler from "ui/screen/screens/game/util/movement/MovementHandler";
 export declare enum EventBus {
     Actions = 0,
     Audio = 1,
@@ -69,7 +71,9 @@ export declare enum EventBus {
     TileEventManager = 28,
     TileEvents = 29,
     Ui = 30,
-    WorldRenderer = 31
+    UiActionBar = 31,
+    UiMovementHandler = 32,
+    WorldRenderer = 33
 }
 declare const eventBuses: {
     [EventBus.Actions](): typeof ActionExecutor;
@@ -103,6 +107,8 @@ declare const eventBuses: {
     [EventBus.TileEventManager](): typeof TileEventManager;
     [EventBus.TileEvents](): typeof TileEvent;
     [EventBus.Ui](): typeof ui;
+    [EventBus.UiActionBar](): typeof ActionBar;
+    [EventBus.UiMovementHandler](): typeof MovementHandler;
     [EventBus.WorldRenderer](): typeof WorldRenderer;
 };
 export default eventBuses;

package/definitions/game/game/entity/IHuman.d.ts

@@ -139,11 +139,17 @@ export interface IHumanEvents extends Events<Entity>, ISkillEvents {
      */
     getMaxWeight(maxWeight: number): number;
     /**
-     * Called when input is being processed
+     * Called when input is being processed on the server
      * @param player The player object
      * @returns False to prevent input processing or undefined to use the default logic
      */
-    processInput(): boolean | undefined;
+    processInput(): false | undefined;
+    /**
+     * Called when movement is attempted on the server
+     * @param player The player object
+     * @returns False to prevent movement or undefined to use the default logic
+     */
+    canMove(): false | undefined;
     /**
      * Called when getting the players movement intent
      * @returns The movement intent of the player or undefined to use the default logic

package/definitions/game/game/entity/action/ActionsRegistration.d.ts

@@ -123,7 +123,9 @@ export declare const actionDescriptionsSlow: {
     33: import("./Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby], import("../Human").default, void, import("game/entity/action/IAction").IActionUsable, [import("../../item/Item").default]>;
     82: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../Human").default, void, import("game/entity/action/actions/TestDepth").ITestDepthCanUse, [(import("../../item/Item").default | undefined)?]>;
     2: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined], [import("game/entity/action/IAction").ActionArgument.AttackType, import("game/entity/action/IAction").ActionArgument.Undefined], [import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../Human").default, void, import("game/entity/action/actions/Attack").IAttackCanUse, [(import("../../item/Item").default | undefined)?, (import("../IEntity").AttackType | undefined)?, (import("../../item/Item").default | undefined)?]>;
-    67: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../Human").default, void, import("game/entity/action/actions/Till").ITillCanUse, [(import("../../item/Item").default | undefined)?]>;
+    112: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../Human").default, void, import("game/entity/action/actions/ToggleTilled").ITillCanUse, [(import("../../item/Item").default | undefined)?]>;
+    67: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../Human").default, void, import("game/entity/action/actions/ToggleTilled").ITillCanUse, [(import("../../item/Item").default | undefined)?]>;
+    111: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../Human").default, void, import("game/entity/action/actions/ToggleTilled").ITillCanUse, [(import("../../item/Item").default | undefined)?]>;
     104: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.Container, import("game/entity/action/IAction").ActionArgument.Undefined], [import("game/entity/action/IAction").ActionArgument.Boolean, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../Human").default, void, import("game/entity/action/actions/ToggleContainer").IToggleContainerCanUse, [(import("../../item/IItem").IContainer | undefined)?, (boolean | undefined)?]>;
     103: import("./Action").Action<[[import("game/entity/action/IAction").ActionArgument.Doodad, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../Human").default, true | undefined, import("game/entity/action/actions/ToggleDoor").IToggleDoorCanUse, [(import("../../doodad/Doodad").default | undefined)?]>;
     101: import("./Action").Action<[], import("../Human").default, void, import("game/entity/action/actions/ToggleHitch").IToggleHitchCanUse, []>;

package/definitions/game/game/entity/action/IAction.d.ts

@@ -147,7 +147,9 @@ export declare enum ActionType {
     UpdateWalkPath = 107,
     Operate = 108,
     Absorb = 109,
-    Exude = 110
+    Exude = 110,
+    PackGround = 111,
+    ToggleTilled = 112
 }
 export declare enum ActionUsability {
     Paused = 0,

package/definitions/game/game/entity/action/actions/PackGround.d.ts

@@ -0,0 +1,12 @@
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+declare const _default: import("../Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../../Human").default, void, import("game/entity/action/actions/ToggleTilled").ITillCanUse, [(import("../../../item/Item").default | undefined)?]>;
+export default _default;

package/definitions/game/game/entity/action/actions/Read.d.ts

@@ -12,10 +12,11 @@ import { Action } from "game/entity/action/Action";
 import type { IActionUsable } from "game/entity/action/IAction";
 import { ActionArgument } from "game/entity/action/IAction";
 import { BookType } from "game/item/IItem";
+import type Item from "game/item/Item";
 import type TranslationImpl from "language/impl/TranslationImpl";
 export interface IReadCanUse extends IActionUsable {
     book: BookType;
     basicBookName: TranslationImpl;
 }
-declare const _default: Action<[ActionArgument.ItemNearby], import("../../Human").default, void, IReadCanUse, [import("../../../item/Item").default]>;
+declare const _default: Action<[ActionArgument.ItemNearby], import("../../Human").default, void, IReadCanUse, [Item]>;
 export default _default;

package/definitions/game/game/entity/action/actions/Till.d.ts

@@ -8,18 +8,5 @@
  * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
  * https://github.com/WaywardGame/types/wiki
  */
-import { Action } from "game/entity/action/Action";
-import type { IActionUsable } from "game/entity/action/IAction";
-import { ActionArgument } from "game/entity/action/IAction";
-import type { ITerrainDescription, ITile, TerrainType } from "game/tile/ITerrain";
-export interface ITillCanUse extends IActionUsable {
-    tile: ITile;
-    isGrass: boolean;
-    tileType: TerrainType;
-    terrainDescription: ITerrainDescription;
-    x: number;
-    y: number;
-    z: number;
-}
-declare const _default: Action<[[ActionArgument.ItemInventory, ActionArgument.Undefined]], import("../../Human").default, void, ITillCanUse, [(import("../../../item/Item").default | undefined)?]>;
+declare const _default: import("../Action").Action<[[import("game/entity/action/IAction").ActionArgument.ItemInventory, import("game/entity/action/IAction").ActionArgument.Undefined]], import("../../Human").default, void, import("game/entity/action/actions/ToggleTilled").ITillCanUse, [(import("../../../item/Item").default | undefined)?]>;
 export default _default;

package/definitions/game/game/entity/action/actions/ToggleTilled.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import { Action } from "game/entity/action/Action";
+import type { IActionUsable } from "game/entity/action/IAction";
+import { ActionArgument } from "game/entity/action/IAction";
+import type { ITerrainDescription, ITile, TerrainType } from "game/tile/ITerrain";
+export interface ITillCanUse extends IActionUsable {
+    tile: ITile;
+    isGrass: boolean;
+    tileType: TerrainType;
+    terrainDescription: ITerrainDescription;
+    x: number;
+    y: number;
+    z: number;
+}
+declare const _default: Action<[[ActionArgument.ItemInventory, ActionArgument.Undefined]], import("../../Human").default, void, ITillCanUse, [(import("../../../item/Item").default | undefined)?]>;
+export default _default;

package/definitions/game/{ui/screen/screens/game/static/actions → game/entity/action/usable}/ConfirmAction.d.ts

@@ -9,4 +9,5 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import { ActionType } from "game/entity/action/IAction";
-export default function (actionType: ActionType, actionArgs: any[]): Promise<boolean>;
+import type Player from "game/entity/player/Player";
+export default function (player: Player, actionType: ActionType, actionArgs: any[]): Promise<boolean>;

package/definitions/game/game/entity/action/usable/UsableAction.d.ts

@@ -0,0 +1,193 @@
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import type Doodad from "game/doodad/Doodad";
+import type { ActionDisplayLevel, IActionNotUsable, IActionUsable } from "game/entity/action/IAction";
+import { ActionType } from "game/entity/action/IAction";
+import type UsableActionRegistrar from "game/entity/action/usable/UsableActionRegistrar";
+import type { UsableActionTypePlaceholder } from "game/entity/action/usable/UsableActionType";
+import { UsableActionType } from "game/entity/action/usable/UsableActionType";
+import type Creature from "game/entity/creature/Creature";
+import type NPC from "game/entity/npc/NPC";
+import type Player from "game/entity/player/Player";
+import type { IIcon } from "game/inspection/InfoProvider";
+import type { ItemType } from "game/item/IItem";
+import type { IGetBestItemsOptions } from "game/item/IItemManager";
+import type Item from "game/item/Item";
+import type Message from "language/dictionary/Message";
+import { ActionTranslation } from "language/dictionary/Misc";
+import TranslationImpl from "language/impl/TranslationImpl";
+import Translation from "language/Translation";
+import { PathType } from "resource/IResourceLoader";
+import type Bindable from "ui/input/Bindable";
+import type { ItemDetailIconLocation } from "ui/screen/screens/game/component/Item";
+import type Tooltip from "ui/tooltip/Tooltip";
+import type { HighlightSelector } from "ui/util/IHighlight";
+import ImagePath from "ui/util/ImagePath";
+export interface IUsableActionRequirement<TYPE> {
+    allowNone?: true;
+    validate?(player: Player, value: TYPE): boolean;
+    find?(player: Player): TYPE | undefined;
+    getMissingName?(): Translation;
+}
+export declare namespace IUsableActionRequirement {
+    interface Maybe<TYPE> {
+        allowNone: true;
+        validate(player: Player, value: TYPE): boolean;
+    }
+    type Always = true;
+}
+export interface IUsableActionRequirements {
+    item?: true | IUsableActionRequirement<Item>;
+    doodad?: true | IUsableActionRequirement<Doodad>;
+    creature?: true | IUsableActionRequirement<Creature>;
+    npc?: true | IUsableActionRequirement<NPC>;
+}
+export interface IUsableActionPossibleUsing {
+    item?: Item;
+    itemType?: ItemType;
+    doodad?: Doodad;
+    creature?: Creature;
+    npc?: NPC;
+}
+export interface IUsableActionUsing<REQUIREMENTS extends IUsableActionRequirements> {
+    item: ((REQUIREMENTS["item"] extends true ? Item : never) | (undefined extends REQUIREMENTS["item"] ? undefined : never) | (REQUIREMENTS["item"] extends {
+        allowNone: true;
+    } ? undefined : never) | (REQUIREMENTS["item"] extends {
+        validate(player: Player, value: Item): boolean;
+    } ? Item : never) | (REQUIREMENTS["item"] extends {
+        find(player: Player): Item;
+    } ? Item : never));
+    doodad: ((REQUIREMENTS["doodad"] extends true ? Doodad : never) | (undefined extends REQUIREMENTS["doodad"] ? undefined : never) | (REQUIREMENTS["doodad"] extends {
+        allowNone: true;
+    } ? undefined : never) | (REQUIREMENTS["doodad"] extends {
+        validate(player: Player, value: Doodad): boolean;
+    } ? Doodad : never) | (REQUIREMENTS["doodad"] extends {
+        find(player: Player): Doodad;
+    } ? Doodad : never));
+    creature: ((REQUIREMENTS["creature"] extends true ? Creature : never) | (undefined extends REQUIREMENTS["creature"] ? undefined : never) | (REQUIREMENTS["creature"] extends {
+        allowNone: true;
+    } ? undefined : never) | (REQUIREMENTS["creature"] extends {
+        validate(player: Player, value: Creature): boolean;
+    } ? Creature : never) | (REQUIREMENTS["creature"] extends {
+        find(player: Player): Creature;
+    } ? Creature : never));
+    npc: ((REQUIREMENTS["npc"] extends true ? NPC : never) | (undefined extends REQUIREMENTS["npc"] ? undefined : never) | (REQUIREMENTS["npc"] extends {
+        allowNone: true;
+    } ? undefined : never) | (REQUIREMENTS["npc"] extends {
+        validate(player: Player, value: NPC): boolean;
+    } ? NPC : never) | (REQUIREMENTS["npc"] extends {
+        find(player: Player): NPC;
+    } ? NPC : never));
+}
+export declare type UsableActionIconReference = ActionType | UsableActionType | UsableActionTypePlaceholder | (Omit<IIcon, "path"> & {
+    action: ActionType | UsableActionType | UsableActionTypePlaceholder;
+});
+export declare type ReturnableUsableActionUsability = IActionUsable | IActionNotUsable | boolean;
+export interface IUsableActionUsable<REQUIREMENTS extends IUsableActionRequirements> extends IActionUsable {
+    using: IUsableActionUsing<REQUIREMENTS>;
+}
+export interface IUsableActionNotUsable extends IActionNotUsable {
+    sendMessage(): void;
+}
+export declare namespace IUsableActionNotUsable {
+    function create(message?: Message, ...args: any[]): IUsableActionNotUsable;
+    function sendMessage(notUsable: IActionNotUsable): void;
+    function equals(a: IUsableActionNotUsable, b: IUsableActionNotUsable): boolean;
+}
+export declare type UsableActionUsability<REQUIREMENTS extends IUsableActionRequirements = IUsableActionRequirements> = IUsableActionUsable<REQUIREMENTS> | IUsableActionNotUsable;
+export declare enum UsableActionExecutionContext {
+    ContextMenu = 0,
+    ActionBar = 1
+}
+export interface IUsableActionExecutionContext {
+    context: UsableActionExecutionContext;
+    getItemContainerFilterText(): string | undefined;
+}
+export interface IUsableActionDefinitionBase<REQUIREMENTS extends IUsableActionRequirements = IUsableActionRequirements> {
+    id?: string | number;
+    slottable?: boolean;
+    isApplicable?(player: Player, using: IUsableActionPossibleUsing): boolean;
+    translate?: (translator: UsableActionTranslator) => UsableActionTranslator;
+    icon?: UsableActionIconReference;
+    iconLocationOnItem?: ItemDetailIconLocation;
+    tooltip?: ActionType | ((tooltip: Tooltip) => any);
+    highlight?(selectors: HighlightSelector[], using: IUsableActionPossibleUsing): any;
+    bindable?: Bindable | ((using: IUsableActionUsing<REQUIREMENTS>) => Bindable | undefined);
+    submenu?(registrar: UsableActionRegistrar, using: IUsableActionUsing<REQUIREMENTS>): UsableActionRegistrar | void;
+    execute?(player: Player, using: IUsableActionUsing<REQUIREMENTS>, context: IUsableActionExecutionContext): any;
+    isUsable?(player: Player, using: IUsableActionUsing<REQUIREMENTS>): ReturnableUsableActionUsability;
+    displayLevel?: ActionDisplayLevel;
+    order?: number | ((using: IUsableActionPossibleUsing) => number | undefined);
+}
+export interface IUsableActionDefinitionSubmenu<REQUIREMENTS extends IUsableActionRequirements = IUsableActionRequirements> extends IUsableActionDefinitionBase<REQUIREMENTS> {
+    submenu(registrar: UsableActionRegistrar, using: IUsableActionUsing<REQUIREMENTS>): UsableActionRegistrar | void;
+    execute?: undefined;
+    isUsable?(player: Player, using: IUsableActionUsing<REQUIREMENTS>): ReturnableUsableActionUsability;
+    slottable?: undefined;
+}
+export interface IUsableActionDefinitionExecutable<REQUIREMENTS extends IUsableActionRequirements = IUsableActionRequirements> extends IUsableActionDefinitionBase<REQUIREMENTS> {
+    slottable?: boolean;
+    submenu?: undefined;
+    execute(player: Player, using: IUsableActionUsing<REQUIREMENTS>, context: IUsableActionExecutionContext): any;
+    isUsable?(player: Player, using: IUsableActionUsing<REQUIREMENTS>): ReturnableUsableActionUsability;
+}
+export declare type IUsableActionDefinition<REQUIREMENTS extends IUsableActionRequirements = IUsableActionRequirements> = IUsableActionDefinitionSubmenu<REQUIREMENTS> | IUsableActionDefinitionExecutable<REQUIREMENTS>;
+export declare type ActionId = string | ActionType | UsableActionType;
+declare class UsableAction<REQUIREMENTS extends IUsableActionRequirements = IUsableActionRequirements, DEFINITION extends IUsableActionDefinition<REQUIREMENTS> = IUsableActionDefinition<REQUIREMENTS>> {
+    readonly requirements: REQUIREMENTS;
+    readonly definition: DEFINITION;
+    id: ActionId;
+    constructor(requirements: REQUIREMENTS, definition: DEFINITION);
+    isExecutable(): this is UsableAction<REQUIREMENTS, IUsableActionDefinitionExecutable<REQUIREMENTS>>;
+    execute(player: Player, provided: IUsableActionUsing<REQUIREMENTS>, context: IUsableActionExecutionContext): boolean;
+    private resolveUsing;
+    isUsable(player: Player, provided: IUsableActionUsing<REQUIREMENTS>): UsableActionUsability<REQUIREMENTS>;
+    isApplicable(player: Player, provided?: IUsableActionPossibleUsing, fullUsabilityCheck?: boolean): provided is IUsableActionUsing<REQUIREMENTS>;
+    private isItemApplicable;
+    private isDoodadApplicable;
+    private isCreatureApplicable;
+    private isNPCApplicable;
+    private readonly findItemCannotUse;
+    getFindItemCannotUse(): IUsableActionNotUsable[];
+    getItem(player: Player, provided?: IUsableActionPossibleUsing, fullUsabilityCheck?: boolean): Item | false | undefined;
+    private getItemByType;
+    getDoodad(player: Player, provided?: IUsableActionPossibleUsing): false | Doodad | undefined;
+    getCreature(player: Player, provided?: IUsableActionPossibleUsing): false | Creature | undefined;
+    getNPC(player: Player, provided?: IUsableActionPossibleUsing): false | NPC | undefined;
+    getIcon(): {
+        path: ImagePath<PathType.Action>;
+        width: number;
+        height: number;
+    } | undefined;
+    getHighlightSelectors(using?: IUsableActionPossibleUsing): HighlightSelector[];
+    private translator?;
+    getTranslation(using?: IUsableActionUsing<REQUIREMENTS>, which?: ActionTranslation): TranslationImpl | undefined;
+    getOrder(using?: IUsableActionPossibleUsing): number;
+}
+export declare class UsableActionTranslator {
+    readonly id: ActionId;
+    private nameSupplier?;
+    private descriptionSupplier?;
+    constructor(id: ActionId);
+    name(supplier: SupplierOr<Translation, [IUsableActionPossibleUsing]>): this;
+    description(supplier: SupplierOr<Translation, [IUsableActionPossibleUsing]>): this;
+    get(using?: IUsableActionPossibleUsing, which?: ActionTranslation): TranslationImpl | undefined;
+}
+export interface IUsableActionFactory<REQUIREMENTS extends IUsableActionRequirements> {
+    create: <DEFINITION extends IUsableActionDefinition<REQUIREMENTS>>(action: DEFINITION) => UsableAction<REQUIREMENTS, DEFINITION>;
+}
+declare namespace UsableAction {
+    function requiring<REQUIREMENTS1 extends IUsableActionRequirements>(requirements: REQUIREMENTS1): IUsableActionFactory<REQUIREMENTS1>;
+    function create<DEFINITION extends IUsableActionDefinition<{}>>(action: DEFINITION): UsableAction<{}, DEFINITION>;
+    function translateId(id: ActionId, which?: ActionTranslation): TranslationImpl | undefined;
+    function getBestSafeItemInInventory(player: Player, options?: Partial<IGetBestItemsOptions>): Item | undefined;
+}
+export default UsableAction;

package/definitions/game/game/entity/action/usable/UsableActionRegistrar.d.ts

@@ -0,0 +1,84 @@
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import EventEmitter from "event/EventEmitter";
+import type { EmitterOrBus, Event } from "event/EventManager";
+import { ActionDisplayLevel } from "game/entity/action/IAction";
+import type UsableAction from "game/entity/action/usable/UsableAction";
+import type { ActionId, IUsableActionPossibleUsing, IUsableActionRequirements } from "game/entity/action/usable/UsableAction";
+import ContextMenu from "ui/component/ContextMenu";
+export default class UsableActionRegistrar {
+    readonly actions: Array<[string, UsableAction]>;
+    readonly actionIndices: Record<string, number>;
+    readonly actionIds: string[];
+    byId(id?: string): UsableAction | undefined;
+    filter(filter: (action: UsableAction, id: string) => any): UsableActionRegistrar;
+    private contextMenuInitializer?;
+    setContextMenuInitializer(initializer?: (menu: ContextMenu) => any): this;
+    add(registrar: UsableActionRegistrar): this;
+    add<REQUIREMENTS extends IUsableActionRequirements>(id: string | number, action: UsableAction<REQUIREMENTS>): this;
+    showContextMenu(provided: IUsableActionPossibleUsing, contextMenu?: ContextMenu<ActionId>, context?: ActionDisplayLevel, initialiser?: (contextMenu: ContextMenu<ActionId>) => any): ContextMenu<string | number | symbol>;
+    createContextMenu(provided: IUsableActionPossibleUsing, contextMenu?: ContextMenu<ActionId>, context?: ActionDisplayLevel, initialiser?: (contextMenu: ContextMenu<ActionId>) => any): ContextMenu;
+    private getTooltipLocation;
+}
+export interface IUsableActionGeneratorEvents {
+    stopPersisting(): any;
+}
+export interface IUsableActionGeneratorPersistenceFactory<HOST> {
+    when<E extends EmitterOrBus, K extends Event<E>>(emitter: E, event: K): {
+        until<E extends EmitterOrBus, K extends Event<E>>(emitter: E, event: K): HOST;
+    };
+}
+export declare type UsableActionGeneratorRegistrationHandler<ARGS extends any[]> = (registrar: UsableActionRegistrar, ...args: ARGS) => any;
+export interface IUsableActionGeneratorFactory {
+    create<ARGS extends any[]>(id: string, registrationHandler: UsableActionGeneratorRegistrationHandler<ARGS>): UsableActionGenerator<ARGS>;
+    create<ARGS extends any[]>(registrationHandler: UsableActionGeneratorRegistrationHandler<ARGS>): UsableActionGenerator<ARGS>;
+}
+export declare class UsableActionGenerator<ARGS extends any[] = []> extends EventEmitter.Host<IUsableActionGeneratorEvents> {
+    static persisting(initializer: (persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>) => IUsableActionGeneratorFactory): IUsableActionGeneratorFactory;
+    static persisting(initializer: (persist: IUsableActionGeneratorPersistenceFactory<IUsableActionGeneratorFactory>) => UsableActionGenerator): UsableActionGenerator;
+    static singleton<REQUIREMENTS extends IUsableActionRequirements>(id: string | number, action: UsableAction<REQUIREMENTS>): UsableActionGenerator<[]>;
+    private readonly id?;
+    private readonly registrationHandler;
+    private get log();
+    constructor(id: string, registrationHandler: UsableActionGeneratorRegistrationHandler<ARGS>);
+    constructor(registrationHandler: UsableActionGeneratorRegistrationHandler<ARGS>);
+    register(registrar: UsableActionRegistrar, ...args: ARGS): void;
+    private contextMenuInitializer?;
+    /**
+     * Initializes any context menus originating from registrars generated by this generator.
+     * Note: Overrides any initializers set by default on the registration handler.
+     */
+    setContextMenuInitializer(initializer?: (menu: ContextMenu) => any): this;
+    private cachedRegistrar;
+    /**
+     * Returns an action registrar created by this generator. If there is not a cached registrar, generates a new one.
+     * Does not cache the generator unless this generator is marked for persistence.
+     */
+    get(...args: ARGS): UsableActionRegistrar;
+    /**
+     * Forcibly regenerates and returns a new action registrar from this generator.
+     * If this generator is marked for persistence, the generated registrar will be cached and accessible thereafter by `get()`.
+     */
+    generate(...args: ARGS): UsableActionRegistrar;
+    private activePersistences;
+    /**
+     * Marks this generator for persistence when the "when" event occurs,
+     * and unmarks this generator for persistence when the "until" event occurs.
+     *
+     * This method can be called multiple times to add multiple ranges where persistence is active.
+     * Intersecting persistences don't cancel each other.
+     */
+    persist(initializer: (persist: IUsableActionGeneratorPersistenceFactory<this>) => this): this;
+    /**
+     * Removes persistence from this generator. All prior "when" and "until" persistence ranges will be removed.
+     */
+    disablePersistence(): void;
+}

package/definitions/game/{ui/screen/screens/game/static/actions/UiActionType.d.ts → game/entity/action/usable/UsableActionType.d.ts}

@@ -8,7 +8,7 @@
  * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
  * https://github.com/WaywardGame/types/wiki
  */
-export declare enum UiActionType {
+export declare enum UsableActionType {
     Use = 1000000,
     QuickSlotRemove = 1000001,
     QuickSlotAdd = 1000002,
@@ -58,7 +58,7 @@ export declare enum UiActionType {
     EquipMainHand = 1000046,
     EquipOffHand = 1000047
 }
-export declare enum UiActionTypePlaceholder {
+export declare enum UsableActionTypePlaceholder {
     TradeItem = 2000000,
     MoveAllToInventory = 2000001,
     MoveAllOfSameQualityToInventory = 2000002

package/definitions/game/{ui/screen/screens/game/static/actions/actions/UiActionRename.d.ts → game/entity/action/usable/actions/UsableActionRename.d.ts}

@@ -8,8 +8,9 @@
  * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
  * https://github.com/WaywardGame/types/wiki
  */
+import { UsableActionGenerator } from "game/entity/action/usable/UsableActionRegistrar";
+import type Player from "game/entity/player/Player";
 import type Item from "game/item/Item";
-import { UiActionGenerator } from "ui/screen/screens/game/static/actions/UiActionRegistrar";
-export declare function requestRename(item?: Item): void;
-declare const _default: UiActionGenerator<[]>;
+export declare function requestRename(player: Player, item?: Item): void;
+declare const _default: UsableActionGenerator<[]>;
 export default _default;

package/definitions/game/{ui/screen/screens/game/static/actions/actions/UiActionsMain.d.ts → game/entity/action/usable/actions/UsableActionsContainer.d.ts}

@@ -8,6 +8,6 @@
  * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
  * https://github.com/WaywardGame/types/wiki
  */
-import { UiActionGenerator } from "ui/screen/screens/game/static/actions/UiActionRegistrar";
-declare const _default: UiActionGenerator<[]>;
+import { UsableActionGenerator } from "game/entity/action/usable/UsableActionRegistrar";
+declare const _default: UsableActionGenerator<[]>;
 export default _default;

package/definitions/game/{ui/screen/screens/game/static/actions/actions/UiActionsWithHands.d.ts → game/entity/action/usable/actions/UsableActionsCreatures.d.ts}

@@ -8,6 +8,6 @@
  * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
  * https://github.com/WaywardGame/types/wiki
  */
-import { UiActionGenerator } from "ui/screen/screens/game/static/actions/UiActionRegistrar";
-declare const _default: UiActionGenerator<[]>;
+import { UsableActionGenerator } from "game/entity/action/usable/UsableActionRegistrar";
+declare const _default: UsableActionGenerator<[]>;
 export default _default;

package/definitions/game/game/entity/action/usable/actions/UsableActionsDynamic.d.ts

@@ -0,0 +1,33 @@
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import type { ActionDisplayLevel } from "game/entity/action/IAction";
+import { ActionType } from "game/entity/action/IAction";
+import type { IUsableActionPossibleUsing, IUsableActionRequirements, IUsableActionUsing, ReturnableUsableActionUsability, UsableActionIconReference } from "game/entity/action/usable/UsableAction";
+import { UsableActionGenerator } from "game/entity/action/usable/UsableActionRegistrar";
+import type Player from "game/entity/player/Player";
+import type Bindable from "ui/input/Bindable";
+export interface IUsableActionDynamicDefinition {
+    icon?: UsableActionIconReference;
+    bindable: Bindable;
+    displayLevel?: ActionDisplayLevel;
+}
+export interface IUsableActionsDynamicConfig<DEFINITION extends IUsableActionDynamicDefinition, REQUIREMENTS extends IUsableActionRequirements> {
+    id: string;
+    record: PartialRecord<ActionType, DEFINITION | false>;
+    getDynamic(actions: Set<ActionType>): any;
+    requirements?(action: ActionType, definition?: DEFINITION): REQUIREMENTS;
+    isUsable(action: ActionType, player: Player, using: IUsableActionUsing<REQUIREMENTS>): ReturnableUsableActionUsability;
+    execute(action: ActionType, player: Player, using: IUsableActionUsing<REQUIREMENTS>): any;
+    order?(action: ActionType, using: IUsableActionPossibleUsing): number | undefined;
+}
+export default class UsableActionsDynamic<DEFINITION extends IUsableActionDynamicDefinition, REQUIREMENTS extends IUsableActionRequirements> extends UsableActionGenerator {
+    constructor(config: IUsableActionsDynamicConfig<DEFINITION, REQUIREMENTS>);
+}

package/definitions/game/{ui/screen/screens/game/static/actions/actions/UiActionsCreatures.d.ts → game/entity/action/usable/actions/UsableActionsMain.d.ts}

@@ -8,6 +8,6 @@
  * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
  * https://github.com/WaywardGame/types/wiki
  */
-import { UiActionGenerator } from "ui/screen/screens/game/static/actions/UiActionRegistrar";
-declare const _default: UiActionGenerator<[]>;
+import { UsableActionGenerator } from "game/entity/action/usable/UsableActionRegistrar";
+declare const _default: UsableActionGenerator<[]>;
 export default _default;

package/definitions/game/{ui/screen/screens/game/static/actions/actions/doodad/UiActionCloseContainer.d.ts → game/entity/action/usable/actions/UsableActionsRest.d.ts}

@@ -8,6 +8,6 @@
  * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
  * https://github.com/WaywardGame/types/wiki
  */
-import { UiActionGenerator } from "ui/screen/screens/game/static/actions/UiActionRegistrar";
-declare const _default: UiActionGenerator<[]>;
+import { UsableActionGenerator } from "game/entity/action/usable/UsableActionRegistrar";
+declare const _default: UsableActionGenerator<[]>;
 export default _default;

package/definitions/game/game/entity/action/usable/actions/UsableActionsTill.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import { UsableActionGenerator } from "game/entity/action/usable/UsableActionRegistrar";
+declare const _default: UsableActionGenerator<[]>;
+export default _default;

package/definitions/game/game/entity/action/usable/actions/UsableActionsUseNPC.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import type { IUsableActionDynamicDefinition } from "game/entity/action/usable/actions/UsableActionsDynamic";
+import UsableActionsDynamic from "game/entity/action/usable/actions/UsableActionsDynamic";
+import type { IUsableActionRequirements } from "game/entity/action/usable/UsableAction";
+export interface IUseNPCAction extends IUsableActionDynamicDefinition {
+    allowNoNPC?: true;
+}
+declare const _default: UsableActionsDynamic<IUseNPCAction, IUsableActionRequirements>;
+export default _default;

package/definitions/game/game/entity/action/usable/actions/UsableActionsWithHands.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright 2011-2021 Unlok
+ * https://www.unlok.ca
+ *
+ * Credits & Thanks:
+ * https://www.unlok.ca/credits-thanks/
+ *
+ * Wayward is a copyrighted and licensed work. Modification and/or distribution of any source files is prohibited. If you wish to modify the game in any way, please refer to the modding guide:
+ * https://github.com/WaywardGame/types/wiki
+ */
+import { UsableActionGenerator } from "game/entity/action/usable/UsableActionRegistrar";
+declare const _default: UsableActionGenerator<[]>;
+export default _default;