@wayward/types 2.13.2-beta.dev.20230527.1 → 2.13.2-beta.dev.20230528.1

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

@@ -33,4 +33,5 @@ export default class ActionInspection extends Inspection<ActionId | undefined> {
     private getActionDiscovered;
     private getActionTier;
     private getActionUsability;
+    private getActionExample;
 }

package/definitions/game/game/island/IIsland.d.ts

@@ -112,6 +112,7 @@ export interface IIslandLoadOptions {
      * Set to true when the island load is happening for everyone eveywhere all at once
      */
     isSynced: boolean;
+    isTransient?: boolean;
     travelTime?: number;
     pauseAndShowLoadingScreen?: boolean;
     multiplayerLoadingDescription?: MultiplayerLoadingDescription;
@@ -169,6 +170,7 @@ export declare enum LiquidType {
 export declare const ISLAND_NAME_MAX_LENGTH = 32;
 export declare const DEFAULT_ISLAND_ID = "0,0";
 export declare const DEFAULT_ISLAND_MAP_SIZE = 512;
+export declare const GENERIC_TRANSIENT_ISLAND_ID_START: IslandId;
 export declare const TRAVEL_ANIMATION_ISLAND_ID: IslandId;
 export interface IIslandPort {
     id: number;
@@ -189,3 +191,14 @@ export interface IMobCheck extends IVector3 {
     waterTiles?: number;
     voidTiles?: number;
 }
+/**
+ * Allows choosing what to copy from the human.
+ * All options default to true
+ */
+export interface ICopyHumanOptions {
+    human: Human;
+    copyCustomizations?: false;
+    copyItemsAndEquipment?: false;
+    copyStats?: false;
+    copyStatus?: false;
+}

package/definitions/game/game/island/Island.d.ts

@@ -134,6 +134,7 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
      */
     get isActive(): boolean;
     get isDefaultIsland(): boolean;
+    get isTransient(): boolean;
     getDetails(): IIslandDetails;
     /**
      * Activates the island.

package/definitions/game/game/island/TransientIsland.d.ts

@@ -9,7 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type Human from "game/entity/Human";
-import type { IIslandLoadOptions, IslandId } from "game/island/IIsland";
+import { type ICopyHumanOptions, type IIslandLoadOptions, type IslandId } from "game/island/IIsland";
 import type Island from "game/island/Island";
 import type { Direction } from "utilities/math/Direction";
 import type { IVector3 } from "utilities/math/IVector";
@@ -18,7 +18,8 @@ import type { IVector3 } from "utilities/math/IVector";
  */
 export declare class TransientIsland {
     readonly island: Island;
-    static create(islandId: IslandId, islandOptions?: Partial<IIslandLoadOptions>): Promise<TransientIsland>;
+    static createIslandId(): IslandId;
+    static create(islandId?: IslandId, islandOptions?: Partial<IIslandLoadOptions>): Promise<TransientIsland>;
     private deleted;
     private constructor();
     delete(): void;
@@ -26,8 +27,8 @@ export declare class TransientIsland {
      * Creates a human you can do stuff with
      * @param spawnPoint Spawn point. Set to undefined to use the default island spawn point
      * @param facingDirection Direction they should face when spawing
-     * @param copyFromHuman Human object to copy customizations, items, and vehicles from
+     * @param copyFromHumanOptions Human object to copy customizations, items, and vehicles from
      * @returns Human
      */
-    createHuman(spawnPoint?: IVector3, facingDirection?: Direction.Cardinal, copyFromHuman?: Human): Human;
+    createHuman(spawnPoint?: IVector3, facingDirection?: Direction.Cardinal, copyFromHumanOptions?: ICopyHumanOptions): Human;
 }

package/definitions/game/game/island/automation/Automation.d.ts

@@ -0,0 +1,28 @@
+/*!
+ * Copyright 2011-2023 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 Human from "game/entity/Human";
+import type { AutomationStep } from "game/island/automation/AutomationStep";
+import type { IAutomationInitialState } from "game/island/automation/IAutomation";
+export declare class Automation {
+    private running;
+    private repeat;
+    private repeatDelay;
+    private initialState;
+    private readonly steps;
+    private readonly resetSteps;
+    setRepeat(repeat: boolean, delay?: number): this;
+    setInitialState(initialState: IAutomationInitialState): this;
+    addStep(step: AutomationStep): this;
+    start(human: Human): Promise<void>;
+    stop(): void;
+    private execute;
+    private reset;
+}

package/definitions/game/game/island/automation/AutomationStep.d.ts

@@ -0,0 +1,14 @@
+/*!
+ * Copyright 2011-2023 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 { IAutomationContextState } from "game/island/automation/IAutomation";
+export declare abstract class AutomationStep {
+    abstract execute(context: IAutomationContextState): Promise<void>;
+}

package/definitions/game/game/island/automation/IAutomation.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * Copyright 2011-2023 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 Human from "game/entity/Human";
+import type { IslandId } from "game/island/IIsland";
+import type { ItemType, ItemTypeGroup } from "game/item/IItem";
+import type Item from "game/item/Item";
+export interface IAutomationInitialState {
+    items?: Array<ItemType | ItemTypeGroup>;
+    /**
+     * Delay before executing steps
+     */
+    delay?: number;
+}
+export interface IAutomationContextState {
+    human: Human;
+    islandId: IslandId;
+    /**
+     * Items created via initial state
+     */
+    items: Item[];
+}

package/definitions/game/game/island/automation/steps/ExecuteAction.d.ts

@@ -0,0 +1,20 @@
+/*!
+ * Copyright 2011-2023 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 { ActionArguments, AnyActionDescription } from "game/entity/action/IAction";
+import { AutomationStep } from "game/island/automation/AutomationStep";
+import type { IAutomationContextState } from "game/island/automation/IAutomation";
+export type GetActionArguments<T extends AnyActionDescription, AV = ActionArguments<T>> = AV | ((context: IAutomationContextState) => Promise<AV>);
+export declare class ExecuteActionStep<T extends AnyActionDescription> extends AutomationStep {
+    private readonly action;
+    private readonly args;
+    constructor(action: T, args: GetActionArguments<T>);
+    execute(context: IAutomationContextState): Promise<void>;
+}

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

@@ -344,6 +344,10 @@ export interface IItemBuild {
      * When defined, allows the build to work only on these tile types
      */
     allowedTileTypes?: Set<TerrainType>;
+    /**
+     * Skill to gain 0.1 of when building the item
+     */
+    skillGain?: SkillType;
 }
 export interface ISummon {
     /**

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

@@ -105,24 +105,25 @@ export declare enum ModRegistrationType {
     NPC = 32,
     OptionsSection = 33,
     Overlay = 34,
-    Packet = 35,
-    Prompt = 36,
-    QuadrantComponent = 37,
-    Quest = 38,
-    QuestRequirement = 39,
-    Registry = 40,
-    Skill = 41,
-    SoundEffect = 42,
-    Stat = 43,
-    StatusEffect = 44,
-    Terrain = 45,
-    TerrainDecoration = 46,
-    TileEvent = 47,
-    TileLayerType = 48,
-    UsableActions = 49,
-    UsableActionType = 50,
-    UsableActionTypePlaceholder = 51,
-    WorldLayer = 52
+    Override = 35,
+    Packet = 36,
+    Prompt = 37,
+    QuadrantComponent = 38,
+    Quest = 39,
+    QuestRequirement = 40,
+    Registry = 41,
+    Skill = 42,
+    SoundEffect = 43,
+    Stat = 44,
+    StatusEffect = 45,
+    Terrain = 46,
+    TerrainDecoration = 47,
+    TileEvent = 48,
+    TileLayerType = 49,
+    UsableActions = 50,
+    UsableActionType = 51,
+    UsableActionTypePlaceholder = 52,
+    WorldLayer = 53
 }
 export interface ILanguageRegistration extends IBaseModRegistration {
     type: ModRegistrationType.Language;
@@ -375,10 +376,19 @@ export interface IEntityTagRegistration extends IBaseModRegistration {
     type: ModRegistrationType.EntityTag;
     name: string;
 }
+export interface IOverrideDescription<OBJECT extends object, PROPERTY extends keyof OBJECT> {
+    object: OBJECT;
+    property: PROPERTY;
+    value: OBJECT[PROPERTY];
+}
+export interface IOverrideRegistration<OBJECT extends object, PROPERTY extends keyof OBJECT> extends IBaseModRegistration {
+    type: ModRegistrationType.Override;
+    overrider: () => IOverrideDescription<OBJECT, PROPERTY>;
+}
 export interface IInheritsRegistrationTime {
     useRegistrationTime: ModRegistrationType;
 }
-export type ModRegistration = IActionRegistration | IBindableRegistration | IBiomeRegistration | IBulkRegistration | ICommandRegistration | ICreatureRegistration | IDialogRegistration | IDictionaryRegistration | IDoodadGroupRegistration | IDoodadRegistration | IDoodadTagRegistration | IEntityTagRegistration | IHelpArticleRegistration | IInspectionTypeRegistration | IInterModRegistration | IInterModRegistryRegistration | IInterruptChoiceRegistration | IInterruptRegistration | IItemGroupRegistration | IItemRegistration | IItemTagRegistration | ILanguageExtensionRegistration | ILanguageRegistration | ILoadRegistration | IMagicalPropertyRegistration | IMenuBarButtonRegistration | IMessageRegistration | IMessageSourceRegistration | IMusicTrackRegistration | INoteRegistration | INPCRegistration | IOptionsSectionRegistration | IOverlayRegistration | IPacketRegistration | IPromptRegistration | IQuadrantComponentRegistration | IQuestRegistration | IQuestRequirementRegistration | IRegistryRegistration | ISkillRegistration | ISoundEffectRegistration | IStatRegistration | IStatusEffectRegistration | ITerrainDecorationRegistration | ITerrainRegistration | ITileEventRegistration | ITileLayerTypeRegistration | IUsableActionsRegistration | IUsableActionTypePlaceholderRegistration | IUsableActionTypeRegistration;
+export type ModRegistration = IActionRegistration | IBindableRegistration | IBiomeRegistration | IBulkRegistration | ICommandRegistration | ICreatureRegistration | IDialogRegistration | IDictionaryRegistration | IDoodadGroupRegistration | IDoodadRegistration | IDoodadTagRegistration | IEntityTagRegistration | IHelpArticleRegistration | IInspectionTypeRegistration | IInterModRegistration | IInterModRegistryRegistration | IInterruptChoiceRegistration | IInterruptRegistration | IItemGroupRegistration | IItemRegistration | IItemTagRegistration | ILanguageExtensionRegistration | ILanguageRegistration | ILoadRegistration | IMagicalPropertyRegistration | IMenuBarButtonRegistration | IMessageRegistration | IMessageSourceRegistration | IMusicTrackRegistration | INoteRegistration | INPCRegistration | IOptionsSectionRegistration | IOverlayRegistration | IOverrideRegistration<any, any> | IPacketRegistration | IPromptRegistration | IQuadrantComponentRegistration | IQuestRegistration | IQuestRequirementRegistration | IRegistryRegistration | ISkillRegistration | ISoundEffectRegistration | IStatRegistration | IStatusEffectRegistration | ITerrainDecorationRegistration | ITerrainRegistration | ITileEventRegistration | ITileLayerTypeRegistration | IUsableActionsRegistration | IUsableActionTypePlaceholderRegistration | IUsableActionTypeRegistration;
 export declare const SYMBOL_SUPER_REGISTRY: unique symbol;
 declare module Register {
     /**
@@ -695,6 +705,23 @@ declare module Register {
     export function usableActionTypePlaceholder(name: string): <K extends string | number | symbol, T extends Record<K, UsableActionType>>(target: T, key: K) => void;
     export function interModRegistry<V>(name: string): <K extends string | number | symbol, T extends Record<K, InterModRegistry<V>>>(target: T, key: K) => void;
     export function interModRegistration<V>(modName: string, registryName: string, value: V): <K extends string | number | symbol, T extends Record<K, InterModRegistration<V>>>(target: T, key: K) => void;
+    /**
+     * Register custom values that will replace default values in a vanilla object.
+     *
+     * For example, say you want to change the number of planks to dismantle from a log from 2 to 4. That would look like this:
+     * ```ts
+     * @Register.override(() => ({
+     * 	object: itemDescriptions[ItemType.Log].dismantle!,
+     * 	property: "items",
+     * 	value: [
+     * 		{ type: ItemType.TreeBark, amount: 2 },
+     * 		{ type: ItemType.WoodenPlank, amount: 4 }
+     * 	],
+     * }))
+     * public itemDescriptionLogDismantle: IDismantleDescription;
+     * ```
+     */
+    export function override<OBJECT extends object, PROPERTY extends keyof OBJECT>(overrider: () => IOverrideDescription<OBJECT, PROPERTY>): <K extends string | number | symbol, T extends Record<K, OBJECT>>(target: T, key: K) => void;
     type ExtractRegisteredType<F> = F extends (...args: any) => infer F2 ? F2 extends (t: infer T, k: infer K) => any ? T[Extract<K, keyof T>] : never : never;
     /**
      * Registers any number of registrations of a single type. Any other registration type can be used.

package/definitions/game/renderer/IRenderer.d.ts

@@ -63,61 +63,62 @@ export declare enum RenderSource {
     ActionsMenu = 1,
     AmbientLightLevelUpdate = 2,
     AttackAnimationStart = 3,
-    DoodadChangeType = 4,
-    FadeIn = 5,
-    FovTransition = 6,
-    FovUpdate = 7,
-    FovUpdateRadius = 8,
-    GameAnimating = 9,
-    GamePassTurn = 10,
-    GameResumed = 11,
-    GameTick = 12,
-    GenericOverlay = 13,
-    HiddenMob = 14,
-    HumanRest = 15,
-    HumanRestStart = 16,
-    HumanRestStop = 17,
-    HumanSetPosition = 18,
-    HumanVehicle = 19,
-    InspectOverlay = 20,
-    IslandLoad = 21,
-    IslandTravel = 22,
-    ItemEquip = 23,
-    ItemEquipEffect = 24,
-    ItemMovement = 25,
-    ItemUnequip = 26,
-    Mod = 27,
-    MovementPlayerPost = 28,
-    MovementPlayerZPost = 29,
-    MultiplayerDisconnect = 30,
-    Notifier = 31,
-    NotifierAddCreature = 32,
-    NotifierAddItem = 33,
-    NotifierAddNotifierIcon = 34,
-    NotifierAddStat = 35,
-    NotifierAddStatusType = 36,
-    OptionEquipment = 37,
-    OptionVisionMode = 38,
-    OptionZoomLevel = 39,
-    Particles = 40,
-    PlayerAdd = 41,
-    PlayerKill = 42,
-    PlayerNoclip = 43,
-    PlayerProcessMovement = 44,
-    PlayerReady = 45,
-    PlayerRemove = 46,
-    PlayerRespawn = 47,
-    PlayerWalkToTilePath = 48,
-    PlayerWalkToTilePathOverburdened = 49,
-    PlayerWalkToTilePathPreview = 50,
-    PlayerWalkToTilePathReset = 51,
-    Resize = 52,
-    SetupGl = 53,
-    SpawnAnimationStart = 54,
-    StartGame = 55,
-    Steamworks = 56,
-    Thumbnail = 57,
-    WorldLayerRendererFlush = 58
+    Automation = 4,
+    DoodadChangeType = 5,
+    FadeIn = 6,
+    FovTransition = 7,
+    FovUpdate = 8,
+    FovUpdateRadius = 9,
+    GameAnimating = 10,
+    GamePassTurn = 11,
+    GameResumed = 12,
+    GameTick = 13,
+    GenericOverlay = 14,
+    HiddenMob = 15,
+    HumanRest = 16,
+    HumanRestStart = 17,
+    HumanRestStop = 18,
+    HumanSetPosition = 19,
+    HumanVehicle = 20,
+    InspectOverlay = 21,
+    IslandLoad = 22,
+    IslandTravel = 23,
+    ItemEquip = 24,
+    ItemEquipEffect = 25,
+    ItemMovement = 26,
+    ItemUnequip = 27,
+    Mod = 28,
+    MovementPlayerPost = 29,
+    MovementPlayerZPost = 30,
+    MultiplayerDisconnect = 31,
+    Notifier = 32,
+    NotifierAddCreature = 33,
+    NotifierAddItem = 34,
+    NotifierAddNotifierIcon = 35,
+    NotifierAddStat = 36,
+    NotifierAddStatusType = 37,
+    OptionEquipment = 38,
+    OptionVisionMode = 39,
+    OptionZoomLevel = 40,
+    Particles = 41,
+    PlayerAdd = 42,
+    PlayerKill = 43,
+    PlayerNoclip = 44,
+    PlayerProcessMovement = 45,
+    PlayerReady = 46,
+    PlayerRemove = 47,
+    PlayerRespawn = 48,
+    PlayerWalkToTilePath = 49,
+    PlayerWalkToTilePathOverburdened = 50,
+    PlayerWalkToTilePathPreview = 51,
+    PlayerWalkToTilePathReset = 52,
+    Resize = 53,
+    SetupGl = 54,
+    SpawnAnimationStart = 55,
+    StartGame = 56,
+    Steamworks = 57,
+    Thumbnail = 58,
+    WorldLayerRendererFlush = 59
 }
 export declare function calculateAmbientLightLevel(origin: IFieldOfViewOrigin, z: number): number;
 export declare const ZOOM_LEVEL_MIN = 1;

package/definitions/game/renderer/exploreMap/ByteGrid.d.ts

@@ -14,7 +14,7 @@ export default class ByteGrid implements IByteGrid {
     readonly height: number;
     readonly size: number;
     readonly data: Uint8Array;
-    constructor(width: number, height?: number);
+    constructor(width: number, height: number);
     get(x: number, y: number): number;
     set(x: number, y: number, value: number): void;
     rawSet(i: number, value: number): void;

package/definitions/game/ui/component/TransientIslandComponent.d.ts

@@ -0,0 +1,29 @@
+/*!
+ * Copyright 2011-2023 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 { IIslandTemplate } from "game/IGame";
+import type { Automation } from "game/island/automation/Automation";
+import Component from "ui/component/Component";
+export default class TransientIslandComponent extends Component {
+    private readonly template;
+    private readonly automation?;
+    private canvas?;
+    private renderer?;
+    private transientIsland?;
+    private transientHuman?;
+    private readonly zoomLevel;
+    constructor(template: IIslandTemplate, automation?: Automation | undefined);
+    protected onAppend(): void;
+    protected onDispose(): void;
+    initialize(template: IIslandTemplate): Promise<void>;
+    private createViewport;
+    private resize;
+    private rerender;
+}

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

@@ -12,7 +12,7 @@ import type { Source } from "game/entity/player/IMessageManager";
 import { ThreeStateButtonState } from "ui/component/IThreeStateButton";
 export declare const DEFAULT_MAX_MESSAGES = 15;
 export declare const MESSAGES_MAX_PINNED = 3;
-export type IFilters = Record<string, IFilter>;
+export type IFilters = PartialRecord<string, IFilter>;
 export type IFilter = {
     -readonly [K in keyof typeof Source]?: ThreeStateButtonState;
 };

package/package.json

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