@wayward/types 2.14.0-beta.dev.20231213.1 → 2.14.0-beta.dev.20231214.1

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

@@ -8,20 +8,20 @@
  * 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 { Events } from "@wayward/utilities/event/EventEmitter";
-import type { TitleType } from "@wayward/game/game/entity/action/actions/SetTitle";
 import type Human from "@wayward/game/game/entity/Human";
 import type { HairColor, HairStyle, SkillType, SkinColor } from "@wayward/game/game/entity/IHuman";
+import type { TitleType } from "@wayward/game/game/entity/action/actions/SetTitle";
 import type { IMessage } from "@wayward/game/game/entity/player/IMessageManager";
 import type MessageManager from "@wayward/game/game/entity/player/MessageManager";
-import type { INote } from "@wayward/game/game/entity/player/note/NoteManager";
 import type Player from "@wayward/game/game/entity/player/Player";
+import type { INote } from "@wayward/game/game/entity/player/note/NoteManager";
 import { ItemType } from "@wayward/game/game/item/IItem";
 import type { Prompt } from "@wayward/game/game/meta/prompt/IPrompt";
 import type { Milestone } from "@wayward/game/game/milestones/IMilestone";
 import type InterruptChoice from "@wayward/game/language/dictionary/InterruptChoice";
 import { Direction } from "@wayward/game/utilities/math/Direction";
 import type { IVector2, IVector3 } from "@wayward/game/utilities/math/IVector";
