@wayward/types 2.12.0-beta.dev.20220903.1 → 2.12.0-beta.dev.20220904.1

package/definitions/game/audio/IAudio.d.ts

@@ -55,9 +55,11 @@ export declare enum SfxType {
     UiInput = 28,
     UiInvalid = 29,
     UiOpen = 30,
-    UiSelect = 31,
-    Walk = 32,
-    Water = 33
+    UiProtect = 31,
+    UiSelect = 32,
+    UiUnprotect = 33,
+    Walk = 34,
+    Water = 35
 }
 export declare type SfxUi = Extract<keyof typeof SfxType, `Ui${string}`> extends `Ui${infer RESULT}` ? Lowercase<RESULT> : never;
 export declare enum Music {

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

@@ -18,8 +18,7 @@ import type Human from "game/entity/Human";
 import type { AttackType, EntityType } from "game/entity/IEntity";
 import type { EquipType, RestType, SkillType } from "game/entity/IHuman";
 import type NPC from "game/entity/npc/NPC";
-import type { MessageType } from "game/entity/player/IMessageManager";
-import { Source } from "game/entity/player/IMessageManager";
+import type { IPackedMessage } from "game/entity/player/IMessageManager";
 import type { TurnTypeFlag } from "game/entity/player/IPlayer";
 import type Player from "game/entity/player/Player";
 import type { Quality } from "game/IObject";
@@ -31,8 +30,6 @@ import type { IPromptDescriptionBase, PromptDescriptionArgs } from "game/meta/pr
 import type { Milestone } from "game/milestones/IMilestone";
 import type { ITile } from "game/tile/ITerrain";
 import type TileEvent from "game/tile/TileEvent";
-import type Message from "language/dictionary/Message";
-import type Translation from "language/Translation";
 import type { IRGB } from "utilities/Color";
 import type { Direction } from "utilities/math/Direction";
 import type { IVector2, IVector3 } from "utilities/math/IVector";
@@ -176,22 +173,19 @@ export declare enum ActionDisplayLevel {
 }
 export interface IActionUsable {
     usable: true;
+    /**
+     * Whether this action is currently usable with the "use on move" feature. Defaults to `true`
+     */
+    usableOnMove?: boolean;
     displayLevel?: ActionDisplayLevel;
 }
-export interface IActionNotUsable {
+export interface IActionNotUsable extends Partial<IPackedMessage> {
     usable: false;
     alreadyUsing?: true;
     errorDisplayLevel?: ActionDisplayLevel;
-    message?: Message;
-    args?: Translation | any[];
+    mobCheck?: IVector3;
     arg?: never;
-    type?: MessageType;
-    sources?: Source | Source[];
     source?: never;
-    mobCheck?: IVector3;
-}
-export declare namespace IActionNotUsableUtilities {
-    function sendMessage(result: IActionNotUsable, human?: Human): void;
 }
 export declare type AnyActionDescription = IActionDescription<Array<ActionArgument | ActionArgument[]>, Entity, any, IActionUsable, any[]>;
 export interface IActionDescription<A extends Array<ActionArgument | ActionArgument[]> = Array<ActionArgument | ActionArgument[]>, E extends Entity = Entity, R = void, CU extends IActionUsable = IActionUsable, AV extends any[] = ActionArgumentTupleTypes<A>> {

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

@@ -25,12 +25,9 @@ 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;
@@ -101,7 +98,7 @@ export interface IUsableActionUsing<REQUIREMENTS extends IUsableActionRequiremen
 }
 export declare type UsableActionIconReference = ActionType | UsableActionType | UsableActionTypePlaceholder | (Omit<IIcon, "path"> & {
     action: ActionType | UsableActionType | UsableActionTypePlaceholder;
-});
+}) | IIcon;
 export declare type ReturnableUsableActionUsability = IActionUsable | IActionNotUsable | boolean;
 export interface IUsableActionUsable<REQUIREMENTS extends IUsableActionRequirements> extends IActionUsable {
     using: IUsableActionUsing<REQUIREMENTS>;
@@ -151,10 +148,6 @@ export interface IUsableActionDefinitionBase<REQUIREMENTS extends IUsableActionR
      * because it's repairing this tool.
      */
     iconLocationOnItem?: ItemDetailIconLocation;
-    /**
-     * The tooltip this action should have, or an initialiser for it.
-     */
-    tooltip?: ActionType | ((tooltip: Tooltip) => any);
     /**
      * A handler for what this action will highlight when hovered with the mouse.
      * @param selectors The default selectors. The defaults can be removed, and/or additional selectors can be added.
@@ -174,11 +167,14 @@ export interface IUsableActionDefinitionBase<REQUIREMENTS extends IUsableActionR
      */
     displayLevel?: ActionDisplayLevel;
     /**
-     * The display order of this action compared to other actions.
+     * Controls the display order of this action compared to other actions.
      * Generally you want to leave this as 0 (default) and just register your action in the correct place.
-     * Order can be generated dynamically based on the given objects — item, doodad, etc.
+     * Priority can be generated dynamically based on the given objects — item, doodad, etc.
+     *
+     * Higher priority === appears first.
+     * Lower priority === appears last.
      */
-    order?: number | ((using: IUsableActionPossibleUsing) => number | undefined);
+    priority?: number | ((using: IUsableActionPossibleUsing) => number | undefined);
     /**
      * Whether this action is currently usable — even if an action "makes sense" with the player and the objects they're using,
      * and the player can slot it and stuff, it might not currently be usable. For example, "harvest" having nothing to harvest.
@@ -261,11 +257,7 @@ declare class UsableAction<REQUIREMENTS extends IUsableActionRequirements = IUsa
     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(provided: IUsableActionPossibleUsing): {
-        path: ImagePath<PathType.Action>;
-        width: number;
-        height: number;
-    } | undefined;
+    getIcon(provided: IUsableActionPossibleUsing): IIcon | undefined;
     getHighlightSelectors(using?: IUsableActionPossibleUsing): HighlightSelector[];
     private translator?;
     getTranslation(using?: IUsableActionUsing<REQUIREMENTS>, which?: ActionTranslation): Translation | undefined;

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

@@ -18,7 +18,7 @@ export interface IUsableActionDynamicDefinition {
     icon?: UsableActionIconReference;
     bindable: Bindable;
     displayLevel?: ActionDisplayLevel;
-    order?: number;
+    priority?: number;
 }
 export interface IUsableActionsDynamicConfig<DEFINITION extends IUsableActionDynamicDefinition, REQUIREMENTS extends IUsableActionRequirements> {
     id: string;
@@ -27,7 +27,7 @@ export interface IUsableActionsDynamicConfig<DEFINITION extends IUsableActionDyn
     requirements?(action: ActionType, definition?: DEFINITION): REQUIREMENTS;
     isUsable(action: ActionType, player: Player, using: IUsableActionUsing<REQUIREMENTS>, definition?: DEFINITION): ReturnableUsableActionUsability;
     execute(action: ActionType, player: Player, using: IUsableActionUsing<REQUIREMENTS>, definition?: DEFINITION): any;
-    order?(action: ActionType, using: IUsableActionPossibleUsing, definition?: DEFINITION): number | undefined;
+    priority?(action: ActionType, using: IUsableActionPossibleUsing, definition?: DEFINITION): number | undefined;
 }
 export default class UsableActionsDynamic<DEFINITION extends IUsableActionDynamicDefinition, REQUIREMENTS extends IUsableActionRequirements> extends UsableActionGenerator {
     constructor(config: IUsableActionsDynamicConfig<DEFINITION, REQUIREMENTS>);

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

@@ -13,8 +13,8 @@ declare const UsableActionsMain: UsableActionGenerator<[]>;
 export default UsableActionsMain;
 export declare enum UsableActionSet {
     /**
-     * A set of usable action that appear before all other actions, unless {@link IUsableActionDefinitionBase.order} causes them to appear even earlier.
-     * Note that `order` is used to sort "use item/doodad/npc" actions to the top — the actions that appear in {@link IItemDescription.use}.
+     * A set of usable action that appear before all other actions, unless {@link IUsableActionDefinitionBase.priority} causes them to appear even earlier.
+     * Note that `priority` is used to sort "use item/doodad/npc" actions to the top — the actions that appear in {@link IItemDescription.use}.
      */
     First = 0,
     Vehicle = 1,

package/definitions/game/game/entity/creature/ICreature.d.ts

@@ -8,11 +8,13 @@
  * 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 { SfxType } from "audio/IAudio";
 import type { BiomeType } from "game/biome/IBiome";
 import type Doodad from "game/doodad/Doodad";
 import type Creature from "game/entity/creature/Creature";
 import type Human from "game/entity/Human";
 import type { AiType, DamageType, Defense, ICausesStatusEffect, IEntityEvents, MoveType } from "game/entity/IEntity";
+import type { IPackedMessage } from "game/entity/player/IMessageManager";
 import type { ItemType, ItemTypeGroup } from "game/item/IItem";
 import type { LootGroupType } from "game/item/LootGroups";
 import type { ITemperatureDescription } from "game/temperature/ITemperature";
@@ -22,6 +24,7 @@ import type Message from "language/dictionary/Message";
 import type TranslationImpl from "language/impl/TranslationImpl";
 import type Translation from "language/Translation";
 import type { IModdable } from "mod/ModRegistry";
+import type { StatNotificationType } from "renderer/notifier/INotifier";
 import type { IRGB } from "utilities/Color";
 export declare enum CreatureType {
     Slime = 0,
@@ -224,7 +227,6 @@ export interface IDamageOutcomeInput {
     target: Human | Creature;
     damageAmount: number;
     damageType: DamageType;
-    onlyCalculating?: boolean;
     weaponName?: Message | TranslationImpl;
     yourWeaponName?: Translation;
     targetName?: Translation;
@@ -236,6 +238,10 @@ export interface IDamageOutcome {
     vulnerable: number;
     vulnerableTypes: DamageType[];
     noDamage: boolean;
+    regenerate: number[];
+    soundEffect?: SfxType;
+    statNotifications: Array<[StatNotificationType, number]>;
+    messages: IPackedMessage[];
 }
 export interface ICreatureEvents extends IEntityEvents {
     /**

package/definitions/game/game/entity/player/IMessageManager.d.ts

@@ -102,6 +102,12 @@ export interface IMessage {
     type?: MessageType;
     message: ISerializedTranslation;
 }
+export interface IPackedMessage {
+    message: Message;
+    args?: Translation | any[];
+    type?: MessageType;
+    sources?: Source | Source[];
+}
 export interface IMessageManager {
     getMessageHistory(): Stream<IMessage>;
     clear(): this;
@@ -111,6 +117,7 @@ export interface IMessageManager {
     ifVisible(canSee?: IVector4): this;
     ifOnIsland(island: Island): this;
     send(message: Message | Translation, ...args: any[]): boolean;
+    sendPacked(pack: Partial<IPackedMessage>, ...extraSources: Source[]): boolean;
     pruneMessageHistory(): boolean;
     ifIs(human: Human): this;
     ifIsNot(human: Human): this;

package/definitions/game/game/entity/player/MessageManager.d.ts

@@ -10,7 +10,7 @@
  */
 import Stream from "@wayward/goodstream/Stream";
 import type Human from "game/entity/Human";
-import type { IMessage, IMessageHistoryItem, IMessageManager } from "game/entity/player/IMessageManager";
+import type { IMessage, IMessageHistoryItem, IMessageManager, IPackedMessage } from "game/entity/player/IMessageManager";
 import { MessageType, Source } from "game/entity/player/IMessageManager";
 import type Player from "game/entity/player/Player";
 import type Island from "game/island/Island";
@@ -28,6 +28,7 @@ export declare class MessageManagerNoOp implements IMessageManager {
     ifIs(player: Player): this;
     ifIsNot(player: Player): this;
     send(): boolean;
+    sendPacked(): boolean;
     sentToAll(sentToAll?: boolean): this;
     pruneMessageHistory(): boolean;
     addToHistory(messageHistoryItem: IMessageHistoryItem): void;
@@ -114,6 +115,7 @@ export default class MessageManager implements IMessageManager {
      * Note: After sending a message, the message source, type, and human (if any) are reset.
      */
     send(message: Message | Translation, ...args: any[]): boolean;
+    sendPacked(pack: Partial<IPackedMessage>, ...extraSources: Source[]): boolean;
     addToHistory(messageHistoryItem: IMessageHistoryItem): void;
     /**
      * Signal that the message was sent to everyone

package/definitions/game/game/item/IItemManager.d.ts

@@ -47,11 +47,11 @@ export interface IGetItemsOptions extends IGetItemOptions {
 }
 export interface IGetBestItemsOptions extends IGetItemsOptions {
     action: ActionType;
+    actionWith: Item;
     filterType: ItemType;
     filterGroup: ItemTypeGroup;
     filterConsumable: true;
     targetCreature: Creature;
-    ammoItem: Item;
     filter(item: Item): any;
 }
 export declare enum CraftStatus {

package/definitions/game/ui/old/OldUi.d.ts

@@ -45,7 +45,7 @@ export default class OldUi {
     syncDecayBar(item: Item, syncDamage?: boolean): void;
     syncItemElements(itemIds: number | number[], forceSyncDecay?: boolean): void;
     setEquipSlot(equip: EquipType, itemId: number, internal?: boolean): void;
-    removeItemFromEquipSlot(equip: EquipType): void;
+    removeItemFromEquipSlot(equip: EquipType, itemId: number): void;
     shouldRefreshMods(): boolean;
     onGameEnd(): void;
     toggleUIDisplay(hide: boolean): void;

package/definitions/game/ui/old/screens/InGameScreen.d.ts

@@ -9,7 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type Doodad from "game/doodad/Doodad";
-import { EquipType } from "game/entity/IHuman";
+import type { EquipType } from "game/entity/IHuman";
 import NPC from "game/entity/npc/NPC";
 import type { IContainer, IDismantleComponent } from "game/item/IItem";
 import { ItemType } from "game/item/IItem";
@@ -139,10 +139,8 @@ export default class InGameScreen extends BaseScreen {
     tooltipHide(): void;
     unSelectElements(): void;
     onSortableItemReceive(sortableEvent: ISortableEvent): void;
-    getEquipSlotItemElement(equip: EquipType): JQuery;
-    getItemIdInEquipSlot(equip: EquipType): number | undefined;
     setEquipSlot(equip: EquipType, itemId?: number, internal?: boolean): void;
-    removeItemFromEquipSlot(equip: EquipType): void;
+    removeItemFromEquipSlot(equip: EquipType, itemId: number): void;
     updateCraftingDialog(craftableItemTypes: ItemType[], nonCraftableItemTypes: ItemType[]): void;
     updateDismantleTab(dismantleItems: IDismantleComponent, force?: boolean): void;
     createCraftItemElements(containerSortInfo: IContainerSortInfo): void;

package/definitions/game/ui/screen/screens/game/component/Item.d.ts

@@ -9,14 +9,15 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type { Events, IEventEmitter } from "event/EventEmitter";
-import type UsableAction from "game/entity/action/usable/UsableAction";
-import type { ActionId, IUsableActionPossibleUsing } from "game/entity/action/usable/UsableAction";
+import type { ActionId } from "game/entity/action/usable/UsableAction";
 import type { EquipType } from "game/entity/IHuman";
 import type { ItemType } from "game/item/IItem";
 import type Item from "game/item/Item";
 import Component from "ui/component/Component";
 import type ContextMenu from "ui/component/ContextMenu";
 import Bindable from "ui/input/Bindable";
+import type ActionBar from "ui/screen/screens/game/static/ActionBar";
+import type { ActionSlot } from "ui/screen/screens/game/static/ActionBar";
 import type { IDraggableComponent } from "ui/util/Draggable";
 import Draggable from "ui/util/Draggable";
 import Vector2 from "utilities/math/Vector2";
@@ -60,10 +61,21 @@ export interface IItemHandler {
     equipSlot?: EquipType;
     getItem?(): Item | undefined;
     getItemType?(): ItemType | undefined;
-    getAction?(): UsableAction | undefined;
-    getActionUsing?(): IUsableActionPossibleUsing | undefined;
+    getActionSlot?(): ActionSlot | undefined;
     getBindables?(bindables: Bindable[]): Bindable[];
 }
+export declare enum ItemRefreshType {
+    ItemType = 1,
+    Durability = 2,
+    Decay = 4,
+    Quality = 8,
+    Magic = 16,
+    Protected = 32,
+    EquipSlot = 64,
+    MaybeSlottedInActionSlot = 128,
+    Action = 256,
+    All = 511
+}
 export default class ItemComponent extends Component {
     protected readonly handler: IItemHandler;
     static registerSlot(slot: ItemSlot): void;
@@ -78,7 +90,12 @@ export default class ItemComponent extends Component {
     constructor(handler: IItemHandler);
     private lastItem?;
     private getItem;
-    refresh(): void;
+    protected onSlotUpdate(actionBar: ActionBar, slot: ActionSlot): void;
+    protected onToggleProtected(): void;
+    protected onUpdateEquip(): void;
+    protected onUpdateItemType(): void;
+    protected onUpdateDurability(): void;
+    refresh(refreshType: ItemRefreshType): void;
     clone(): ItemComponent;
     setItemMenu(initialiser?: (contextMenu: ContextMenu<ActionId>) => any): this;
     private dragPreview?;

package/definitions/game/ui/screen/screens/game/dialog/EquipmentDialog.d.ts

@@ -14,7 +14,7 @@ import Component from "ui/component/Component";
 import type { IBindHandlerApi } from "ui/input/Bind";
 import Dialog from "ui/screen/screens/game/component/Dialog";
 import type { IItemDropApi, ItemSlot } from "ui/screen/screens/game/component/Item";
-import ItemComponent from "ui/screen/screens/game/component/Item";
+import ItemComponent, { ItemRefreshType } from "ui/screen/screens/game/component/Item";
 import EquipmentSlotTooltipHandler from "ui/screen/screens/game/dialog/equipment/EquipmentSlotTooltip";
 export declare enum EquipmentClasses {
     Main = "game-dialog-equipment",
@@ -41,7 +41,7 @@ export declare class EquipmentSlot extends ItemComponent {
     private overriddenItem?;
     equipItem(item: Item): Promise<void>;
     clear(): void;
-    refresh(): void;
+    refresh(refreshType: ItemRefreshType): void;
     protected onEquipEvent(): void;
     protected onDrop(api: IItemDropApi, intoSlot?: ItemSlot): void;
     private isEquippable;

package/definitions/game/ui/screen/screens/game/static/ActionBar.d.ts

@@ -10,7 +10,7 @@
  */
 import type { Events, IEventEmitter } from "event/EventEmitter";
 import type { IActionApi } from "game/entity/action/IAction";
-import type { IUsableActionRequirements, ReturnableUsableActionUsability } from "game/entity/action/usable/UsableAction";
+import type { IUsableActionPossibleUsing, IUsableActionRequirements, ReturnableUsableActionUsability } from "game/entity/action/usable/UsableAction";
 import type Player from "game/entity/player/Player";
 import type Item from "game/item/Item";
 import Button from "ui/component/Button";
@@ -84,8 +84,8 @@ export default class ActionBar extends QuadrantComponent {
     private refreshSlots;
 }
 declare class ActionSlotSlottedContainer extends ItemComponent {
-    slotData: IActionBarSlotData;
-    constructor(slotData: IActionBarSlotData);
+    readonly slot: ActionSlot;
+    constructor(slot: ActionSlot);
     clone(): ActionSlotSlottedContainer;
     protected onEnter(reason: "mouse" | "focus"): void;
 }
@@ -121,5 +121,6 @@ export declare class ActionSlot extends Button implements IRefreshable {
     protected onLeave(reason: "mouse" | "focus"): void;
     private getTooltipLocation;
     getAction(): import("game/entity/action/usable/UsableAction").default<IUsableActionRequirements, import("game/entity/action/usable/UsableAction").IUsableActionDefinition<IUsableActionRequirements>> | undefined;
+    getUsing(): IUsableActionPossibleUsing;
 }
 export {};

package/package.json

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