@wayward/types 2.13.0-beta.dev.20230408.1 → 2.13.0-beta.dev.20230409.2

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

@@ -8,11 +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 IAudio from "audio/IAudio";
 import { Music, SfxType } from "audio/IAudio";
 import EventEmitter from "event/EventEmitter";
-import type Island from "game/island/Island";
 import type EnumCursor from "utilities/enum/EnumCursor";
+import type { IVector4 } from "utilities/math/Vector4";
 export declare enum Fading {
     None = 0,
     In = 1,
@@ -21,20 +20,24 @@ export declare enum Fading {
 export interface IAudioEvents {
     init(): any;
     /**
-     * Called when a sound effect is queued
+     * Called when a ui sound effect is played
      * @param type The sound effect type
-     * @param x The x location in the world for the effect
-     * @param y The y location in the world for the effect
-     * @param z The z location in the world for the effect
      * @returns False to cancel the sound effect, a sound effect to play instead of the given one, or undefined to use the default logic
      */
-    queueSoundEffect?(type: SfxType, x: number, y: number, z: number): SfxType | boolean | undefined;
+    playUiSoundEffect?(type: SfxType): SfxType | boolean | undefined;
+    /**
+     * Called when a game sound effect is queued
+     * @param type The sound effect type
+     * @param position The position of the sound effect
+     * @returns False to cancel the sound effect, a sound effect to play instead of the given one, or undefined to use the default logic
+     */
+    queueGameSoundEffect?(type: SfxType, position: IVector4): SfxType | boolean | undefined;
 }
-export default class WAudio extends EventEmitter.Host<IAudioEvents> implements IAudio {
+export default class WAudio extends EventEmitter.Host<IAudioEvents> {
     private readonly _musicInfo;
     private readonly _sfxInfo;
     private readonly _soundQueue;
-    private readonly _recentlyPlayedSounds;
+    private readonly _recentlyPlayedGameSounds;
     private readonly _fileFormat;
     private _onInitializedPromise;
     private _audioContext;
@@ -67,11 +70,18 @@ export default class WAudio extends EventEmitter.Host<IAudioEvents> implements I
     updateMusicSpeed(speed: number): Promise<void>;
     updateVolume(): void;
     updatePosition(): Promise<void>;
-    queueEffect(type: SfxType, island: Island | undefined, x: number, y: number, z: number, delay?: number, speed?: number, noPosition?: boolean, force?: boolean): void;
-    processEffects(): void;
+    /**
+     * Plays a ui sound effect (a sound effect with no position)
+     */
+    playUiSoundEffect(sfxType: SfxType, speed?: number): Promise<void>;
+    /**
+     * Plays a sound effect (game / location based)
+     */
+    queueGameSoundEffect(type: SfxType, position: IVector4, delay?: number, speed?: number): void;
+    processGameSounds(): void;
     private _stopMusic;
     private _playMusic;
-    private _playEffect;
+    private _playSound;
     private _isComparableSound;
     private _getAudioBuffer;
     private initializeAudio;

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

@@ -8,21 +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 type Island from "game/island/Island";
-import type EnumCursor from "utilities/enum/EnumCursor";
-export interface IAudio {
-    resetMusicHandler(): void;
-    getMusicHandler(): EnumCursor<Music>;
-    setMusicHandler(handler: EnumCursor<Music>): void;
-    playMusic(): void;
-    stopMusic(): void;
-    processEffects(): void;
-    queueEffect(soundEffect: SfxType, island: Island | undefined, x: number, y: number, z: number, delay?: number, speed?: number, noPosition?: boolean): void;
-    updateMusicSpeed(speed: number): void;
-    updatePosition(): void;
-    updateVolume(): void;
-}
-export default IAudio;
 export declare enum SfxType {
     Boat = 0,
     Bow = 1,

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

@@ -127,8 +127,8 @@ export interface IEventBusRegistration {
 export default eventBuses;
 export declare module EventBus {
     function register<E extends EventBus>(eventBus: E, classOrHost: ReturnType<(typeof eventBuses)[E]>): void;
-    function register(eventBus: EventBus): (constructor: AbstractNullaryClass<any>) => void;
-    function unregister(eventBus: EventBus): void;
+    function register(eventBus: EventBus): (constructor: AbstractNullaryClass<any>) => any;
+    function unregister(eventBus: EventBus): boolean;
     function onEventBusRegistration(eventBus: EventBus, registration: IEventBusRegistration): void;
 }
 export type EventBusHost<E extends EventBus> = ReturnType<(typeof eventBuses)[E]>;

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

@@ -41,6 +41,7 @@ export interface ISelfSubscribedEmitter<E> {
 type ArgsOf<F> = ArgumentsOf<Extract<F, AnyFunction>>;
 type ReturnOf<F> = ReturnType<Extract<F, AnyFunction>>;
 type Handler<H, F> = (host: H, ...args: ArgsOf<F>) => ReturnOf<F>;
+type WeakHandler<H, F> = WeakRef<Handler<H, F>>;
 type UndefinedFromVoid<V> = V extends void ? undefined : V;
 export interface IEventEmitter<H = any, E = any> {
     event: IEventEmitter<this, IEventEmitterEvents<H, E>>;
@@ -98,7 +99,7 @@ declare class EventEmitter<H, E> implements IEventEmitter<H, E> {
     hasHandlersForEvent(...events: Array<keyof E>): boolean;
     private copyFrom;
     private readonly cachedClassHandlers;
-    protected handlersForEvent<K extends keyof E>(event: K, ignoreClassSubscriptions?: true): Array<keyof H | Handler<any, any>>;
+    protected handlersForEvent<K extends keyof E>(event: K, ignoreClassSubscriptions?: true): Array<keyof H | WeakHandler<any, any>>;
 }
 declare module EventEmitter {
     class Host<E> implements IEventEmitterHost<E> {

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

@@ -95,7 +95,7 @@ export default abstract class Entity<DescriptionType = unknown, TypeType extends
     isInFov(): boolean;
     setInFov(inFov: boolean): void;
     isOnFire(): FireType;
-    queueSoundEffect(type: SfxType, delay?: number, speed?: number, noPosition?: boolean): void;
+    queueSoundEffect(type: SfxType, delay?: number, speed?: number): void;
     updateRender(source: RenderSource, flag: UpdateRenderFlag): void;
     updateView(source: RenderSource, updateFov?: boolean | UpdateRenderFlag.FieldOfView | UpdateRenderFlag.FieldOfViewSkipTransition): void;
     notifyItem(itemNotifierType: ItemNotifierType, item: Item): void;

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

@@ -95,7 +95,7 @@ export default abstract class EntityMovable<DescriptionType = unknown, TypeType
     }, fieldOfView?: FieldOfView, customRadius?: number): boolean;
     canSeeTile(type: CanASeeBType, tile: Tile, fieldOfView?: FieldOfView, customRadius?: number): boolean;
     canSeePosition(type: CanASeeBType, islandId: IslandId, x: number, y: number, z: number, fieldOfView?: FieldOfView | undefined, customRadius?: number): boolean;
-    queueSoundEffectInFront(type: SfxType, delay?: number, speed?: number, noPosition?: boolean): void;
+    queueSoundEffectInFront(type: SfxType, delay?: number, speed?: number): void;
     getMovementDelay(): number;
     moveTo(tile: Tile, options?: IMoveToOptions): boolean;
     /**

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

@@ -180,7 +180,7 @@ export default abstract class Human<TypeType extends number = number> extends En
     addTamedCreature(creature: Creature): void;
     removeTamedCreature(creature: Creature): boolean;
     resetMovementIntent(): void;
-    createItemInInventory(itemType: ItemType | ItemTypeGroup | Array<ItemType | ItemTypeGroup>, quality?: Quality, updateTables?: boolean, movingMultiple?: boolean): Item;
+    createItemInInventory(itemType: ItemType | ItemTypeGroup | Array<ItemType | ItemTypeGroup>, quality?: Quality, updateTables?: boolean): Item;
     damageRandomEquipment(): void;
     getDamageModifier(): number;
     calculateDamageAmount(attackType: AttackType, weapon?: Item, ammoItem?: Item): number;

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

@@ -17,7 +17,7 @@ export declare enum WorldContextMenuClasses {
     OptionText = "world-context-menu-option-text"
 }
 export declare namespace WorldContextMenuClasses {
-    const OptionSpecific: (enumValue: UsableActionType) => "world-context-menu-option-none" | "world-context-menu-option-actions" | "world-context-menu-option-use" | "world-context-menu-option-move" | "world-context-menu-option-quickslotremove" | "world-context-menu-option-quickslotadd" | "world-context-menu-option-quickslotaddtofree" | "world-context-menu-option-quickslotaddtoslot" | "world-context-menu-option-movetoinventory" | "world-context-menu-option-dropmenu" | "world-context-menu-option-dropall" | "world-context-menu-option-dropallofsamequality" | "world-context-menu-option-repairwithitem" | "world-context-menu-option-reinforcewithitem" | "world-context-menu-option-enhancewithitem" | "world-context-menu-option-enchantwithitem" | "world-context-menu-option-transmogrifywithitem" | "world-context-menu-option-upgradewithitem" | "world-context-menu-option-alterwithitem" | "world-context-menu-option-refinewithitem" | "world-context-menu-option-preservewithitem" | "world-context-menu-option-addfuelwithitem" | "world-context-menu-option-ignitewithitem" | "world-context-menu-option-absorbwithitem" | "world-context-menu-option-exudewithitem" | "world-context-menu-option-movetoinventorymenu" | "world-context-menu-option-movetoactivecontainermenu" | "world-context-menu-option-movetofacingcontainermenu" | "world-context-menu-option-moveall" | "world-context-menu-option-moveallofsamequality" | "world-context-menu-option-tradetradersell" | "world-context-menu-option-tradetraderbuy" | "world-context-menu-option-itemactions" | "world-context-menu-option-gatherwithhands" | "world-context-menu-option-harvestwithhands" | "world-context-menu-option-digwithhands" | "world-context-menu-option-tillwithhands" | "world-context-menu-option-pickupexcrementwithhands" | "world-context-menu-option-equipheld" | "world-context-menu-option-equiplegs" | "world-context-menu-option-equipchest" | "world-context-menu-option-equiphead" | "world-context-menu-option-equipwaist" | "world-context-menu-option-equipfeet" | "world-context-menu-option-equipneck" | "world-context-menu-option-equiphands" | "world-context-menu-option-equipback" | "world-context-menu-option-equipmainhand" | "world-context-menu-option-equipoffhand" | "world-context-menu-option-restonground" | "world-context-menu-option-sleeponground" | "world-context-menu-option-commandmenu" | "world-context-menu-option-commandfollowclose" | "world-context-menu-option-commandfollowfar" | "world-context-menu-option-commandstay" | "world-context-menu-option-commanddefend" | "world-context-menu-option-commandattack";
+    const OptionSpecific: (enumValue: UsableActionType) => "world-context-menu-option-none" | "world-context-menu-option-actions" | "world-context-menu-option-use" | "world-context-menu-option-move" | "world-context-menu-option-commandattack" | "world-context-menu-option-commanddefend" | "world-context-menu-option-commandfollowclose" | "world-context-menu-option-commandfollowfar" | "world-context-menu-option-commandstay" | "world-context-menu-option-digwithhands" | "world-context-menu-option-dropall" | "world-context-menu-option-dropallofsamequality" | "world-context-menu-option-gatherwithhands" | "world-context-menu-option-harvestwithhands" | "world-context-menu-option-movetoinventory" | "world-context-menu-option-pickupexcrementwithhands" | "world-context-menu-option-restonground" | "world-context-menu-option-tillwithhands" | "world-context-menu-option-quickslotremove" | "world-context-menu-option-quickslotadd" | "world-context-menu-option-quickslotaddtofree" | "world-context-menu-option-quickslotaddtoslot" | "world-context-menu-option-dropmenu" | "world-context-menu-option-repairwithitem" | "world-context-menu-option-reinforcewithitem" | "world-context-menu-option-enhancewithitem" | "world-context-menu-option-enchantwithitem" | "world-context-menu-option-transmogrifywithitem" | "world-context-menu-option-upgradewithitem" | "world-context-menu-option-alterwithitem" | "world-context-menu-option-refinewithitem" | "world-context-menu-option-preservewithitem" | "world-context-menu-option-addfuelwithitem" | "world-context-menu-option-ignitewithitem" | "world-context-menu-option-absorbwithitem" | "world-context-menu-option-exudewithitem" | "world-context-menu-option-movetoinventorymenu" | "world-context-menu-option-movetoactivecontainermenu" | "world-context-menu-option-movetofacingcontainermenu" | "world-context-menu-option-moveall" | "world-context-menu-option-moveallofsamequality" | "world-context-menu-option-tradetradersell" | "world-context-menu-option-tradetraderbuy" | "world-context-menu-option-itemactions" | "world-context-menu-option-equipheld" | "world-context-menu-option-equiplegs" | "world-context-menu-option-equipchest" | "world-context-menu-option-equiphead" | "world-context-menu-option-equipwaist" | "world-context-menu-option-equipfeet" | "world-context-menu-option-equipneck" | "world-context-menu-option-equiphands" | "world-context-menu-option-equipback" | "world-context-menu-option-equipmainhand" | "world-context-menu-option-equipoffhand" | "world-context-menu-option-sleeponground" | "world-context-menu-option-commandmenu";
 }
 export declare const UsableActionsWorldActions: UsableActionGenerator<[]>;
 export declare const UsableActionsWorldItemActions: UsableActionGenerator<[]>;

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

@@ -118,7 +118,7 @@ export interface IMessageManager {
     ifOnIsland(island: Island): this;
     send(message: Message | Translation, ...args: TranslationArg[]): boolean;
     sendPacked(pack: Partial<IPackedMessage>, ...extraSources: Source[]): boolean;
-    pruneMessageHistory(): boolean;
+    pruneMessageHistory(isLocalPlayer: boolean): boolean;
     ifIs(human: Human): this;
     ifIsNot(human: Human): this;
     addToHistory(messageHistoryItem: IMessageHistoryItem): void;

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

@@ -31,13 +31,13 @@ export declare class MessageManagerNoOp implements IMessageManager {
     send(): boolean;
     sendPacked(): boolean;
     sentToAll(sentToAll?: boolean): this;
-    pruneMessageHistory(): boolean;
+    pruneMessageHistory(isLocalPlayer: boolean): boolean;
     addToHistory(messageHistoryItem: IMessageHistoryItem): void;
 }
 export interface IMessageManagerOptions {
     shouldDisplayMessage(message: IMessage, id: number): boolean | undefined;
     onDisplayMessage(message: IMessage): void;
-    getMessageStorageMax(): number;
+    getMessageStorageMax(isLocalPlayer: boolean): number;
 }
 export default class MessageManager implements IMessageManager {
     private readonly options;
@@ -71,7 +71,7 @@ export default class MessageManager implements IMessageManager {
     /**
      * Cuts the message history down to the correct bounds (preferring the more recent messages)
      */
-    pruneMessageHistory(): boolean;
+    pruneMessageHistory(isLocalPlayer: boolean): boolean;
     /**
      * Clears the entire message history.
      */

package/definitions/game/game/inspection/InfoProvider.d.ts

@@ -141,7 +141,7 @@ export declare class SimpleInfoProvider extends InfoProvider {
     private childComponentClass;
     private validWhen?;
     constructor(...translations: Array<TranslationGenerator | InfoProvider>);
-    get(): (import("../../language/ITranslation").ISerializedTranslation | import("../../language/impl/TranslationImpl").default | import("../../language/dictionary/UiTranslation").default | (() => import("../../language/ITranslation").ISerializedTranslation | import("../../language/impl/TranslationImpl").default | import("../../language/dictionary/UiTranslation").default | Iterable<import("../../utilities/string/Interpolator").IStringSection> | undefined) | InfoProvider)[];
+    get(): (import("../../language/ITranslation").ISerializedTranslation | import("../../language/impl/TranslationImpl").default | import("../../language/dictionary/UiTranslation").default | (() => import("../../language/ITranslation").ISerializedTranslation | import("../../language/impl/TranslationImpl").default | Iterable<import("../../utilities/string/Interpolator").IStringSection> | import("../../language/dictionary/UiTranslation").default | undefined) | InfoProvider)[];
     add(...translations: Array<TranslationGenerator | InfoProvider | Falsy>): this;
     onlyIfHasContents(): this | undefined;
     addInfoGetter(provider: () => InfoProvider | undefined): this;

package/definitions/game/game/inspection/infoProviders/creature/CreatureTamedInfo.d.ts

@@ -18,7 +18,7 @@ export default class CreatureTamedInfoProvider extends InfoProvider {
     constructor(creature: Creature);
     getClass(): string[];
     hasContent(): boolean;
-    get(): (LabelledValue | import("game/inspection/InfoProvider").SimpleInfoProvider)[];
+    get(): (import("game/inspection/InfoProvider").SimpleInfoProvider | LabelledValue)[];
     onTickEnd(): void;
     private getHappinessMessage;
 }

package/definitions/game/game/inspection/infoProviders/item/ItemDetails.d.ts

@@ -19,7 +19,7 @@ export default class ItemDetailsInfoProvider extends InfoProvider {
     private readonly description;
     constructor(item: Item | ItemType);
     getClass(): string[];
-    get(): (0 | LabelledValue | import("game/inspection/InfoProvider").SimpleInfoProvider | ItemWorthInfoProvider)[];
+    get(): (0 | import("game/inspection/InfoProvider").SimpleInfoProvider | LabelledValue | ItemWorthInfoProvider)[];
     private getInsulation;
     private getPreservation;
     private getGroupings;

package/definitions/game/game/inspection/infoProviders/stat/AttackInfo.d.ts

@@ -15,7 +15,7 @@ export default class AttackInfo extends InfoProvider {
     private readonly human?;
     constructor(human?: Human<number> | undefined);
     getClass(): string[];
-    get(): (LabelledValue | import("game/inspection/InfoProvider").SimpleInfoProvider)[];
+    get(): (import("game/inspection/InfoProvider").SimpleInfoProvider | LabelledValue)[];
     private getTactics;
     private getMainHand;
     private getOffHand;

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

@@ -19,7 +19,7 @@ export default class CorpseInspection extends Inspection<Corpse> {
     static getFromTile(tile: Tile): CorpseInspection[];
     static handles(type: InspectType, corpse: unknown): boolean;
     constructor(corpse: Corpse);
-    get(context: InfoProviderContext): (0 | LabelledValue | import("game/inspection/InfoProvider").SimpleInfoProvider)[];
+    get(context: InfoProviderContext): (0 | import("game/inspection/InfoProvider").SimpleInfoProvider | LabelledValue)[];
     private getDecay;
     private decay;
     private shouldRefreshDecay;

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

@@ -502,6 +502,10 @@ export interface IMagicalPropertyInfo {
      * Generates the random sub-property to use for this magical property, if this magical property is a magical property with subtypes.
      */
     subType?: MagicalSubPropertySubTypes | (() => MagicalSubPropertySubTypes);
+    /**
+     * Set to true if the value can be expanded beyond its normal maximum (in the case of relic items).
+     */
+    expandable?: boolean;
 }
 export interface IItemUsed {
     usedBy?: string[];

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

@@ -90,13 +90,11 @@ export interface IDoodadsUsed {
     group: DoodadType | DoodadTypeGroup;
 }
 export interface IAddToContainerOptions {
-    movingMultiple?: boolean;
     skipMessage?: boolean;
     skipUpdateTables?: boolean;
     skipTileUpdate?: boolean;
 }
 export interface IPlaceOnTileOptions {
-    movingMultiple?: boolean;
     force?: boolean;
     skipMessage?: boolean;
     skipTileUpdate?: boolean;

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

@@ -137,7 +137,7 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     getDisassemblyComponents(description: IItemDescription, quality: Quality | undefined): Item[];
     getDisassemblyComponentsAsItemTypes(description: IItemDescription): Array<ItemType | ItemTypeGroup>;
     getWeightCapacity(container: IContainer, includeMagic?: boolean): number | undefined;
-    create(itemType: ItemType | ItemTypeGroup | Array<ItemType | ItemTypeGroup>, container: IContainer | undefined, quality?: Quality, human?: Human, movingMultiple?: boolean, updateTables?: boolean): Item;
+    create(itemType: ItemType | ItemTypeGroup | Array<ItemType | ItemTypeGroup>, container: IContainer | undefined, quality?: Quality, human?: Human, updateTables?: boolean): Item;
     createFake(itemType: ItemType | ItemTypeGroup | Array<ItemType | ItemTypeGroup>, quality?: Quality, human?: Human): Item;
     getContainedContainers(container: IContainer): IContainer[];
     moveAllFromContainerToInventory(human: Human, container: IContainer, ofQuality?: Quality): Item[];

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

@@ -0,0 +1,16 @@
+/*!
+ * 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 { IContainer } from "game/item/IItem";
+import type Item from "game/item/Item";
+export declare class WorldContainer implements IContainer {
+    readonly containedItems: Item[];
+    toString(): string;
+}

package/definitions/game/game/reference/ReferenceManager.d.ts

@@ -33,7 +33,7 @@ export default class ReferenceManager {
     constructor(game: Game);
     create(): number;
     reset(): void;
-    getList(type: ReferenceType, gameIsland?: Island): import("../entity/creature/corpse/CorpseManager").default | import("../entity/creature/CreatureManager").default | import("../doodad/DoodadManager").default | import("../item/ItemManager").default | import("../entity/npc/NPCManager").default | import("../tile/TileEventManager").default | Player[] | import("game/entity/IHuman").EquipType[] | readonly SkillType[] | readonly Milestone[] | readonly ItemType[] | IterableIterator<Island> | readonly Stat[] | (string | ActionType)[];
+    getList(type: ReferenceType, gameIsland?: Island): import("../entity/creature/corpse/CorpseManager").default | import("../entity/creature/CreatureManager").default | import("../doodad/DoodadManager").default | import("../item/ItemManager").default | import("../entity/npc/NPCManager").default | import("../tile/TileEventManager").default | Player[] | import("game/entity/IHuman").EquipType[] | readonly Milestone[] | readonly SkillType[] | IterableIterator<Island> | readonly Stat[] | readonly ItemType[] | (string | ActionType)[];
     get(thing: Item): Reference<ReferenceType.Item> | undefined;
     get(thing: Doodad): Reference<ReferenceType.Doodad> | undefined;
     get(thing: Creature): Reference<ReferenceType.Creature> | undefined;

package/definitions/game/game/tile/Tile.d.ts

@@ -206,7 +206,7 @@ export default class Tile implements IVector4, Partial<ITileContainer>, IFieldOf
      * @returns TerrainType that we should switch the tile into.
      */
     private canSwitchCave;
-    queueSoundEffect(type: SfxType, delay?: number, speed?: number, noPosition?: boolean, force?: boolean): void;
+    queueSoundEffect(type: SfxType, delay?: number, speed?: number): void;
     createParticles(particle: IRGB | undefined, count?: number, intensity?: number): void;
     /**
      * Finds either lava or water ajacent to either lava or water, and cools the lava down based its findings.