@wayward/types 2.13.0-beta.dev.20230427.1 → 2.13.0-beta.dev.20230428.2

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

@@ -12,11 +12,12 @@ import { Action } from "game/entity/action/Action";
 import type { IActionUsable } from "game/entity/action/IAction";
 import { ActionArgument } from "game/entity/action/IAction";
 import type Creature from "game/entity/creature/Creature";
+import type { ICreatureDescription } from "game/entity/creature/ICreature";
 import type Human from "game/entity/Human";
 import { AiType } from "game/entity/IEntity";
 export interface ISetCreatureAiCanUse extends IActionUsable {
     creature: Creature;
 }
-export declare function hasSkillToSetCreatureAi(human: Human, ai: AiType): boolean;
+export declare function hasSkillToSetCreatureAi(human: Human, creatureDescription: ICreatureDescription | undefined, ai: AiType): boolean;
 declare const _default: Action<[ActionArgument.Integer32], Human<number>, void, ISetCreatureAiCanUse, [number]>;
 export default _default;

package/definitions/game/game/entity/creature/ICreature.d.ts

@@ -157,6 +157,10 @@ export interface ICreatureDescription extends IModdable, ITemperatureDescription
      * Prevents the creature from spawning for the provided WorldZ's
      */
     preventSpawnZs?: Set<WorldZ>;
+    /**
+     * Prevents release the creature from its tamed state
+     */
+    preventRelease?: boolean;
     fishable?: boolean;
     blood?: IRGB;
     aberrantBlood?: IRGB;
@@ -249,6 +253,10 @@ export interface ICreatureDescription extends IModdable, ITemperatureDescription
      * If set, creature will only listen to certain commands.
      */
     allowedCommands?: AiType[];
+    /**
+     * When true, the player will always be able to command the creature, regardless of their taming skill.
+     */
+    alwaysAllowCommands?: boolean;
     /**
      * Called when a stat changes
      */

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

