@wayward/types 2.13.2-beta.dev.20230529.1 → 2.13.2-beta.dev.20230530.1

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

@@ -221,6 +221,7 @@ export default abstract class Human<TypeType extends number = number> extends En
      */
     processInput(timeStamp: number): IMovementIntent | undefined;
     staminaReduction(skill?: SkillType, level?: number): void;
+    updateReputationForAttackingWithTamedCreature(target: Creature, attacker: Creature): void;
     updateReputation(reputation: number): void;
     protected checkOnLoadMilestones(): void;
     capReputation(): void;
@@ -251,6 +252,7 @@ export default abstract class Human<TypeType extends number = number> extends En
     hasWalkPath(): boolean;
     setWalkPath(path: IVector2[] | undefined, force?: boolean): void;
     checkUnder(inFacingDirection?: boolean, options?: ICheckUnderOptions): ICheckUnderOptions;
+    trampleFire(fireEvent: TileEvent): void;
     damageByInteractingWith(thing: Doodad | TileEvent, options: ICheckUnderOptions | undefined, damageLocation: EquipType): ICheckUnderOptions;
     equip(item: Item, slot: EquipType, internal?: boolean): boolean;
     /**

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

@@ -9,7 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type Doodad from "game/doodad/Doodad";
-import type { ActionArgument, ActionArgumentTupleTypes, ActionFlag, ActionUsability, IActionApi, IActionConfirmerApi, IActionDescription, IActionHandlerApi, IActionNotUsable, IActionUsable } from "game/entity/action/IAction";
+import type { ActionArgument, ActionArgumentTupleTypes, ActionFlag, ActionUsability, IActionApi, IActionConfirmerApi, IActionDescription, IActionExample, IActionExampleApi, IActionHandlerApi, IActionNotUsable, IActionUsable } from "game/entity/action/IAction";
 import type Corpse from "game/entity/creature/corpse/Corpse";
 import type Creature from "game/entity/creature/Creature";
 import type Entity from "game/entity/Entity";
@@ -34,12 +34,14 @@ export declare class Action<A extends Array<ActionArgument | ActionArgument[]>,
     canUseHandler: (actionApi: IActionHandlerApi<E, CU>, ...args: AV) => CU | IActionNotUsable;
     handler: (actionApi: IActionHandlerApi<E, CU>, ...args: AV) => R;
     confirmer?: (actionApi: IActionConfirmerApi<E, any>, ...args: AV) => Promise<boolean>;
+    exampleHandler?: (actionApi: IActionExampleApi<E, CU>, ...args: AV) => IActionExample;
     private shouldSkipConfirmation;
     constructor(...argumentTypes: A);
     /**
      * Check if the action has setup CanUse logic
      */
     get hasSetCanUse(): boolean;
+    getExample(executor: E, ...args: AV): IActionExample | undefined;
     canUse(actionApi: IActionApi<E, any>, ...args: AV): CU | IActionNotUsable;
     canUse(executor: E, ...args: AV): CU | IActionNotUsable;
     canUseWhileFacing(actionExecutor: E, position: IVector3, direction: Direction.Cardinal, ...args: AV): CU | IActionNotUsable;
@@ -67,6 +69,10 @@ export declare class Action<A extends Array<ActionArgument | ActionArgument[]>,
      * @return `false` to cancel the execution of the action.
      */
     setConfirmer(confirmer: (actionApi: IActionConfirmerApi<E, CU>, ...args: AV) => Promise<boolean>): this;
+    /**
+     * Add an example to this action.
+     */
+    setExample(exampleHandler: (actionApi: IActionExampleApi<E, CU>, ...args: AV) => IActionExample): this;
     /**
      * Add a can use handler for this action.
      *

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

@@ -10,9 +10,10 @@
  */
 import type { SfxType } from "audio/IAudio";
 import EventEmitter from "event/EventEmitter";
-import type { ActionExecutorEvents, AnyActionDescription, IActionApi, IActionArgumentTypeMap, IActionConfirmerApi, IActionDescription, IActionNotUsable, IActionParticle, IActionSoundEffect, IActionUsable, IProtectedItems } from "game/entity/action/IAction";
+import type { ActionExecutorEvents, AnyActionDescription, IActionApi, IActionArgumentTypeMap, IActionConfirmerApi, IActionDescription, IActionExample, IActionNotUsable, IActionParticle, IActionSoundEffect, IActionUsable, IProtectedItems } from "game/entity/action/IAction";
 import { ActionArgument, ActionType } from "game/entity/action/IAction";
 import type Entity from "game/entity/Entity";
+import type Human from "game/entity/Human";
 import type { SkillType } from "game/entity/IHuman";
 import type { TurnTypeFlag } from "game/entity/player/IPlayer";
 import type Item from "game/item/Item";
@@ -60,6 +61,7 @@ export default class ActionExecutor<A extends Array<ActionArgument | ActionArgum
     private itemsUsed;
     private readonly action;
     constructor(action?: IActionDescription<A, E, R, CU>, type?: number | undefined);
