@wayward/types 2.14.0-beta.dev.20240915.1 → 2.14.0-beta.dev.20240917.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 (36) hide show
  1. package/definitions/game/game/deity/Deity.d.ts +2 -1
  2. package/definitions/game/game/deity/IDeities.d.ts +2 -1
  3. package/definitions/game/game/entity/Human.d.ts +2 -2
  4. package/definitions/game/game/entity/action/IAction.d.ts +2 -1
  5. package/definitions/game/game/entity/action/actions/Drop.d.ts +6 -1
  6. package/definitions/game/game/entity/action/actions/helper/NotUsableMessage.d.ts +1 -0
  7. package/definitions/game/game/entity/action/actions/moveItem/MoveItemsSourceArgument.d.ts +1 -1
  8. package/definitions/game/game/inspection/inspections/milestone/RunekeeperInspection.d.ts +1 -1
  9. package/definitions/game/game/item/IItemManager.d.ts +4 -0
  10. package/definitions/game/game/item/ItemFinder.d.ts +8 -2
  11. package/definitions/game/game/item/ItemManager.d.ts +7 -0
  12. package/definitions/game/game/item/cooldown/InvokeCooldown.d.ts +13 -0
  13. package/definitions/game/game/magic/MagicalPropertyType.d.ts +1 -1
  14. package/definitions/game/game/milestones/milestone/Runekeeper.d.ts +38 -3
  15. package/definitions/game/game/milestones/milestone/RunekeeperMilestone.d.ts +13 -0
  16. package/definitions/game/game/reference/IReferenceManager.d.ts +1 -1
  17. package/definitions/game/game/reference/ReferenceManager.d.ts +1 -0
  18. package/definitions/game/game/tile/Tile.d.ts +1 -1
  19. package/definitions/game/language/DictionaryMap.d.ts +2 -2
  20. package/definitions/game/language/Translation.d.ts +2 -2
  21. package/definitions/game/language/dictionary/Message.d.ts +639 -638
  22. package/definitions/game/language/english/game/Deities.d.ts +1 -1
  23. package/definitions/game/language/english/game/DeitySymbols.d.ts +1 -1
  24. package/definitions/game/language/english/ui/RunekeeperDomainEvents.d.ts +1 -1
  25. package/definitions/game/language/english/ui/RunekeeperDomains.d.ts +1 -1
  26. package/definitions/game/ui/component/Dropdown.d.ts +7 -0
  27. package/definitions/game/ui/component/RangeRow.d.ts +4 -1
  28. package/definitions/game/ui/screen/screens/game/component/DialogSortFilter.d.ts +1 -0
  29. package/definitions/game/ui/screen/screens/game/static/stats/component/{Stat.d.ts → StatComponent.d.ts} +1 -1
  30. package/definitions/game/ui/screen/screens/game/util/item/ItemStylesheet.d.ts +1 -0
  31. package/definitions/game/ui/util/ScaleManager.d.ts +3 -1
  32. package/definitions/game/utilities/Observer.d.ts +9 -4
  33. package/definitions/utilities/promise/Async.d.ts +2 -0
  34. package/package.json +1 -1
  35. package/definitions/game/game/milestones/milestone/IRunekeeper.d.ts +0 -48
  36. /package/definitions/game/game/options/modifiers/milestone/modifiers/{Runekeeper.d.ts → RunekeeperModifier.d.ts} +0 -0
@@ -9,7 +9,7 @@
9
9
  * https://github.com/WaywardGame/types/wiki
10
10
  */
11
11
  import { SfxType } from "@wayward/game/audio/IAudio";