@@ -128,7 +128,7 @@ export interface IMessageManager {
      * Signal that the message was sent to everyone
      */
     sentToAll(sentToAll?: boolean): this;
-    upgrade(id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number): this;
+    upgrade(id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number, upgrader?: Translation.ITranslationUpgrader): this;
 }
 export interface IMessageHistoryItem {
     id: number;

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

@@ -125,5 +125,5 @@ export default class MessageManager implements IMessageManager {
      */
     sentToAll(sentToAll?: boolean): this;
     private reset;
-    upgrade(id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number): this;
+    upgrade(id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number, upgrader?: Translation.ITranslationUpgrader): this;
 }

package/definitions/game/game/entity/player/note/NoteManager.d.ts

@@ -10,6 +10,9 @@
  */
 import type Island from "game/island/Island";
 import type { PartOfDay } from "game/time/ITimeManager";
+import type Dictionary from "language/Dictionary";
+import type { TranslationArg } from "language/ITranslation";
+import Translation from "language/Translation";
 import Note from "language/dictionary/Note";
 import type { IModdable } from "mod/ModRegistry";
 import { HelpArticle } from "ui/screen/screens/menu/menus/help/HelpArticleDescriptions";
@@ -25,7 +28,7 @@ export interface INote {
         time: number;
         skilled: boolean;
     };
-    args: any[];
+    args: TranslationArg[];
     unread?: boolean;
 }
 export interface INoteManager {
@@ -35,6 +38,7 @@ export interface INoteManager {
     write(note: Note, ...args: any[]): void;
     getUnread(): INote[];
     markRead(noteId: number): void;
+    upgrade(id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number, upgrader?: Translation.ITranslationUpgrader): this;
 }
 export interface INoteHost {
     getIsland(): Island;
@@ -47,9 +51,10 @@ export declare class NoteManagerNoOp implements INoteManager {
     readonly notes: INote[];
     getNote(id: number): INote | undefined;
     wasWritten(note: Note): boolean;
-    write(note: Note, ...args: any[]): void;
+    write(note: Note, ...args: TranslationArg[]): void;
     getUnread(): INote[];
     markRead(noteId: number): void;
+    upgrade(id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number, upgrader?: Translation.ITranslationUpgrader): this;
 }
 export default class NoteManager implements INoteManager {
     private readonly host;
@@ -58,7 +63,8 @@ export default class NoteManager implements INoteManager {
     get notes(): INote[];
     getNote(id: number): INote | undefined;
     wasWritten(note: Note): boolean;
-    write(note: Note, ...args: any[]): void;
+    write(note: Note, ...args: TranslationArg[]): void;
     getUnread(): INote[];
     markRead(noteId: number): void;
+    upgrade(id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number, upgrader?: Translation.ITranslationUpgrader): this;
 }

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

@@ -163,7 +163,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 | Iterable<import("../../utilities/string/Interpolator").IStringSection> | import("../../language/dictionary/UiTranslation").default | 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 | 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/language/ITranslation.d.ts

@@ -40,7 +40,7 @@ export interface ISerializedInterpolator {
     options?: IInterpolationOptions;
     segments?: Segment[];
 }
-export type TranslationArg = string | number | boolean | Translation | ISerializedTranslation | IStringSection | Iterable<IStringSection> | TranslationArg[] | ITranslationArgRecord | (() => TranslationArg) | undefined | null;
+export type TranslationArg = string | number | boolean | Translation | ISerializedTranslation | IStringSection | TranslationArg[] | ITranslationArgRecord | (() => TranslationArg) | undefined | null;
 export interface ITranslationArgRecord {
     [key: string]: ITranslationArgRecord | TranslationArg;
 }

package/definitions/game/language/Translation.d.ts

@@ -24,7 +24,7 @@ import TranslationImpl from "language/impl/TranslationImpl";
 import type { ISerializedTranslation, TranslationArg } from "language/ITranslation";
 import { formatListTranslation } from "language/segment/FormatListSegment";
 import ITranslationSorter from "language/utility/TranslationSorter";
-import type { IStringSection } from "utilities/string/Interpolator";
+import { IStringSection } from "utilities/string/Interpolator";
 export declare enum Article {
     /**
      * Use no article.
@@ -149,6 +149,11 @@ declare module Translation {
     function reformatSingularNoun(article: Article): Translation;
     function reformatSingularNoun(count: number, article: Article): Translation;
     function reformatSingularNoun(count?: number | Article, article?: Article): Translation;
-    function upgrade(translation: ISerializedTranslation, id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number): void;
+    interface ITranslationUpgrader {
+        translation?(translation: TranslationImpl | ISerializedTranslation): any;
+        argument?(argument: TranslationArg): TranslationArg;
+    }
+    function upgrade(translation: ISerializedTranslation, id: `${keyof typeof Dictionary}:${string}`, dictionary: Dictionary, entry: number, upgrader?: ITranslationUpgrader): ISerializedTranslation | TranslationImpl;
+    function upgradeTranslationArgument(argument: TranslationArg, id: string, dictionary: Dictionary, entry: number, upgrader?: ITranslationUpgrader): TranslationArg;
 }
 export default Translation;

package/definitions/game/language/impl/TranslationImpl.d.ts

@@ -46,9 +46,9 @@ export default class TranslationImpl implements Omit<ISerializable, "deserialize
     private static getStringSections;
     readonly isValid: boolean;
     private readonly translationData;
-    private readonly translationId;
-    private readonly args;
-    private readonly reformatters;
+    readonly id: string;
+    readonly args: TranslationArg[];
+    readonly reformatters: Array<TranslationImpl | ((sections: IStringSection[]) => IStringSection[])>;
     private interpolator;
     private _context;
     get context(): TextContext;
@@ -102,6 +102,7 @@ export default class TranslationImpl implements Omit<ISerializable, "deserialize
     private getCustomInterpolatorSegments;
     serializeObject(): ISerializedTranslation;
     serialize(depth?: number): ISerializedTranslation;
+    static serializeTranslationArg(arg: any, depth?: number, maxSerializationDepth?: number): any;
     private canCache;
     private getCachedTranslation;
     /**

package/definitions/game/language/segment/FormatListSegment.d.ts

@@ -12,6 +12,6 @@ import type { ISerializedTranslation } from "language/ITranslation";
 import { ListEnder } from "language/ITranslation";
 import type Translation from "language/Translation";
 import type { ISegment, IStringSection } from "utilities/string/Interpolator";
-export declare function formatListTranslation(items: Iterable<string | IStringSection | Iterable<IStringSection> | Translation | ISerializedTranslation>, ender?: ListEnder | false): Translation;
+export declare function formatListTranslation(items: Iterable<string | IStringSection | IStringSection[] | Translation | ISerializedTranslation>, ender?: ListEnder | false): Translation;
 declare const _default: ISegment;
 export default _default;

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

@@ -90,7 +90,7 @@ export interface IDisableable {
     disabled: boolean;
     setDisabled(disabled: boolean): this;
 }
-export type TranslationGenerator<ENUM extends number = UiTranslation, A extends any[] = []> = Translation | ENUM | ISerializedTranslation | ((...args: A) => Iterable<IStringSection> | Translation | ENUM | ISerializedTranslation | undefined);
+export type TranslationGenerator<ENUM extends number = UiTranslation, A extends any[] = []> = Translation | ENUM | ISerializedTranslation | ((...args: A) => IStringSection[] | Translation | ENUM | ISerializedTranslation | undefined);
 export interface IBox {
     left: number;
     top: number;

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

@@ -24,7 +24,6 @@ import type TooltipLocationHandler from "ui/tooltip/TooltipLocationHandler";
 import type { IDraggableEvents } from "ui/util/Draggable";
 import Draggable from "ui/util/Draggable";
 import Log from "utilities/Log";
-import type { IStringSection } from "utilities/string/Interpolator";
 /**
  * The positions of each edge of the dialog. Stored as percentages.
  */
@@ -188,7 +187,7 @@ declare abstract class Dialog extends Component implements IDialog {
     /**
      * The name is displayed in the `Move To` context menu option, and in the `Switch With` options
      */
-    getName(): Iterable<IStringSection> | Translation | UiTranslation | ISerializedTranslation | undefined;
+    getName(): Translation | UiTranslation | ISerializedTranslation | undefined;
     /**
      * Event handler for when this dialog is appended
      */

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

@@ -16,7 +16,7 @@ export default class BookDialog extends Dialog {
     private book?;
     private readonly text;
     constructor();
-    getName(): import("../../../../../language/ITranslation").ISerializedTranslation | import("../../../../../language/impl/TranslationImpl").default | Iterable<import("../../../../../utilities/string/Interpolator").IStringSection> | import("../../../../../language/dictionary/UiTranslation").default | undefined;
+    getName(): import("../../../../../language/ITranslation").ISerializedTranslation | import("../../../../../language/impl/TranslationImpl").default | import("../../../../../language/dictionary/UiTranslation").default | undefined;
     openBook(item: Item): void;
     private getText;
     protected onInventoryItemRemove(_: any, itemOrItems: Item | Item[]): void;

package/definitions/game/utilities/string/Interpolator.d.ts

@@ -17,7 +17,7 @@ export interface ISegmentApi extends Readonly<IInterpolationOptions> {
     interpolate(str: string, ...args: any[]): IStringSection[];
     interpolateString(str: string, ...args: any[]): string;
     with(options: IInterpolationOptions): ISegmentApi;
-    formatValue(value: unknown): string | Iterable<IStringSection>;
+    formatValue(value: unknown): string | IStringSection[];
 }
 export interface IInterpolationOptions {
     formatNumbers?: boolean;
@@ -38,6 +38,7 @@ export interface IStringSection {
     stringOnly?: true;
 }
 export declare namespace IStringSection {
+    function is(value: unknown): value is IStringSection;
     function get(content?: string | IStringSection | Iterable<IStringSection>): Iterable<IStringSection>;
 }
 export interface IReferenceSection extends IStringSection {

package/package.json

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