+    get description(): IActionDescription<A, E, R, CU>;
     skipConfirmation(): this;
     /**
      * Check if a creature on a tile and blocking the execution of the action
@@ -71,6 +73,7 @@ export default class ActionExecutor<A extends Array<ActionArgument | ActionArgum
      * true if a creature is on a tile, false otherwise
      */
     isCreatureBlocking(tile: Tile): boolean;
+    getExample(executor: E, ...args: AV): IActionExample | undefined;
     /**
      * Check if an action can be used.
      * When used within an action, the result will automatically be processed.
@@ -119,6 +122,7 @@ export default class ActionExecutor<A extends Array<ActionArgument | ActionArgum
     private executeInternal;
     private createActionPacket;
     private handleApiOnActionFailure;
+    protected handleReputationChange(human: Human): void;
     private handleApi;
     private canExecute;
     private isUsableWhen;

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

@@ -21,7 +21,9 @@ import type NPC from "game/entity/npc/NPC";
 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 { IIslandTemplate } from "game/IGame";
 import type { Quality } from "game/IObject";
+import type { Automation } from "game/island/automation/Automation";
 import type Island from "game/island/Island";
 import type { IContainer, ItemType } from "game/item/IItem";
 import type Item from "game/item/Item";
@@ -226,6 +228,7 @@ export interface IActionDescription<A extends Array<ActionArgument | ActionArgum
      * Check if the action has setup CanUse logic
      */
     readonly hasSetCanUse: boolean;
+    getExample(executor: E, ...args: AV): IActionExample | undefined;
     canUse(executor: E, ...args: AV): CU | IActionNotUsable;
     /**
      * Called internally during `execute`
@@ -243,6 +246,10 @@ export interface IActionDescription<A extends Array<ActionArgument | ActionArgum
      * Called internally during `execute`
      */
     confirmer?(actionApi: IActionConfirmerApi<E, CU>, ...args: AV): Promise<boolean>;
+    /**
+     * Called internally before `execute`
+     */
+    exampleHandler?(actionApi: IActionExampleApi<E, CU>, ...args: AV): IActionExample;
     skipConfirmation(): this;
     clone(): IActionDescription<A, E, R, CU, AV>;
 }
@@ -317,6 +324,13 @@ export interface IActionConfirmerApi<E extends Entity = Entity, CU extends IActi
      */
     prompt<PROMPT extends IPromptDescriptionBase<any[]>>(prompt: PROMPT, ...args: PromptDescriptionArgs<PROMPT>): Promise<boolean>;
 }
