@wayward/types 2.12.0-beta.dev.20220906.1 → 2.12.0-beta.dev.20220907.8

package/definitions/game/IGlobal.d.ts

@@ -9,6 +9,7 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import "@cplusplus/index";
+import "@hosts/shared/globalTypes";
 import "@wayward/goodstream/apply";
 import type WAudio from "audio/Audio";
 import type CommandManager from "command/CommandManager";
@@ -41,7 +42,6 @@ import "utilities/typesglobal/Iterables";
 import "utilities/typesglobal/Misc";
 import "utilities/typesglobal/Objects";
 import "utilities/typesglobal/Types";
-import "@hosts/shared/globalTypes";
 declare global {
     let absentPlayers: Player[];
     let audio: WAudio | undefined;
@@ -69,6 +69,9 @@ declare global {
     const gameVersionMinor: number;
     const gameVersionPatch: number;
     const gameVersionName: string;
+    const gameVersionTitleMajor: string;
+    const gameVersionTitleMinor: string;
+    const gameVersionTitle: string;
     const isNodeJs: boolean;
     const isWebWorker: boolean;
     const overlayWorks: boolean | undefined;

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

@@ -420,9 +420,23 @@ export interface IVoyageInfo {
     wantedItems?: ItemType[];
 }
 export declare enum MovingClientSide {
+    /**
+     * NoInput = Idle
+     */
     NoInput = 0,
+    /**
+     * Is actively moving
+     */
     Moving = 1,
+    /**
+     * Just completed their movement.
+     * They might be about to move again.
+     */
     Moved = 2,
+    /**
+     * The game registered the end of the movement.
+     * It's about to check if it will move again or finish (state change into Moving or NoInput)
+     */
     PreNoInput = 3
 }
 /**

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

@@ -30,6 +30,7 @@ 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 { IModdable } from "mod/ModRegistry";
 import type { IRGB } from "utilities/Color";
 import type { Direction } from "utilities/math/Direction";
 import type { IVector2, IVector3 } from "utilities/math/IVector";
@@ -188,7 +189,7 @@ export interface IActionNotUsable extends Partial<IPackedMessage> {
     source?: never;
 }
 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>> {
+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>> extends IModdable {
     type?: number;
     argumentTypes: A;
     usability: {

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

@@ -8,6 +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 { IModdable } from "mod/ModRegistry";
 export declare enum ActionTypeStarts {
     ActionType = 0,
     ModActionType = 10000,
@@ -73,3 +74,4 @@ export declare enum UsableActionTypePlaceholder {
     Paddle = 200003,
     Operate = 200004
 }
+export declare const usableActionDescriptions: PartialRecord<UsableActionType | UsableActionTypePlaceholder, IModdable>;

package/definitions/game/game/inspection/infoProviders/UseInfo.d.ts

@@ -14,6 +14,7 @@ import { InfoDisplayLevel } from "game/inspection/IInfoProvider";
 import type { InfoProvider } from "game/inspection/InfoProvider";
 import type { InfoProviderContext } from "game/inspection/InfoProviderContext";
 import type { Quality } from "game/IObject";
+import type Island from "game/island/Island";
 import type Translation from "language/Translation";
 import type { TranslationGenerator } from "ui/component/IComponent";
 export interface IDescribed {
@@ -21,6 +22,7 @@ export interface IDescribed {
     type: number;
     referenceId?: number;
     quality?: Quality;
+    island: Island;
     description(): any;
 }
 export declare type DescribedDescription<T extends IDescribed> = Exclude<ReturnType<T["description"]>, undefined>;

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

@@ -276,7 +276,7 @@ export default class Item extends EventEmitter.Host<IItemEvents> implements IRef
      * @param action The ActionType you are trying to get the level for.
      * @returns A number (possibly 0 if no quality or action level).
      */
-    getItemUseBonus(action?: ActionType): number;
+    getItemUseBonus(action: ActionType): number;
     getBestRangedWeapon(human: Human): Item | undefined;
     /**
      * Extinguishes to item if it is lit.

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

@@ -215,12 +215,19 @@ export default class ItemManager extends ObjectManager<Item, IItemManagerEvents>
     countItemsInContainerByGroup(containers: IContainer | IContainer[], itemTypeGroupSearch: ItemTypeGroup, ignoreItem?: Item): number;
     /**
      * Get the best items sorted by how good they are
+     * Usability/custom (ie the sorting for melee/start fire) > Action tier (+quality if there's an action tier on both items) > quality > durability
      */
     getBestSafeItems(human: Human, container: IContainer, options?: Partial<IGetBestItemsOptions>): Item[];
     /**
      * Get the best item
      */
     getBestSafeItem(human: Human, container: IContainer, options?: Partial<IGetBestItemsOptions>): Item | undefined;
+    /**
+     * Gets the item's quality and action level (how good it is at doing the action).
+     * @param action The ActionType you are trying to get the level for.
+     * @returns A number (possibly 0 if no quality or action level).
+     */
+    getItemUseBonus(itemType: ItemType, action: ActionType, quality: Quality | undefined): number;
     getItemInContainer(container: IContainer, itemTypeSearch: ItemType, options?: Partial<IGetItemOptions>): Item | undefined;
     getItemForHuman(human: Human, search: ItemType | ItemTypeGroup, options?: Partial<IGetItemOptions>): Item | undefined;
     getItemInContainerByGroup(container: IContainer, itemTypeGroupSearch: ItemTypeGroup, options?: Partial<IGetItemOptions>): Item | undefined;

package/definitions/game/game/options/modifiers/milestone/MilestoneModifiersManager.d.ts

@@ -20,7 +20,7 @@ declare class MilestoneModifiersManager extends GameplayModifiersManager<Milesto
     isGlobal(milestone: Milestone): boolean;
     isNotGlobal(milestone: Milestone): boolean;
     getGroup(milestone: Milestone): import("game/options/modifiers/milestone/MilestoneModifier").MilestoneModifierGroup | undefined;
-    sort(a: Milestone, b: Milestone): 0 | 1 | -1;
+    sort(a: Milestone, b: Milestone): 1 | 0 | -1;
     private areOptionsGlobal;
 }
 declare const _default: MilestoneModifiersManager;