@wayward/types 2.11.1-beta.dev.20211228.1 → 2.11.1-beta.dev.20211229.1

package/definitions/game/IGlobal.d.ts

@@ -61,7 +61,6 @@ declare global {
     let saveManager: SaveManager;
     let steamworks: Steamworks;
     let ui: Ui;
-    const gc: ((options?: any) => Promise<void> | void) | undefined;
     const gameVersion: string;
     const gameVersionStage: string;
     const gameVersionMajor: number;

package/definitions/game/game/doodad/DoodadManager.d.ts

@@ -39,10 +39,10 @@ export interface IDoodadManagerEvents {
     remove(doodad: Doodad): any;
 }
 export default class DoodadManager extends ObjectManager<Doodad, IDoodadManagerEvents> {
-    private readonly scarecrows;
     private static cachedBestDoodadForTier;
     private static cachedGroups;
     private static cachedDoodadSpawns;
+    private readonly scarecrows;
     static getBestDoodadForTier(doodad: DoodadType | DoodadTypeGroup): DoodadType | undefined;
     static generateLookups(): void;
     static isGroup(doodadType: DoodadType | DoodadTypeGroup): doodadType is DoodadTypeGroup;
@@ -50,7 +50,10 @@ export default class DoodadManager extends ObjectManager<Doodad, IDoodadManagerE
     static getGroupDoodads(doodadGroup: DoodadTypeGroup): Set<DoodadType>;
     static getDoodadTypeGroupName(doodadType: DoodadType | DoodadTypeGroup, article?: boolean, count?: number): Translation;
     delete(): void;
-    load(): void;
+    /**
+     * Note: This can be called multiple times in the same game depending on loading/unloading of islands
+     */
+    load(hasLoadedBefore: boolean): void;
     isGroup(doodadType: DoodadType | DoodadTypeGroup): doodadType is DoodadTypeGroup;
     isInGroup(doodadType: DoodadType, doodadGroup: DoodadTypeGroup | DoodadType): boolean;
     getBestDoodadForTier(doodad: DoodadType | DoodadTypeGroup): DoodadType | undefined;

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

@@ -106,6 +106,7 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
     get id(): `${number},${number}`;
     get biome(): import("game/biome/IBiome").IBiomeDescription;
     get isLoaded(): boolean;
+    get hasLoadedItemReferences(): boolean;
     get isLocalIsland(): boolean;
     get world(): World;
     /**

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

@@ -279,10 +279,13 @@ export interface IMoveToTileOptions {
     fromPoint?: IVector3;
     toPoint: IVector3;
     toContainer?: IContainer;
+    beforeMovement?: IMoveToTileBeforeMovementOptions;
     afterMovement?: IMoveToTileAfterMovementOptions;
 }
-export interface IMoveToTileAfterMovementOptions {
+export interface IMoveToTileBeforeMovementOptions {
     remove?: boolean;
+}
+export interface IMoveToTileAfterMovementOptions {
     soundEffect?: SfxType;
     particles?: IRGB;
 }

package/definitions/game/multiplayer/IMultiplayer.d.ts

@@ -28,11 +28,11 @@ export interface IMultiplayerEvents {
     checkConnection(webRtcWorks: boolean, webSocketWorks: boolean): any;
 }
 export declare enum MultiplayerSyncCheckLevel {
-    None = 0,
-    Normal = 1,
-    Extended = 2,
-    Verbose = 3,
-    All = 4
+    None = "none",
+    Normal = "normal",
+    Extended = "extended",
+    Verbose = "verbose",
+    All = "all"
 }
 export declare enum MultiplayerSyncCheck {
     Action = 0,

package/definitions/game/multiplayer/Multiplayer.d.ts

@@ -12,7 +12,7 @@ import EventEmitter from "event/EventEmitter";
 import Player from "game/entity/player/Player";
 import type Island from "game/island/Island";
 import type { IJoinServerOptions, IMultiplayerEvents, IMultiplayerOptions, PacketTarget, ServerInfo } from "multiplayer/IMultiplayer";
-import { DisconnectReason, JoinServerRetryReason, MultiplayerSyncCheck, UnableToJoinReason } from "multiplayer/IMultiplayer";
+import { DisconnectReason, JoinServerRetryReason, MultiplayerSyncCheck, UnableToJoinReason, MultiplayerSyncCheckLevel } from "multiplayer/IMultiplayer";
 import type { IMatchmakingInfo } from "multiplayer/matchmaking/IMatchmaking";
 import type { IConnection } from "multiplayer/networking/IConnection";
 import type { IPacket } from "multiplayer/packets/IPacket";
@@ -65,6 +65,13 @@ export default class Multiplayer extends EventEmitter.Host<IMultiplayerEvents> {
     getOptions(): IMultiplayerOptions;
     setOptions(options: IMultiplayerOptions, updateGame?: boolean): void;
     updateOptions(updates: Partial<IMultiplayerOptions>): void;
+    /**
+     * Helper method for updating sync checks
+     * multiplayer.updateSyncChecks("normal")
+     * multiplayer.updateSyncChecks("verbose")
+     */
+    updateSyncChecks(syncChecks: boolean | MultiplayerSyncCheckLevel | MultiplayerSyncCheck[]): void;
+    private parseSyncChecks;
     enableSteamNetworkConnections(enable: boolean): void;
     getConnectedMatchmakingInfo(): IMatchmakingInfo | undefined;
     /**

package/definitions/game/multiplayer/packets/Packet.d.ts

@@ -15,7 +15,7 @@ import type { IPacket, ISynchronizationCheckData } from "multiplayer/packets/IPa
 export declare abstract class Packet<T = void> extends IndexedPacket implements IPacket<T> {
     protected synchronizationCheckData: ISynchronizationCheckData;
     private _arrayBuffer;
-    getDebugInfo(): string;
+    abstract getDebugInfo(): string;
     getAllowedStates(): ConnectionState;
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;

package/definitions/game/multiplayer/packets/client/AddPlayerPacket.d.ts

@@ -12,5 +12,6 @@ import type { IPlayerOptions } from "game/IGame";
 import ClientPacket from "multiplayer/packets/ClientPacket";
 export default class AddPlayerPacket extends ClientPacket<number> {
     playerOptions: IPlayerOptions;
+    getDebugInfo(): string;
     process(): number;
 }

package/definitions/game/multiplayer/packets/client/CaughtUpPacket.d.ts

@@ -14,5 +14,6 @@ import ClientPacket from "multiplayer/packets/ClientPacket";
  * Tell the server to mark us as ready
  */
 export default class CaughtUpPacket extends ClientPacket {
+    getDebugInfo(): string;
     process(): void;
 }

package/definitions/game/multiplayer/packets/client/ClearSyncPacketWaitingPacket.d.ts

@@ -11,6 +11,7 @@
 import ClientPacket from "multiplayer/packets/ClientPacket";
 export default class ClearSyncPacketWaitingPacket extends ClientPacket {
     waitId: string;
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/multiplayer/packets/client/DisplayInterruptPacket.d.ts

@@ -14,5 +14,6 @@ export default class DisplayInterruptPacket extends ClientPacket {
     prompt: Prompt;
     args: any[];
     extraData: any;
+    getDebugInfo(): string;
     process(): Promise<void>;
 }

package/definitions/game/multiplayer/packets/client/EmitPlayerEventPacket.d.ts

@@ -15,5 +15,6 @@ export declare enum EmitPlayerEventType {
 }
 export default class EmitPlayerEventPacket extends PlayerTargetedClientPacket {
     type: EmitPlayerEventType;
+    getDebugInfo(): string;
     process(): void;
 }

package/definitions/game/multiplayer/packets/client/HideLoadingScreenPacket.d.ts

@@ -12,6 +12,7 @@ import type { Load } from "game/meta/Loading";
 import ClientPacket from "multiplayer/packets/ClientPacket";
 export default class HideLoadingScreenPacket extends ClientPacket {
     load: Load;
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     process(): void;
 }

package/definitions/game/multiplayer/packets/client/LoadIslandPacket.d.ts

@@ -12,6 +12,7 @@ import type { IslandId } from "game/island/IIsland";
 import ClientPacket from "multiplayer/packets/ClientPacket";
 export default class LoadIslandPacket extends ClientPacket<Promise<void>> {
     islandId: IslandId;
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     process(): Promise<void>;
 }

package/definitions/game/multiplayer/packets/client/PausePacket.d.ts

@@ -12,5 +12,6 @@ import ClientPacket from "multiplayer/packets/ClientPacket";
 export default class PausePacket extends ClientPacket {
     paused: boolean;
     showChatMessage: boolean;
+    getDebugInfo(): string;
     process(): void;
 }

package/definitions/game/multiplayer/packets/client/PongPacket.d.ts

@@ -11,5 +11,6 @@
 import ClientPacket from "multiplayer/packets/ClientPacket";
 export default class PongPacket extends ClientPacket {
     sendTime: number;
+    getDebugInfo(): string;
     process(): void;
 }

package/definitions/game/multiplayer/packets/client/ReadyPlayerPacket.d.ts

@@ -10,5 +10,6 @@
  */
 import PlayerTargetedClientPacket from "multiplayer/packets/PlayerTargetedClientPacket";
 export default class ReadyPlayerPacket extends PlayerTargetedClientPacket {
+    getDebugInfo(): string;
     process(): void;
 }

package/definitions/game/multiplayer/packets/client/RemovePlayerPacket.d.ts

@@ -12,5 +12,6 @@ import { DisconnectReason } from "multiplayer/IMultiplayer";
 import PlayerTargetedClientPacket from "multiplayer/packets/PlayerTargetedClientPacket";
 export default class RemovePlayerPacket extends PlayerTargetedClientPacket {
     reason: DisconnectReason;
+    getDebugInfo(): string;
     process(): void;
 }

package/definitions/game/multiplayer/packets/client/SendMessagePacket.d.ts

@@ -15,5 +15,6 @@ export default class SendMessagePacket extends ClientPacket {
     source: Source;
     message: Message;
     args: any[];
+    getDebugInfo(): string;
     process(): Promise<void>;
 }

package/definitions/game/multiplayer/packets/client/SetPlayerZPacket.d.ts

@@ -11,5 +11,6 @@
 import PlayerTargetedClientPacket from "multiplayer/packets/PlayerTargetedClientPacket";
 export default class SetPlayerZPacket extends PlayerTargetedClientPacket {
     z: number;
+    getDebugInfo(): string;
     process(): void;
 }

package/definitions/game/multiplayer/packets/client/ShowLoadingScreenPacket.d.ts

@@ -14,6 +14,7 @@ import { ScreenId } from "ui/screen/IScreen";
 export default class ShowLoadingScreenPacket extends ClientPacket {
     load: Load;
     hideScreens?: ScreenId[];
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     process(): void;
 }

package/definitions/game/multiplayer/packets/client/SynchronizeGameStatePacket.d.ts

@@ -11,6 +11,7 @@
 import ClientPacket from "multiplayer/packets/ClientPacket";
 export default class SynchronizeGameStatePacket extends ClientPacket {
     serverGameState: Uint8Array;
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     process(): void;
     protected getInitialBufferSize(): number;

package/definitions/game/multiplayer/packets/client/SynchronizeStatesPacket.d.ts

@@ -12,5 +12,6 @@ import type { ISynchronizeState } from "game/IGame";
 import ClientPacket from "multiplayer/packets/ClientPacket";
 export default class SynchronizeStatesPacket extends ClientPacket {
     state: ISynchronizeState;
+    getDebugInfo(): string;
     process(): void;
 }

package/definitions/game/multiplayer/packets/client/WorldPacket.d.ts

@@ -13,6 +13,7 @@ import { ConnectionState } from "multiplayer/networking/IConnection";
 import ClientPacket from "multiplayer/packets/ClientPacket";
 export default class WorldPacket extends ClientPacket<Promise<void>> {
     data: IMultiplayerWorldData;
+    getDebugInfo(): string;
     getAllowedStates(): ConnectionState;
     process(): Promise<void>;
     protected getInitialBufferSize(): number;

package/definitions/game/multiplayer/packets/server/AddMessageHistoryPacket.d.ts

@@ -12,6 +12,7 @@ import type { IMessageHistoryItem } from "game/entity/player/IMessageManager";
 import PlayerTargetedServerPacket from "multiplayer/packets/PlayerTargetedServerPacket";
 export default class AddMessageHistoryPacket extends PlayerTargetedServerPacket {
     messageHistoryItem: IMessageHistoryItem;
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/multiplayer/packets/server/ConnectPacket.d.ts

@@ -13,6 +13,7 @@ import { ConnectionState } from "multiplayer/networking/IConnection";
 import ServerPacket from "multiplayer/packets/ServerPacket";
 export default class ConnectPacket extends ServerPacket {
     playerOptions: IPlayerOptions;
+    getDebugInfo(): string;
     getAllowedStates(): ConnectionState;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/multiplayer/packets/server/ConnectedPacket.d.ts

@@ -15,6 +15,7 @@ import ServerPacket from "multiplayer/packets/ServerPacket";
  * They probably still have packets to catch up on
  */
 export default class ConnectedPacket extends ServerPacket {
+    getDebugInfo(): string;
     getAllowedStates(): ConnectionState;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/multiplayer/packets/server/DesyncPacket.d.ts

@@ -14,6 +14,7 @@ import ServerPacket from "multiplayer/packets/ServerPacket";
  */
 export default class DesyncPacket extends ServerPacket {
     logs: string;
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/multiplayer/packets/server/KeepAlivePacket.d.ts

@@ -14,6 +14,7 @@ import ServerPacket from "multiplayer/packets/ServerPacket";
  * If the server hasn't received this message for 15 seconds, the player is disconnected
  */
 export default class KeepAlivePacket extends ServerPacket {
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/multiplayer/packets/server/LogsPacket.d.ts

@@ -12,6 +12,7 @@ import PlayerTargetedServerPacket from "multiplayer/packets/PlayerTargetedServer
 export default class LogsPacket extends PlayerTargetedServerPacket {
     logs: string;
     containsServerGameState: boolean | undefined;
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/multiplayer/packets/server/PingPacket.d.ts

@@ -11,6 +11,7 @@
 import ServerPacket from "multiplayer/packets/ServerPacket";
 export default class PingPacket extends ServerPacket {
     sendTime: number;
+    getDebugInfo(): string;
     isAllowedWhenPaused(): boolean;
     process(): void;
 }

package/definitions/game/multiplayer/packets/server/ReadyPacket.d.ts

@@ -15,6 +15,7 @@ import ServerPacket from "multiplayer/packets/ServerPacket";
  * We can now mark the player as ready
  */
 export default class ReadyPacket extends ServerPacket {
+    getDebugInfo(): string;
     getAllowedStates(): ConnectionState;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/multiplayer/packets/server/UiDataUpdatePacket.d.ts

@@ -13,5 +13,6 @@ import PlayerTargetedServerPacket from "multiplayer/packets/PlayerTargetedServer
 export default class UiDataUpdatePacket extends PlayerTargetedServerPacket {
     static create(player: Player, updates: Map<string | number, Record<string, any>>): UiDataUpdatePacket;
     updates: Map<string | number, Record<string, any>>;
+    getDebugInfo(): string;
     process(): void;
 }

package/definitions/game/multiplayer/packets/server/UpdateDialogInfoPacket.d.ts

@@ -13,6 +13,7 @@ import type { IDialogInfo } from "ui/old/IOldUi";
 export default class UpdateDialogInfoPacket extends PlayerTargetedServerPacket {
     index: string | number;
     info: IDialogInfo;
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/multiplayer/packets/server/UpdateQuickSlotInfoPacket.d.ts

@@ -13,6 +13,7 @@ import type { IQuickSlotInfo } from "ui/old/IOldUi";
 export default class UpdateQuickSlotInfoPacket extends PlayerTargetedServerPacket {
     quickSlot: number;
     quickSlotInfo: IQuickSlotInfo | undefined;
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/multiplayer/packets/shared/ChatMessagePacket.d.ts

@@ -11,6 +11,7 @@
 import PlayerTargetedSharedPacket from "multiplayer/packets/PlayerTargetedSharedPacket";
 export default class ChatMessagePacket extends PlayerTargetedSharedPacket {
     message: string;
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/multiplayer/packets/shared/DisconnectPacket.d.ts

@@ -12,6 +12,7 @@ import { DisconnectReason } from "multiplayer/IMultiplayer";
 import SharedPacket from "multiplayer/packets/SharedPacket";
 export default class DisconnectPacket extends SharedPacket {
     reason: DisconnectReason;
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/multiplayer/packets/shared/DiscoverRecipePacket.d.ts

@@ -14,6 +14,7 @@ export default class DiscoverRecipePacket extends PlayerTargetedSharedPacket {
     recipeType: ItemType;
     newUnlock: boolean;
     unlockTime: number;
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/multiplayer/packets/shared/MarkAsExploredPacket.d.ts

@@ -12,6 +12,7 @@ import PlayerTargetedSharedPacket from "multiplayer/packets/PlayerTargetedShared
 import type { IVector2 } from "utilities/math/IVector";
 export default class MarkAsExploredPacket extends PlayerTargetedSharedPacket {
     points: IVector2[];
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     process(): void;
 }

package/definitions/game/multiplayer/packets/shared/UpdateMovementIntentPacket.d.ts

@@ -12,6 +12,7 @@ import type { IMovementIntent } from "game/entity/player/IPlayer";
 import PlayerTargetedSharedPacket from "multiplayer/packets/PlayerTargetedSharedPacket";
 export default class UpdateMovementIntentPacket extends PlayerTargetedSharedPacket {
     intent: IMovementIntent;
+    getDebugInfo(): string;
     isAllowedWhenPaused(): boolean;
     process(): void;
 }

package/definitions/game/multiplayer/packets/shared/UpdateMultiplayerOptionsPacket.d.ts

@@ -12,6 +12,7 @@ import type { IMultiplayerOptions } from "multiplayer/IMultiplayer";
 import SharedPacket from "multiplayer/packets/SharedPacket";
 export default class UpdateMultiplayerOptionsPacket extends SharedPacket {
     options: IMultiplayerOptions;
+    getDebugInfo(): string;
     isAllowedWhenPaused(): boolean;
     process(): void;
 }

package/definitions/game/multiplayer/packets/shared/UpdateWalkPathPacket.d.ts

@@ -13,6 +13,7 @@ import type { IVector2 } from "utilities/math/IVector";
 export default class UpdateWalkPathPacket extends PlayerTargetedSharedPacket {
     path: IVector2[] | undefined;
     force: boolean | undefined;
+    getDebugInfo(): string;
     isSyncCheckEnabled(): boolean;
     isAllowedWhenPaused(): boolean;
     process(): void;

package/definitions/game/ui/component/dropdown/EnumDropdown.d.ts

@@ -9,6 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type Dictionary from "language/Dictionary";
+import type Button from "ui/component/Button";
 import type { IDropdownOption } from "ui/component/Dropdown";
 import Dropdown from "ui/component/Dropdown";
 export default class EnumDropdown<ENUM_OBJECT, OTHER_OPTIONS extends string | never = never, VALUES = ENUM_OBJECT[keyof ENUM_OBJECT]> extends Dropdown<VALUES | OTHER_OPTIONS> {
@@ -23,5 +24,5 @@ export default class EnumDropdown<ENUM_OBJECT, OTHER_OPTIONS extends string | ne
     setExcluded(...excluded: VALUES[]): this;
     protected getTranslation(id: VALUES): import("../../../language/impl/TranslationImpl").default;
     protected filterEnum?(id: VALUES): boolean;
-    private getOptions;
+    protected getOptions(enumObject: any): [VALUES, (option: Button) => Button][];
 }

package/definitions/game/ui/component/dropdown/PlayerDropdown.d.ts

@@ -8,9 +8,10 @@
  * 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 { IDropdownOption } from "ui/component/Dropdown";
-import EnumDropdown from "ui/component/dropdown/EnumDropdown";
-export default class PlayerDropdown<OTHER_OPTIONS extends string = never> extends EnumDropdown<Record<string, string>, OTHER_OPTIONS> {
-    constructor(defaultOption: string | OTHER_OPTIONS, options?: Iterable<IDropdownOption<OTHER_OPTIONS>>);
-    protected getTranslation(playerIdentifier: string): import("../../../language/impl/TranslationImpl").default;
+import type Button from "ui/component/Button";
+import Dropdown from "ui/component/Dropdown";
+export default class PlayerDropdown extends Dropdown<string> {
+    constructor(defaultOption: string);
+    get selectedPlayer(): import("../../../game/entity/player/Player").default | undefined;
+    protected getOptions(): [string, (option: Button) => Button][];
 }

package/definitions/hosts/shared/globals.d.ts

@@ -8,4 +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
  */
+export declare const gameVersionStage = "beta", gameVersionMajor = 2, gameVersionMinor = 11, gameVersionPatch = 1, gameVersionName = "Horizons";
+export declare const gameVersion: string;
 export declare function registerGlobals(globalObject: any): void;

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@wayward/types",
 	"description": "TypeScript declarations for Wayward, used for modding.",
-	"version": "2.11.1-beta.dev.20211228.1",
+	"version": "2.11.1-beta.dev.20211229.1",
 	"license": "MIT",
 	"repository": {
 		"type": "git",
@@ -17,6 +17,8 @@
 		"@wayward/goodstream": "0.7.1"
 	},
 	"devDependencies": {
-		"@wayward/game": "^1.0.0"
+		"@wayward/game": "^1.0.0",
+		"@types/node": "^17.0.5",
+		"@types/fs-extra": "^9.0.13"
 	}
 }