+export interface IActionExampleApi<E extends Entity = Entity, CU extends IActionUsable = IActionUsable> extends IActionApi<E, CU> {
+    description: IActionDescription<Array<ActionArgument | ActionArgument[]>, E, any, CU, any[]>;
+}
+export interface IActionExample {
+    automation: Automation;
+    template: IIslandTemplate;
+}
 export interface IActionSoundEffect {
     type: SfxType;
     inFront?: boolean;
@@ -446,4 +460,5 @@ export interface ActionExecutorEvents {
      */
     postExecuteAction<A extends Array<ActionArgument | ActionArgument[]> = Array<ActionArgument | ActionArgument[]>, E extends Entity = Entity, AV extends any[] = ActionArgumentTupleTypes<A>, CU extends IActionUsable = any>(actionType: ActionType, actionApi: IActionHandlerApi<E, CU>, args: AV): any;
 }
+export declare const defaultExampleIslandTemplate: IIslandTemplate;
 export {};

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

@@ -8,5 +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
  */
-declare const _default: import("../Action").Action<[import("../IAction").ActionArgument.ItemNearby], import("../../Human").default<number>, void, import("game/entity/action/actions/ConsumeItem").IConsumeItemCanUse, [import("../../../item/Item").default]>;
+declare const _default: import("../Action").Action<[import("game/entity/action/IAction").ActionArgument.ItemNearby], import("../../Human").default<number>, void, import("game/entity/action/actions/ConsumeItem").IConsumeItemCanUse, [import("../../../item/Item").default]>;
 export default _default;

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

@@ -8,5 +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
  */
-declare const _default: import("../Action").Action<[[import("../IAction").ActionArgument.ItemInventory, import("../IAction").ActionArgument.Undefined], [import("../IAction").ActionArgument.AttackType, import("../IAction").ActionArgument.Undefined], [import("../IAction").ActionArgument.ItemInventory, import("../IAction").ActionArgument.Undefined]], import("../../Human").default<number>, void, import("game/entity/action/actions/Attack").IAttackCanUse, [(import("../../../item/Item").default | undefined)?, (import("../../IEntity").AttackType | undefined)?, (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("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<number>, void, import("game/entity/action/actions/Attack").IAttackCanUse, [(import("../../../item/Item").default | undefined)?, (import("../../IEntity").AttackType | undefined)?, (import("../../../item/Item").default | undefined)?]>;
 export default _default;

package/definitions/game/game/entity/npc/NPCManager.d.ts

@@ -42,7 +42,7 @@ export default class NPCManager extends EntityManager<NPC> {
     load(): void;
     spawn(npcType: NPCType, tile: Tile, options?: INPCCanCreateOptions): NPC | undefined;
     remove(npc: NPC): void;
-    addPlayerLike(npc: NPC): void;
+    addPlayerLike(npc: NPC, addToIsland?: boolean): void;
     removePlayerLike(npc: NPC): void;
     updateAll(): void;
     /**

package/definitions/game/game/inspection/inspections/RecipeInspection.d.ts

@@ -11,6 +11,7 @@
 import { InspectType } from "game/inspection/IInspection";
 import { InfoProvider } from "game/inspection/InfoProvider";
 import type { InfoProviderContext } from "game/inspection/InfoProviderContext";
+import LabelledValue from "game/inspection/infoProviders/LabelledValue";
 import Inspection from "game/inspection/Inspection";
 import { ItemType } from "game/item/IItem";
 import type { TranslationGenerator } from "ui/component/IComponent";
@@ -22,7 +23,7 @@ export default class RecipeInspection extends Inspection<ItemType> {
     get(context: InfoProviderContext): ArrayOr<TranslationGenerator | InfoProvider>;
     private getDetails;
     private isUnskilled;
-    private getReputation;
+    protected getReputation(): LabelledValue | undefined;
     private getDescription;
     private getDoodadUses;
     private getRequirements;

package/definitions/game/game/inspection/inspections/SkillInspection.d.ts

@@ -25,6 +25,6 @@ export default class SkillInspection extends Inspection<SkillType> {
     get(context: InfoProviderContext): ArrayOr<TranslationGenerator | InfoProvider>;
     private getCurrentValue;
     private getDescription;
-    private getReputationImpact;
+    protected getReputationImpact(): 0 | import("../../../language/impl/TranslationImpl").default | undefined;
     private getCanIncrease;
 }

package/definitions/game/game/tile/events/Fire.d.ts

@@ -9,5 +9,9 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type { ITileEventDescription } from "game/tile/ITileEvent";
-declare const fire: ITileEventDescription;
+import type TileEvent from "game/tile/TileEvent";
+interface IFireDescription extends ITileEventDescription {
+    spread(tileEvent: TileEvent): void;
+}
+declare const fire: IFireDescription;
 export default fire;

package/definitions/game/ui/screen/screens/GameScreen.d.ts

@@ -138,4 +138,5 @@ export default class GameScreen extends Screen {
      */
     private getUnusedQuadrant;
     private updatePauseIcon;
+    private get canUnpause();
 }

package/definitions/game/ui/screen/screens/game/component/Dialog.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
  */
-import type { Events, IEventEmitter } from "event/EventEmitter";
+import { type Events, type IEventEmitter } from "event/EventEmitter";
 import type { IIcon } from "game/inspection/InfoProvider";
 import UiTranslation from "language/dictionary/UiTranslation";
 import type { ISerializedTranslation } from "language/ITranslation";
@@ -123,8 +123,8 @@ declare abstract class Dialog extends Component implements IDialog {
     private _footer?;
     private readonly handles;
     private readonly panels;
-    private currentPanel;
-    private lastPanel;
+    private currentPanel?;
+    private lastPanel?;
     private cachedSnapPositions?;
     private readonly activeReasons;
     protected readonly scrollableHandler: void;
@@ -158,7 +158,7 @@ declare abstract class Dialog extends Component implements IDialog {
     close(): Promise<boolean>;
     protected onRemove1(): void;
     addPanel(id: string | number): Component<HTMLElement>;
-    showPanel(id: string | number): Component<HTMLElement> | undefined;
+    showPanel(id: string | number, disableAnimations?: boolean): Component<HTMLElement> | undefined;
     getPanel(id: string | number): Component<HTMLElement> | undefined;
     isPanelVisible(id: string | number): boolean;
     /**

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

@@ -29,6 +29,7 @@ export default abstract class TabDialog<T extends TabDialogPanel = TabDialogPane
     protected activePanel: T | undefined;
     protected storePanels: boolean;
     constructor(id: DialogId, subId?: string, initializeSubpanels?: boolean);
+    protected onLoad(): void;
     /**
      * Implements the abstract method in "TabDialog". Returns an array of subpanels.
      * This will only be called once
@@ -44,7 +45,7 @@ export default abstract class TabDialog<T extends TabDialogPanel = TabDialogPane
      */
     protected abstract getSubpanelInformation(subpanels: T[]): SubpanelInformation[];
     protected initializeSubpanels(): void;
-    protected getDefaultSubpanelInformation(): SubpanelInformation;
+    protected getDefaultSubpanelInformation(): SubpanelInformation | undefined;
     /**
      * Returns a function that will be executed when the passed subpanel is shown.
      *

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

@@ -25,8 +25,9 @@ export default class QuestDialog extends Dialog {
     constructor();
     getBindable(): Bindable;
     getIcon(): MenuBarButtonType;
+    protected onDialogLoad(): void;
     protected onDialogRemove(): void;
-    showQuest(id: number): this;
+    showQuest(id: number, disableAnimations?: boolean): this;
     protected onSwitchPanel(panelId: string | number): void;
     private onQuestOrRequirementComplete;
     private refreshFooter;

package/package.json

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