12
- export declare enum Deity {
12
+ declare enum Deity {
13
13
  Single = -2,
14
14
  All = -1,
15
15
  None = 0,
@@ -17,6 +17,7 @@ export declare enum Deity {
17
17
  Chaos = 2,
18
18
  Good = 3
19
19
  }
20
+ export default Deity;
20
21
  export type DeityReal = Exclude<Deity, Deity.All | Deity.Single | Deity.None>;
21
22
  export declare namespace DeityReal {
22
23
  function is(value: unknown): value is DeityReal;
@@ -8,7 +8,8 @@
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 { Deity, DeityReal } from "@wayward/game/game/deity/Deity";
11
+ import type Deity from "@wayward/game/game/deity/Deity";
12
+ import type { DeityReal } from "@wayward/game/game/deity/Deity";
12
13
  export type RuneChance = [deity: ArrayOr<DeityReal>, chance: number];
13
14
  /**
14
15
  * The maximum chance of a rune dropping that can come from the base chance.
@@ -11,7 +11,7 @@
11
11
  import { FireType } from "@wayward/game/game/IGame";
12
12
  import type { Quality } from "@wayward/game/game/IObject";
13
13
  import type { DeityReal } from "@wayward/game/game/deity/Deity";
14
- import { Deity } from "@wayward/game/game/deity/Deity";
14
+ import Deity from "@wayward/game/game/deity/Deity";
15
15
  import Doodad from "@wayward/game/game/doodad/Doodad";
16
16
  import type Entity from "@wayward/game/game/entity/Entity";
17
17
  import EntityWithStats from "@wayward/game/game/entity/EntityWithStats";
@@ -44,7 +44,7 @@ import type Item from "@wayward/game/game/item/Item";
44
44
  import ItemReference from "@wayward/game/game/item/ItemReference";
45
45
  import { MagicalPropertyType } from "@wayward/game/game/magic/MagicalPropertyType";
46
46
  import { Milestone } from "@wayward/game/game/milestones/IMilestone";
47
- import Runekeeper from "@wayward/game/game/milestones/milestone/IRunekeeper";
47
+ import Runekeeper from "@wayward/game/game/milestones/milestone/Runekeeper";
48
48
  import type { IGameOptionsPlayer } from "@wayward/game/game/options/IGameOptions";
49
49
  import type { Reference, ReferenceType } from "@wayward/game/game/reference/IReferenceManager";
50
50
  import type { IHasInsulation } from "@wayward/game/game/temperature/ITemperature";
@@ -9,7 +9,8 @@
9
9
  * https://github.com/WaywardGame/types/wiki
10
10
  */
11
11
  import type { SfxType } from "@wayward/game/audio/IAudio";
12
- import type { Deity, DeityReal } from "@wayward/game/game/deity/Deity";
12
+ import type Deity from "@wayward/game/game/deity/Deity";
13
+ import type { DeityReal } from "@wayward/game/game/deity/Deity";
13
14
  import type Doodad from "@wayward/game/game/doodad/Doodad";
14
15
  import type Entity from "@wayward/game/game/entity/Entity";
15
16
  import type Human from "@wayward/game/game/entity/Human";
@@ -43,12 +43,17 @@ interface IResolvedTileDrop {
43
43
  into: IContainer;
44
44
  blocker?: Translation;
45
45
  }
46
- export declare function resolveTileDrop(human: Human, tile?: Tile, items?: MoveItemsSourceArgumentResolvable): IResolvedTileDrop;
46
+ export declare function resolveTileDrop(human: Human | undefined, tile: Tile, items?: MoveItemsSourceArgumentResolvable, dropIntoContainers?: boolean): IResolvedTileDrop;
47
+ export declare function resolveTileDrop(human: Human, tile?: Tile, items?: MoveItemsSourceArgumentResolvable, dropIntoContainers?: boolean): IResolvedTileDrop;
47
48
  export interface IDropCanUse {
48
49
  items: Item[];
49
50
  tile: Tile;
50
51
  into?: IContainer;
51
52
  }
53
+ export declare function drop(human: Human | undefined, into: IContainer, items: Item[]): {
54
+ itemsDropped: Item[];
55
+ failedDrops: Item[];
56
+ };
52
57
  declare const _default: Action<[[arg1: ActionArgument.Undefined, ActionArgument.ItemNearbyIncludingTradeContainer, ActionArgument.ItemArrayNearbyIncludingTradeContainer, MoveItemsSourceArgument], [arg1: ActionArgument.Undefined, DropItemFilterArgument]], Human<unknown, number, import("../../../reference/IReferenceManager").ReferenceType.NPC | import("../../../reference/IReferenceManager").ReferenceType.Player>, void, {
53
58
  usable: true;
54
59
  items: Item[];
@@ -57,6 +57,7 @@ export declare const NotUsableMessageItemOrDoodad: NotUsableMessage.IFactory<[Do
57
57
  args: (itemOrDoodad: Doodad | Item | undefined) => import("../../../../../language/impl/TranslationImpl").default | undefined;
58
58
  sources: Source.Action[];
59
59
  }>;
60
+ export declare const NotUsableMessageCannotHere: (action: ActionType) => IActionNotUsable;
60
61
  export declare const NotUsableMessageCannotFromHere: (action: ActionType) => IActionNotUsable;
61
62
  export declare const NotUsableMessageCannotAnythingHere: (action: ActionType) => IActionNotUsable;
62
63
  export {};
@@ -13,7 +13,7 @@ import type Human from "@wayward/game/game/entity/Human";
13
13
  import type { IActionNotUsable, IActionUsable } from "@wayward/game/game/entity/action/IAction";
14
14
  import { ActionArgument } from "@wayward/game/game/entity/action/IAction";
15
15
  import { ActionArgumentCustom } from "@wayward/game/game/entity/action/argument/ActionArgumentCustom";
16
- import Island from "@wayward/game/game/island/Island";
16
+ import type Island from "@wayward/game/game/island/Island";
17
17
  import type { IContainer } from "@wayward/game/game/item/IItem";
18
18
  import Item from "@wayward/game/game/item/Item";
19
19
  import type Translation from "@wayward/game/language/Translation";
@@ -9,7 +9,7 @@
9
9
  * https://github.com/WaywardGame/types/wiki
10
10
  */
11
11
  import type { CollapsibleInfoProviderTabs } from "@wayward/game/game/inspection/infoProviders/CollapsableInfoProvider";
12
- import Runekeeper from "@wayward/game/game/milestones/milestone/IRunekeeper";
12
+ import Runekeeper from "@wayward/game/game/milestones/milestone/Runekeeper";
13
13
  declare namespace RunekeeperInspection {
14
14
  enum Classes {
15
15
  Main = "inspection-type-milestone-runekeeper",
@@ -14,6 +14,7 @@ import type DoodadManager from "@wayward/game/game/doodad/DoodadManager";
14
14
  import type { DoodadType, DoodadTypeGroup } from "@wayward/game/game/doodad/IDoodad";
15
15
  import type { ActionType, IActionNotUsable } from "@wayward/game/game/entity/action/IAction";
16
16
  import type ActionContext from "@wayward/game/game/entity/action/IActionContext";
17
+ import type { DropAllowProtected } from "@wayward/game/game/entity/action/actions/Drop";
17
18
  import { NotUsableMessage } from "@wayward/game/game/entity/action/actions/helper/NotUsableMessage";
18
19
  import type Creature from "@wayward/game/game/entity/creature/Creature";
19
20
  import type { ContainerSort, IContainer, IMoveToTileOptions, ItemType, ItemTypeGroup } from "@wayward/game/game/item/IItem";
@@ -121,6 +122,7 @@ export interface IMoveItemOptions {
121
122
  itemQuality?: Quality;
122
123
  filterText?: string;
123
124
  };
125
+ dropAllowProtected?: DropAllowProtected;
124
126
  skipMessage?: boolean;
125
127
  skipSound?: boolean;
126
128
  skipTileUpdate?: boolean;
@@ -132,6 +134,7 @@ export interface IMoveItemOptions {
132
134
  updateView?: true;
133
135
  isTrading?: boolean;
134
136
  revertFromDoodad?: boolean;
137
+ skipDrop?: true;
135
138
  context?: ActionContext;
136
139
  }
137
140
  export interface IPlaceOnTileOptions {
@@ -170,6 +173,7 @@ export interface IAddToContainerResult {
170
173
  itemsMoved: Item[];
171
174
  noMoreRoomForItems: Item[];
172
175
  topLevelContainer?: IContainer;
176
+ dropped?: true;
173
177
  }
174
178
  export interface IContainerOld extends Omit<IContainer, "addOrder"> {
175
179
  itemOrders?: number[];
@@ -35,16 +35,19 @@ declare class ItemFinder extends EventEmitter.Host<IItemFinderEvents> {
35
35
  private trackedContainers?;
36
36
  private trackedItems?;
37
37
  private foundItemIds?;
38
+ private foundItemBest?;
38
39
  get human(): Human | undefined;
39
40
  get container(): IContainer | undefined;
40
41
  readonly observe: Observer.IRegistrar<this>;
42
+ readonly observePostFilter: Observer.IRegistrar<this>;
41
43
  constructor(human: Human, container: IContainer, options?: IItemFinderOptions);
42
44
  best(): Item | undefined;
43
45
  all(): Item[];
44
46
  markDirty(): void;
47
+ markDirtyPostFilter(): void;
45
48
  track(): this;
46
49
  dispose(): this;
47
- protected onItemStateChange(item: Item): void;
50
+ protected onItemStateChange(item: Item, event: "durabilityChange" | "toggleProtected" | "qualityChange" | "transformed"): void;
48
51
  protected onContainerItemAdd(items: ItemManager, itemsAdded: Item[], containerAddedTo: IContainer): void;
49
52
  protected onContainerItemRemove(items: ItemManager, itemsRemoved: Item[], containerRemovedFrom?: IContainer): void;
50
53
  protected onPlayerEvent(player: Player): void;
@@ -67,7 +70,10 @@ declare namespace ItemFinder {
67
70
  register(finder: ItemFinder): void;
68
71
  deregister(finder: ItemFinder): void;
69
72
  dispose(): void;
70
- protected onItemStateChange(item: Item): void;
73
+ protected onItemDurabilityChange(item: Item): void;
74
+ protected onItemToggleProtected(item: Item): void;
75
+ protected onItemQualityChange(item: Item): void;
76
+ protected onItemTransformed(item: Item): void;
71
77
  protected onContainerItemAdd(items: ItemManager, itemsAdded: Item[], containerAddedTo: IContainer): void;
72
78
  protected onContainerItemRemove(items: ItemManager, itemsRemoved: Item[], containerRemovedFrom?: IContainer): void;
73
79
  protected onPlayerEvent(player: Player): void;
@@ -385,6 +385,13 @@ export default class ItemManager extends EntityManager<Item, IItemRemoveOptions>
385
385
  * @param craftingFilter True if we are filtering the crafting dialog.
386
386
  */
387
387
  static isFiltered(item: ItemType | Item, filterText: string, craftingFilter?: boolean): boolean;
388
+ /**
389
+ * Returns `true` if the item type or item is filtered out from inventory/crafting/container dialogs.
390
+ * @param item The ItemType or Item to check.
391
+ * @param filterText The string of text in which to filter for.
392
+ * @param craftingFilter True if we are filtering the crafting dialog.
393
+ */
394
+ isFiltered(item: ItemType | Item, filterText: string, craftingFilter?: boolean): boolean;
388
395
  /**
389
396
  * Summons a void dweller based on item worth and chance or provides a hint message.
390
397
  * @param item Item to get the worth of.
@@ -0,0 +1,13 @@
1
+ /*!
2
+ * Copyright 2011-2024 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 type Human from "@wayward/game/game/entity/Human";
12
+ import type Item from "@wayward/game/game/item/Item";
13
+ export default function (item: Item, human: Human, type?: import("../IItem").ItemType, description?: Readonly<import("../IItem").IItemDescription> | undefined): number | undefined;
@@ -8,7 +8,7 @@
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 { Deity } from "@wayward/game/game/deity/Deity";
11
+ import Deity from "@wayward/game/game/deity/Deity";
12
12
  import { DamageType } from "@wayward/game/game/entity/IEntity";
13
13
  import { SkillType } from "@wayward/game/game/entity/IHuman";
14
14
  import { Stat } from "@wayward/game/game/entity/IStats";
@@ -8,6 +8,41 @@
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 MilestoneDefinition from "@wayward/game/game/milestones/MilestoneDefinition";
12
- declare const _default: (() => MilestoneDefinition) & Empty;
13
- export default _default;
11
+ import type { RuneChance } from "@wayward/game/game/deity/IDeities";
12
+ import type { ActionType } from "@wayward/game/game/entity/action/IAction";
13
+ import type { CreatureType } from "@wayward/game/game/entity/creature/ICreature";
14
+ import type { SkillType } from "@wayward/game/game/entity/IHuman";
15
+ import type { NPCType } from "@wayward/game/game/entity/npc/INPCs";
16
+ import type { ItemType } from "@wayward/game/game/item/IItem";
17
+ declare namespace Runekeeper {
18
+ enum Domain {
19
+ Action = 0,
20
+ Skill = 1,
21
+ KillCreature = 2,
22
+ TameCreature = 3,
23
+ KillNPC = 4,
24
+ Event = 5,
25
+ Craft = 6
26
+ }
27
+ type DomainName = Lowercase<keyof typeof Domain>;
28
+ const DOMAINS: ("action" | "event" | "craft" | "skill" | "killcreature" | "tamecreature" | "killnpc")[];
29
+ type DomainData = `${DomainName}:${number}`;
30
+ function domainName(domain: Domain): DomainName;
31
+ function isDiscovered(domain: DomainData): boolean;
32
+ function action(type: ActionType): DomainData;
33
+ function skill(type: SkillType): DomainData;
34
+ function craft(type: ItemType): DomainData;
35
+ function killCreature(type: CreatureType): DomainData;
36
+ function tameCreature(type: CreatureType): DomainData;
37
+ function killNPC(type: NPCType): DomainData;
38
+ enum Event {
39
+ FireSpread = 0,
40
+ KillAberrant = 1,
41
+ TameAberrant = 2,
42
+ KillPet = 3,
43
+ KillPlayer = 4
44
+ }
45
+ const OTHER_EVENTS: Descriptions<Event, RuneChance>;
46
+ function event(type: Event, runeChanceOverride?: number): [...RuneChance, DomainData];
47
+ }
48
+ export default Runekeeper;
@@ -0,0 +1,13 @@
1
+ /*!
2
+ * Copyright 2011-2024 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 MilestoneDefinition from "@wayward/game/game/milestones/MilestoneDefinition";
12
+ declare const _default: (() => MilestoneDefinition) & Empty;
13
+ export default _default;
@@ -9,7 +9,7 @@
9
9
  * https://github.com/WaywardGame/types/wiki
10
10
  */
11
11
  import { Quality } from "@wayward/game/game/IObject";
12
- import { Deity } from "@wayward/game/game/deity/Deity";
12
+ import Deity from "@wayward/game/game/deity/Deity";
13
13
  import type Doodad from "@wayward/game/game/doodad/Doodad";
14
14
  import { DamageType } from "@wayward/game/game/entity/IEntity";
15
15
  import { EquipType, SkillType } from "@wayward/game/game/entity/IHuman";
@@ -32,6 +32,7 @@ import type Tooltip from "@wayward/game/ui/tooltip/Tooltip";
32
32
  export default class ReferenceManager {
33
33
  private readonly game;
34
34
  static isEnumReference(type: ReferenceType): type is EnumReferenceTypes;
35
+ isEnumReference(type: ReferenceType): type is EnumReferenceTypes;
35
36
  static get(thing: Referenceable): Reference | undefined;
36
37
  static getReferenceType(thing: Value<IReferenceTypeMap>): ReferenceType;
37
38
  private referenceCursor;
@@ -344,7 +344,7 @@ export default class Tile implements IVector4, Partial<ITileContainer>, IFieldOf
344
344
  */
345
345
  clearPuddles(executor: Human): boolean;
346
346
  clearWaste(): void;
347
- checkForHiddenMob(human: Human): void;
347
+ checkForHiddenMob(human?: Human): void;
348
348
  /**
349
349
  * Decrease the depth of a water tile if under 6 connected tiles
350
350
  */
@@ -12,7 +12,7 @@ import { Command } from "@wayward/game/command/ICommand";
12
12
  import { Quality } from "@wayward/game/game/IObject";
13
13
  import { BiomeType } from "@wayward/game/game/biome/IBiome";
14
14
  import { CurseComponent } from "@wayward/game/game/deity/Curse";
15
- import { Deity } from "@wayward/game/game/deity/Deity";
15
+ import Deity from "@wayward/game/game/deity/Deity";
16
16
  import { DoodadType, DoodadTypeExtra, DoodadTypeGroup, GrowingStage } from "@wayward/game/game/doodad/IDoodad";
17
17
  import { CombatDangerLevel, CombatStrength } from "@wayward/game/game/entity/CombatStrengthManager";
18
18
  import { DamageType } from "@wayward/game/game/entity/IEntity";
@@ -47,7 +47,7 @@ import { Load } from "@wayward/game/game/meta/Loading";
47
47
  import { Prompt } from "@wayward/game/game/meta/prompt/IPrompt";
48
48
  import { Milestone } from "@wayward/game/game/milestones/IMilestone";
49
49
  import { DoctorCureMethod, DoctorCureType } from "@wayward/game/game/milestones/milestone/IDoctor";
50
- import Runekeeper from "@wayward/game/game/milestones/milestone/IRunekeeper";
50
+ import Runekeeper from "@wayward/game/game/milestones/milestone/Runekeeper";
51
51
  import { GameMode, UnlockedRecipesStrategy } from "@wayward/game/game/options/IGameOptions";
52
52
  import { Challenge } from "@wayward/game/game/options/modifiers/challenge/IChallenge";
53
53
  import { IslandModifierType } from "@wayward/game/game/options/modifiers/island/IslandModifier";
@@ -11,7 +11,7 @@
11
11
  import type { GameEmitterOrBus } from "@wayward/game/event/EventManager";
12
12
  import type { IHasQuality } from "@wayward/game/game/IObject";
13
13
  import { Quality } from "@wayward/game/game/IObject";
14
- import { Deity } from "@wayward/game/game/deity/Deity";
14
+ import Deity from "@wayward/game/game/deity/Deity";
15
15
  import type { GrowingStage } from "@wayward/game/game/doodad/IDoodad";
16
16
  import { DamageType } from "@wayward/game/game/entity/IEntity";
17
17
  import type { EquipType, SkillType } from "@wayward/game/game/entity/IHuman";
@@ -157,7 +157,7 @@ declare namespace Translation {
157
157
  * Damage types are bit flags, so multiple can be stored in one `DamageType`.
158
158
  * This method returns a translated list of damage types.
159
159
  */
160
- export const damage: (damageTypes: ArrayOr<DamageType>, colorize?: boolean, reformatter?: ((type: DamageType) => Translation) | Translation) => Translation;
160
+ export const damage: (damageTypes: ArrayOr<DamageType>, colorize?: boolean, reformatter?: ((type: DamageType) => Translation | undefined) | Translation) => Translation;
161
161
  export function growthStage(stage: GrowingStage, spores?: boolean): Translation;
162
162
  export function growthStage(stage?: GrowingStage, spores?: boolean): Translation | undefined;
163
163
  export function merge(...content: TranslationArg[]): Translation;