@wayward/types 2.13.2-beta.dev.20230606.2 → 2.13.2-beta.dev.20230608.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. package/definitions/game/game/biome/IBiome.d.ts +13 -0
  2. package/definitions/game/game/biome/arid/Arid.d.ts +16 -0
  3. package/definitions/game/game/biome/coastal/Coastal.d.ts +16 -0
  4. package/definitions/game/game/biome/iceCap/IceCap.d.ts +16 -0
  5. package/definitions/game/game/biome/volcanic/Volcanic.d.ts +16 -0
  6. package/definitions/game/game/biome/wetlands/Wetlands.d.ts +16 -0
  7. package/definitions/game/game/deity/IDeities.d.ts +68 -0
  8. package/definitions/game/game/entity/Entity.d.ts +2 -1
  9. package/definitions/game/game/entity/IEntity.d.ts +5 -5
  10. package/definitions/game/game/entity/action/actions/UpdateDirection.d.ts +3 -1
  11. package/definitions/game/game/entity/action/usable/IUsableAction.d.ts +1 -1
  12. package/definitions/game/game/inspection/InfoProvider.d.ts +10 -10
  13. package/definitions/game/game/inspection/infoProviders/stat/AttackInfo.d.ts +2 -5
  14. package/definitions/game/game/inspection/infoProviders/stat/DefenseInfo.d.ts +2 -5
  15. package/definitions/game/game/inspection/infoProviders/stat/FerocityInfo.d.ts +28 -0
  16. package/definitions/game/game/inspection/infoProviders/stat/StatInfo.d.ts +20 -0
  17. package/definitions/game/game/inspection/inspections/StatInspection.d.ts +4 -2
  18. package/definitions/game/game/meta/prompt/IPrompt.d.ts +38 -37
  19. package/definitions/game/game/meta/prompt/PromptDescriptions.d.ts +1 -0
  20. package/definitions/game/language/Dictionary.d.ts +81 -80
  21. package/definitions/game/language/DictionaryMap.d.ts +159 -156
  22. package/definitions/game/language/dictionary/UiTranslation.d.ts +620 -626
  23. package/definitions/game/language/english/game/FerocityLevels.d.ts +13 -0
  24. package/definitions/game/mod/IModManager.d.ts +4 -3
  25. package/definitions/game/steamworks/Steamworks.d.ts +3 -2
  26. package/definitions/game/ui/input/Bindable.d.ts +12 -0
  27. package/definitions/game/ui/input/Bindables.d.ts +3 -1
  28. package/definitions/game/ui/screen/screens/game/dialog/EquipmentDialog.d.ts +2 -2
  29. package/definitions/game/ui/screen/screens/game/static/ActionBar.d.ts +2 -2
  30. package/definitions/game/ui/screen/screens/game/static/stats/{Reputation.d.ts → Ferocity.d.ts} +5 -0
  31. package/definitions/game/ui/screen/screens/game/static/stats/IStatDisplayDescription.d.ts +2 -2
  32. package/definitions/game/ui/screen/screens/game/static/stats/component/Stat.d.ts +4 -4
  33. package/definitions/game/ui/screen/screens/menu/menus/multiplayer/ServerRow.d.ts +1 -1
  34. package/definitions/game/ui/util/Misc.d.ts +1 -0
  35. package/definitions/game/utilities/Version.d.ts +1 -0
  36. package/definitions/hosts/shared/interfaces.d.ts +3 -2
  37. package/package.json +1 -1
  38. /package/definitions/game/ui/screen/screens/game/component/{Item.d.ts → ItemComponent.d.ts} +0 -0
@@ -0,0 +1,13 @@
1
+ /*!
2
+ * Copyright 2011-2023 Unlok
3
+ * https://www.unlok.ca
4
+ *
5
+ * Credits & Thanks:
6
+ * https://www.unlok.ca/credits-thanks/
7
+ *
8
+ * 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:
9
+ * https://github.com/WaywardGame/types/wiki
10
+ */
11
+ import { FerocityLevel } from "game/deity/IDeities";
12
+ declare const ferocityLevels: Record<FerocityLevel, string>;
13
+ export default ferocityLevels;
@@ -10,11 +10,11 @@
10
10
  */