+import type { Events } from "@wayward/utilities/event/EventEmitter";
 export interface IPlayerEvents extends Events<Human> {
     /**
      * Called when a message is being displayed for a player
@@ -217,3 +217,12 @@ export interface IWalkPath {
     path: IVector2[];
     force?: boolean;
 }
+export interface IPlayerTitleMilestone {
+    milestone: Milestone;
+    skill?: undefined;
+}
+export interface IPlayerTitleSkill {
+    skill: SkillType;
+    milestone?: undefined;
+}
+export type PlayerTitle = IPlayerTitleMilestone | IPlayerTitleSkill;

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

@@ -15,7 +15,7 @@ import { SkillType } from "@wayward/game/game/entity/IHuman";
 import type { IDamageInfo } from "@wayward/game/game/entity/creature/ICreature";
 import { CreatureType } from "@wayward/game/game/entity/creature/ICreature";
 import type NPC from "@wayward/game/game/entity/npc/NPC";
-import type { IMovementIntent, IPlayerEvents } from "@wayward/game/game/entity/player/IPlayer";
+import type { IMovementIntent, IPlayerEvents, PlayerTitle } from "@wayward/game/game/entity/player/IPlayer";
 import MessageManager from "@wayward/game/game/entity/player/MessageManager";
 import NoteManager from "@wayward/game/game/entity/player/note/NoteManager";
 import QuestManager from "@wayward/game/game/entity/player/quest/QuestManager";
@@ -50,13 +50,7 @@ export default class Player extends Human<number, ReferenceType.Player> implemen
     useActionsWhileMoving: boolean;
     revealedItems: SaferNumberIndexedObject<boolean>;
     milestoneModifiers: Set<Milestone>;
-    title?: {
-        milestone: Milestone;
-        skill?: undefined;
-    } | {
-        skill: SkillType;
-        milestone?: undefined;
-    };
+    title?: PlayerTitle;
     displayCreature?: CreatureType;
     private updateTablesOnNoInput?;
     private lastTableUpdateId?;

package/definitions/game/game/entity/skill/ISkills.d.ts

@@ -16,6 +16,7 @@ import type { IModdable } from "@wayward/game/mod/ModRegistry";
 export interface ISkillLevel {
     bonus: number;
     core: number;
+    turn?: number;
 }
 export interface ISkillDescription extends IModdable {
     attribute?: Stat | ISkillAttribute;

package/definitions/game/game/entity/skill/SkillManager.d.ts

@@ -36,6 +36,7 @@ export type SkillSet = Record<SkillType, ISkillLevel>;
 export interface ISkillHost extends EventEmitter.Host<ISkillEvents> {
     readonly id: number;
     readonly island: Island;
+    readonly turns: number;
 }
 export default class SkillManager {
     private readonly configuration;
@@ -70,6 +71,7 @@ export default class SkillManager {
      * @returns The total skill (combination of all other skills). Ignores skill bonuses.
      */
     getTotal(): number;
+    getModificationTurn(skill: SkillType): number;
     all(): Array<{
         bonus: number;
         core: number;

package/definitions/game/language/dictionary/UiTranslation.d.ts

@@ -61,10 +61,10 @@ declare enum UiTranslation {
     GameDialogMilestonesMilestone = 46,
     GameDialogMilestonesTooltipMystery = 47,
     GameDialogMilestonesTooltipInvisible = 48,
-    GameDialogMilestonesHeadingNotUnlockableInMode = 49,
-    GameDialogMilestonesHeadingAlreadyUnlocked = 50,
-    GameDialogMilestonesParagraphNoMoreUnlockable = 51,
-    GameDialogMilestonesLabelPlusHidden = 52,
+    GameDialogUnlockablesHeadingNotUnlockableInMode = 49,
+    GameDialogUnlockablesHeadingAlreadyUnlocked = 50,
+    GameDialogUnlockablesParagraphNoMoreUnlockable = 51,
+    GameDialogUnlockablesLabelPlusHidden = 52,
     GameDialogSkillsSkill = 53,
     GameDialogSkillsSkillHover = 54,
     GameDialogMapDurability = 55,

package/definitions/game/resource/IResourceLoader.d.ts

@@ -38,16 +38,17 @@ export declare enum PathType {
     Pin = 26,
     Quality = 27,
     RecipeLevel = 28,
-    Sleep = 29,
-    SoundEffect = 30,
-    StatIcon = 31,
-    StatusEffectIcon = 32,
-    StatusEffectOverlay = 33,
-    Terrain = 34,
-    TerrainDecoration = 35,
-    TerrainMound = 36,
-    TerrainTilled = 37,
-    TileEvent = 38,
-    Vehicle = 39,
-    Website = 40
+    SkillIcon = 29,
+    Sleep = 30,
+    SoundEffect = 31,
+    StatIcon = 32,
+    StatusEffectIcon = 33,
+    StatusEffectOverlay = 34,
+    Terrain = 35,
+    TerrainDecoration = 36,
+    TerrainMound = 37,
+    TerrainTilled = 38,
+    TileEvent = 39,
+    Vehicle = 40,
+    Website = 41
 }

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

@@ -54,7 +54,7 @@ export default class Text extends Component {
      */
     hasText(): boolean;
     isEmpty(): boolean;
-    refresh(): this | undefined;
+    refresh(): this;
     dump(filter?: (element: HTMLElement, component?: Component) => boolean): this;
     private readonly refreshEvents;
     /**

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

@@ -10,5 +10,6 @@
  */
 export declare enum SkillSort {
     Name = 0,
-    Level = 1
+    Level = 1,
+    Recent = 2
 }

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

@@ -8,33 +8,33 @@
  * 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 Player from "@wayward/game/game/entity/player/Player";
+import { TitleType } from "@wayward/game/game/entity/action/actions/SetTitle";
 import { Milestone } from "@wayward/game/game/milestones/IMilestone";
+import { ReferenceType } from "@wayward/game/game/reference/IReferenceManager";
+import Translation from "@wayward/game/language/Translation";
+import type Component from "@wayward/game/ui/component/Component";
 import Bindable from "@wayward/game/ui/input/Bindable";
-import Dialog from "@wayward/game/ui/screen/screens/game/component/Dialog";
+import { MilestoneSort } from "@wayward/game/ui/screen/screens/game/dialog/IMilestonesDialog";
+import UnlockablesDialog, { UnlockablesSection } from "@wayward/game/ui/screen/screens/game/dialog/unlockables/UnlockablesDialog";
 import { MenuBarButtonType } from "@wayward/game/ui/screen/screens/game/static/menubar/IMenuBarButton";
-export default class MilestonesDialog extends Dialog {
-    private readonly milestones;
-    private readonly sortRow;
-    private readonly sectionUnlocked;
-    private readonly sectionUnlockableInMode;
-    private readonly sectionNotUnlockableInMode;
-    private readonly sectionHidden;
-    private readonly noticeMilestonesHidden;
-    private sortData;
+export declare enum MilestonesDialogClasses {
+    Main = "game-dialog-milestones"
+}
+export default class MilestonesDialog extends UnlockablesDialog<Milestone, MilestoneSort> {
     constructor();
-    private getHiddenMilestoneCount;
-    private getMilestoneSectionComponent;
     getBindable(): Bindable;
     getIcon(): MenuBarButtonType;
-    protected onDialogLoad(): void;
-    onPlayerChangeTitle(player: Player): void;
-    private hadMilestoneUpdate;
+    protected getUnlockablesName(): Translation;
+    protected getPlayerTitleType(): TitleType;
+    protected getReferenceType(): ReferenceType;
+    protected getSortEnum(): typeof MilestoneSort;
+    protected getDefaultSort(): MilestoneSort;
+    protected getUnlockables(): Milestone[];
+    protected getUnlockableTranslator(milestone: Milestone): SupplierOr<Translation>;
+    protected translateSort(sort: MilestoneSort): Translation;
+    protected getUnlockableSection(milestone: Milestone): UnlockablesSection;
+    protected getProgress(milestone: Milestone): number;
+    protected sortUnlockables(sort: MilestoneSort): ([a]: [Milestone, Component], [b]: [Milestone, Component]) => number;
+    protected getFilterString(milestone: Milestone): string;
     onMilestoneUpdate(_: any, milestone: Milestone): void;
-    protected onTickEnd(): void;
-    private sortHash?;
-    private sort;
-    private sortMilestones;
-    private filter;
-    private getFilterString;
 }

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

@@ -8,27 +8,36 @@
  * 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 Player from "@wayward/game/game/entity/player/Player";
+import { SkillType } from "@wayward/game/game/entity/IHuman";
+import { TitleType } from "@wayward/game/game/entity/action/actions/SetTitle";
+import { ReferenceType } from "@wayward/game/game/reference/IReferenceManager";
+import Translation from "@wayward/game/language/Translation";
+import type Component from "@wayward/game/ui/component/Component";
 import Bindable from "@wayward/game/ui/input/Bindable";
-import Dialog from "@wayward/game/ui/screen/screens/game/component/Dialog";
+import { SkillSort } from "@wayward/game/ui/screen/screens/game/dialog/ISkillsDialog";
+import UnlockablesDialog, { UnlockablesSection } from "@wayward/game/ui/screen/screens/game/dialog/unlockables/UnlockablesDialog";
 import { MenuBarButtonType } from "@wayward/game/ui/screen/screens/game/static/menubar/IMenuBarButton";
-export default class SkillsDialog extends Dialog {
-    private readonly skills;
-    private readonly inputFilter;
-    private readonly sortRow;
-    private sortData;
+import type { HighlightSelector, IHighlight } from "@wayward/game/ui/util/IHighlight";
+export default class SkillsDialog extends UnlockablesDialog<SkillType, SkillSort> {
     constructor();
     getBindable(): Bindable;
     getIcon(): MenuBarButtonType;
-    protected onDialogLoad(): void;
-    protected onDialogRemove(): void;
-    private updateSkill;
-    onPlayerChangeTitle(player: Player): void;
-    private sort;
-    private sortSkills;
-    private filter;
-    private shouldShowSkill;
-    private getFilterString;
-    private getSkillReadout;
+    protected getUnlockablesName(): Translation;
+    protected getUnlockableSection(skill: SkillType): UnlockablesSection;
+    protected getUnlockables(): readonly SkillType[];
+    protected getSortEnum(): typeof SkillSort;
+    protected translateSort(sort: SkillSort): Translation;
+    protected getPlayerTitleType(): TitleType;
+    protected getDefaultSort(): SkillSort;
+    protected getReferenceType(): ReferenceType;
+    protected canSetTitle(skill: SkillType): boolean;
+    protected getUnlockableTranslator(skill: SkillType): SupplierOr<Translation>;
+    protected getProgress(skill: SkillType): number;
+    protected getHighlightSelector(skill: SkillType): HighlightSelector | undefined;
+    protected getHighlight(skill: SkillType): IHighlight | undefined;
+    protected sortUnlockables(sort: SkillSort): ([a]: [SkillType, Component], [b]: [SkillType, Component]) => number;
+    protected shouldShowUnlockable(skill: SkillType, filterText: string): boolean;
+    protected getFilterString(skill: SkillType): string;
     private getMagicalItems;
+    protected updateSkill(_: any, skill: SkillType): void;
 }

package/definitions/game/ui/screen/screens/game/dialog/unlockables/UnlockablesDialog.d.ts

@@ -0,0 +1,70 @@
+/*!
+ * 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 { TitleType } from "@wayward/game/game/entity/action/actions/SetTitle";
+import type Player from "@wayward/game/game/entity/player/Player";
+import type { ReferenceType } from "@wayward/game/game/reference/IReferenceManager";
+import Translation from "@wayward/game/language/Translation";
+import Button from "@wayward/game/ui/component/Button";
+import Component from "@wayward/game/ui/component/Component";
+import { Paragraph } from "@wayward/game/ui/component/Text";
+import { DialogId } from "@wayward/game/ui/screen/screens/game/Dialogs";
+import Dialog from "@wayward/game/ui/screen/screens/game/component/Dialog";
+import DialogSortFilter from "@wayward/game/ui/screen/screens/game/component/DialogSortFilter";
+import type { HighlightSelector, IHighlight } from "@wayward/game/ui/util/IHighlight";
+export declare enum UnlockablesDialogClasses {
+    Main = "game-dialog-unlockables",
+    Section = "game-dialog-unlockables-section",
+    SectionHeading = "game-dialog-unlockables-section-heading",
+    Row = "game-dialog-unlockables-row",
+    Notice = "game-dialog-unlockables-notice"
+}
+export declare enum UnlockablesSection {
+    Unlocked = 0,
+    UnlockableInMode = 1,
+    NotUnlockableInMode = 2,
+    Hidden = 3
+}
+export default abstract class UnlockablesDialog<UNLOCKABLE extends number, SORT extends number> extends Dialog {
+    readonly rows: Map<UNLOCKABLE, Button>;
+    readonly sectionUnlocked: Component;
+    readonly sectionUnlockableInMode: Component;
+    readonly sectionNotUnlockableInMode: Component;
+    readonly sectionHidden: Component;
+    readonly noticeRowsHidden: Paragraph;
+    readonly sortFilterRow: DialogSortFilter<SORT>;
+    constructor(id: DialogId);
+    protected abstract getUnlockablesName(): Translation;
+    protected abstract getSortEnum(): any;
+    protected abstract getDefaultSort(): SORT;
+    protected abstract translateSort(sort: SORT): Translation;
+    protected abstract getUnlockables(): readonly UNLOCKABLE[];
+    protected abstract getPlayerTitleType(): TitleType;
+    protected abstract getUnlockableSection(unlockable: UNLOCKABLE): UnlockablesSection;
+    protected abstract getProgress(unlockable: UNLOCKABLE): number;
+    protected abstract getReferenceType(): ReferenceType;
+    protected abstract getUnlockableTranslator(unlockable: UNLOCKABLE): SupplierOr<Translation>;
+    protected abstract sortUnlockables(sort: SORT): ([a]: [UNLOCKABLE, Component], [b]: [UNLOCKABLE, Component]) => number;
+    protected abstract getFilterString(unlockable: UNLOCKABLE): string;
+    protected getHighlight?(unlockable: UNLOCKABLE): IHighlight | undefined;
+    protected getHighlightSelector?(unlockable: UNLOCKABLE): HighlightSelector | undefined;
+    protected canSetTitle(unlockable: UNLOCKABLE): boolean;
+    protected shouldShowUnlockable(unlockable: UNLOCKABLE, filterText: string): boolean;
+    protected getSectionComponent(section: UnlockablesSection): Component;
+    protected getHiddenCount(): number;
+    onPlayerChangeTitle(player: Player): void;
+    private getTitleTypeName;
+    private hadUpdate;
+    protected refreshUnlockable(unlockable: UNLOCKABLE): void;
+    protected onTickEnd(): void;
+    private sortHash?;
+    private sort;
+    private filter;
+}

package/package.json

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