11
11
  export type ICanLoadInfo = {
12
12
  name: string;
13
- loadable: true;
13
+ loadable: CanLoadState.Loadable;
14
14
  index: number;
15
15
  } | {
16
16
  name: string;
17
- loadable: false;
17
+ loadable: CanLoadState.NotFound | CanLoadState.ModLoadError;
18
18
  };
19
19
  export declare enum CanLoadState {
20
20
  Loadable = 0,
@@ -29,7 +29,8 @@ export declare enum CanLoadState {
29
29
  WorkshopModPrecedence = 9,
30
30
  IncompatibleVersion = 10,
31
31
  DisabledInMultiplayer = 11,
32
- ServerSideOnNonDedicatedServer = 12
32
+ ServerSideOnNonDedicatedServer = 12,
33
+ NotFound = 13
33
34
  }
34
35
  export declare enum ModLoadFailureReason {
35
36
  IsDisabled = 0,
@@ -122,14 +122,15 @@ export default class Steamworks extends EventEmitter.Host<ISteamworksEvents> {
122
122
  createArchive(id: string): Promise<void>;
123
123
  getPublishedItems(): Promise<IWorkshopItem[]>;
124
124
  openUrl(url: string): void;
125
- openWorkshop(publishId?: string): Promise<void>;
125
+ openWorkshop(publishFileId?: string): Promise<void>;
126
126
  openInviteDialog(): void;
127
127
  openSaveFolder(): void;
128
128
  openModsFolder(): Promise<void>;
129
129
  openModFolder(modIndex: number): Promise<void>;
130
130
  openLogsFolder(): void;
131
131
  openBackupsFolder(): void;
132
- unsubscribe(publishId: string): Promise<void>;
132
+ subscribe(publishFileIds: string[]): Promise<void>;
133
+ unsubscribe(publishFileId: string): Promise<void>;
133
134
  toggleDeveloperTools(): Promise<void>;
134
135
  getModPath(name: string, modType: ModType, file?: string, checkIfExists?: boolean): Promise<IModPath | undefined>;
135
136
  getModPathSync(name: string, modType: ModType, file?: string): IModPath | undefined;
@@ -233,3 +233,15 @@ export declare enum BindableType {
233
233
  Developer = 6,
234
234
  Mod = 7
235
235
  }
236
+ export declare enum BindableTypeContext {
237
+ Default = 0,
238
+ ActionMenu = 1,
239
+ Mod = 2
240
+ }
241
+ export declare const BINDABLE_TYPE_CONTEXTS: Record<BindableType, BindableTypeContext>;
242
+ export declare enum BindableMouseTargetingContext {
243
+ Generic = 0,
244
+ World = 1,
245
+ Item = 2
246
+ }
247
+ export declare const MOUSE_TARGETING_BINDABLE_CONTEXTS: Record<BindableMouseTargetingContext, Bindable[]>;
@@ -9,11 +9,13 @@
9
9
  * https://github.com/WaywardGame/types/wiki
10
10
  */
11
11
  import type Bindable from "ui/input/Bindable";
12
- import { BindableType } from "ui/input/Bindable";
12
+ import { BindableMouseTargetingContext, BindableType, BindableTypeContext } from "ui/input/Bindable";
13
13
  import type { Binding } from "ui/input/Bindings";
14
14
  declare module Bindables {
15
15
  function register(index: number, defaultBinding: Binding[]): void;
16
16
  function deregister(index: number): void;
17
17
  function getType(bindable: Bindable): BindableType | undefined;
18
+ function getContext(bindable: Bindable): BindableTypeContext;
19
+ function getMouseContext(bindable: Bindable): BindableMouseTargetingContext | undefined;
18
20
  }
19
21
  export default Bindables;
@@ -14,8 +14,8 @@ import Component from "ui/component/Component";
14
14
  import type { IBindHandlerApi } from "ui/input/Bind";
15
15
  import Bindable from "ui/input/Bindable";
16
16
  import Dialog from "ui/screen/screens/game/component/Dialog";
17
- import type { IItemDropApi, IItemPickUpApi, ItemSlot } from "ui/screen/screens/game/component/Item";
18
- import ItemComponent, { ItemRefreshType } from "ui/screen/screens/game/component/Item";
17
+ import type { IItemDropApi, IItemPickUpApi, ItemSlot } from "ui/screen/screens/game/component/ItemComponent";
18
+ import ItemComponent, { ItemRefreshType } from "ui/screen/screens/game/component/ItemComponent";
19
19
  import EquipmentSlotTooltipHandler from "ui/screen/screens/game/dialog/equipment/EquipmentSlotTooltip";
20
20
  import { MenuBarButtonType } from "ui/screen/screens/game/static/menubar/IMenuBarButton";
21
21
  export declare enum EquipmentClasses {
@@ -24,8 +24,8 @@ import type { IRefreshable } from "ui/component/Refreshable";
24
24
  import Text from "ui/component/Text";
25
25
  import type { IBindHandlerApi } from "ui/input/Bind";
26
26
  import { Quadrant } from "ui/screen/screens/game/component/IQuadrantComponent";
27
- import type { IItemSlotEvents } from "ui/screen/screens/game/component/Item";
28
- import ItemComponent from "ui/screen/screens/game/component/Item";
27
+ import type { IItemSlotEvents } from "ui/screen/screens/game/component/ItemComponent";
28
+ import ItemComponent from "ui/screen/screens/game/component/ItemComponent";
29
29
  import QuadrantComponent from "ui/screen/screens/game/component/QuadrantComponent";
30
30
  import ActionsConfigurationDrawer from "ui/screen/screens/game/static/actions/ActionsDrawer";
31
31
  import ActionSlotTooltipHandler from "ui/screen/screens/game/static/actions/ActionSlotTooltip";
@@ -8,6 +8,11 @@
8
8
  * 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:
9
9
  * https://github.com/WaywardGame/types/wiki
10
10
  */
11
+ import type Entity from "game/entity/Entity";
11
12
  import { type IStatDisplayDescription } from "ui/screen/screens/game/static/stats/IStatDisplayDescription";
13
+ /**
14
+ * Returns the difficulty translation for the given player's reputation
15
+ */
16
+ export declare function getFerocityTranslation(entity?: Entity): import("../../../../../../language/impl/TranslationImpl").default;
12
17
  declare const reputation: IStatDisplayDescription;
13
18
  export default reputation;
@@ -12,10 +12,10 @@ import type { IHasImagePath } from "game/IObject";
12
12
  import type EntityWithStats from "game/entity/EntityWithStats";
13
13
  import type { IStat, IStatBase, StatDisplayType } from "game/entity/IStats";
14
14
  import type { Reference } from "game/reference/IReferenceManager";
15
+ import type Translation from "language/Translation";
15
16
  import type { IModdable } from "mod/ModRegistry";
16
17
  import type Component from "ui/component/Component";
17
18
  import type Tooltip from "ui/tooltip/Tooltip";
18
- import type { IStringSection } from "utilities/string/Interpolator";
19
19
  export interface IStatDisplayDescription extends IModdable, IHasImagePath<string | ((entity: EntityWithStats, stat: IStat) => string)> {
20
20
  imagePath?: string | ((entity: EntityWithStats, stat: IStat) => string);
21
21
  /**
@@ -52,7 +52,7 @@ export interface IStatDisplayDescription extends IModdable, IHasImagePath<string
52
52
  *
53
53
  * For overriding the normal formatted output of a stat.
54
54
  */
55
- getFormatted?(entity: EntityWithStats, stat?: IStat): IStringSection[];
55
+ getFormatted?(entity: EntityWithStats, stat?: IStat): Translation;
56
56
  /**
57
57
  * A function that will initialize a tooltip for this stat element, or a reference to show a tooltip for
58
58
  */
@@ -12,9 +12,9 @@ import type Entity from "game/entity/Entity";
12
12
  import type EntityWithStats from "game/entity/EntityWithStats";
13
13
  import type { IStatChangeInfo } from "game/entity/IEntity";
14
14
  import type { IStat, IStatMax, Stat } from "game/entity/IStats";
15
+ import Translation from "language/Translation";
15
16
  import Component from "ui/component/Component";
16
17
  import Text from "ui/component/Text";
17
- import type { IStringSection } from "utilities/string/Interpolator";
18
18
  export declare abstract class StatComponent extends Component {
19
19
  private readonly entity;
20
20
  private readonly stat;
@@ -32,7 +32,7 @@ export declare abstract class StatComponent extends Component {
32
32
  *
33
33
  * If `statDescription.getFormatted` is defined, uses this method. Else, generates based on if the stat has a `max`
34
34
  */
35
- getStatValue(): IStringSection[];
35
+ getStatValue(): Translation;
36
36
  /**
37
37
  * Returns the color of this stat.
38
38
  */
@@ -50,7 +50,7 @@ export declare abstract class StatComponent extends Component {
50
50
  /**
51
51
  * Returns the generic string representation of this stat.
52
52
  */
53
- protected getGenericStatValue(stat: IStat): IStringSection[];
53
+ protected getGenericStatValue(stat: IStat): import("../../../../../../../language/impl/TranslationImpl").default;
54
54
  /**
55
55
  * Event handler for when a stat changes. Updates the text, color, icon, and tooltip of this `StatElement`.
56
56
  *
@@ -79,7 +79,7 @@ export declare class Statbar extends StatComponent {
79
79
  constructor(entity: EntityWithStats, stat: Stat, noEvents?: true);
80
80
  getTextElement(): Text;
81
81
  getDisplayElement(): Component<HTMLElement>;
82
- getGenericStatValue(stat: IStatMax): IStringSection[];
82
+ getGenericStatValue(stat: IStatMax): import("../../../../../../../language/impl/TranslationImpl").default;
83
83
  /**
84
84
  * Overrides the superclass method of the same name. Calls the superclass method, then updates the CSS
85
85
  * property `--stat-percent`, to update the statbar's fill width.
@@ -31,7 +31,7 @@ export declare class ServerRow extends Button implements IRefreshable, IGameIcon
31
31
  private _place;
32
32
  constructor(server: IServer, getFriend: (player: string) => ISteamFriend | undefined);
33
33
  refresh(): this;
34
- protected onActivate(): void;
34
+ protected onActivate(_: any, allowModDownloads?: boolean): void;
35
35
  /**
36
36
  * Check if the client can join the server
37
37
  */
@@ -14,6 +14,7 @@ export declare function startGame(gameOptions: IPlayOptions): void;
14
14
  export declare enum ModLoadability {
15
15
  NotEnabled = "notenabled",
16
16
  Enabled = "enabled",
17
+ NotFound = "notfound",
17
18
  Error = "error"
18
19
  }
19
20
  export declare function isModLoadable(publishId?: string): [string, ModLoadability];
@@ -57,6 +57,7 @@ declare module Version {
57
57
  export function getUpdateDisplayTranslation(version?: Version.String | Version.StringSemVer | IVersionInfo): TranslationImpl | undefined;
58
58
  const timezones: {
59
59
  nz: string;
60
+ pst: string;
60
61
  build: string;
61
62
  };
62
63
  export function isTimeBefore(date: Date, dateStr: DateString, timezone: keyof typeof timezones): boolean;
@@ -70,7 +70,8 @@ export interface ISteamworks {
70
70
  getLobbyMembers(lobbyId: string): ISteamFriend[] | undefined;
71
71
  ugcGetUserItems(type: number, sort: number, listType: number, cb: (err: string | null, items: IWorkshopItem[]) => void): void;
72
72
  ugcSynchronizeItems(path: string, cb: (err: string | null, items: IWorkshopItem[]) => void): void;
73
- ugcUnsubscribe(publishId: string, cb: (err: string | null) => void): void;
73
+ ugcSubscribe(publishFileId: string, cb: (err: string | null) => void): void;
74
+ ugcUnsubscribe(publishFileId: string, cb: (err: string | null) => void): void;
74
75
  saveFilesToCloud(files: string[], cb: (err: string | null) => void): void;
75
76
  publishWorkshopFile(path: string, imagePath: string, title: string, description: string, tags: string[], cb: (err: string | null, publishedFileId2: string) => void): void;
76
77
  updatePublishedWorkshopFile(publishFileId: string, path: string, imagePath: string, title: string, description: string, tags: string[], cb: (err: string | null, publishedFileId2: string) => void): void;
@@ -249,7 +250,7 @@ export interface IServerGameDetails {
249
250
  export interface IServerMod {
250
251
  name: string;
251
252
  version: string;
252
- publishFileId: string | undefined;
253
+ publishFileId?: string;
253
254
  }
254
255
  export interface IServerIslandDetails {
255
256
  position: {
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@wayward/types",
3
3
  "description": "TypeScript declarations for Wayward, used for modding.",
4
- "version": "2.13.2-beta.dev.20230606.2",
4
+ "version": "2.13.2-beta.dev.20230608.1",
5
5
  "license": "MIT",
6
6
  "repository": {
7
7
  "type": "git",