@wayward/types 2.14.0 → 2.14.1-beta.dev.20241215.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 (146) hide show
  1. package/definitions/cplusplus/index.d.ts +2 -0
  2. package/definitions/game/game/Game.d.ts +1 -1
  3. package/definitions/game/game/IObject.d.ts +4 -0
  4. package/definitions/game/game/biome/template/Template.d.ts +3 -2
  5. package/definitions/game/game/deity/Deity.d.ts +1 -0
  6. package/definitions/game/game/doodad/Doodad.d.ts +1 -1
  7. package/definitions/game/game/doodad/IDoodad.d.ts +2 -0
  8. package/definitions/game/game/entity/CombatStrengthManager.d.ts +6 -5
  9. package/definitions/game/game/entity/Entity.d.ts +1 -1
  10. package/definitions/game/game/entity/EntityMovable.d.ts +3 -1
  11. package/definitions/game/game/entity/Human.d.ts +2 -2
  12. package/definitions/game/game/entity/IEntity.d.ts +1 -0
  13. package/definitions/game/game/entity/IHuman.d.ts +0 -1
  14. package/definitions/game/game/entity/action/Action.d.ts +2 -6
  15. package/definitions/game/game/entity/action/ActionExecutor.d.ts +1 -1
  16. package/definitions/game/game/entity/action/ActionsRegistration.d.ts +17 -8
  17. package/definitions/game/game/entity/action/IAction.d.ts +16 -11
  18. package/definitions/game/game/entity/action/actions/{Sacrifice.d.ts → AscendDescend.d.ts} +1 -8
  19. package/definitions/game/game/entity/action/actions/CageCreature.d.ts +1 -1
  20. package/definitions/game/game/entity/action/actions/ClearMessages.d.ts +1 -1
  21. package/definitions/game/game/entity/action/actions/Consecrate.d.ts +43 -0
  22. package/definitions/game/game/entity/action/actions/Craft.d.ts +1 -1
  23. package/definitions/game/game/entity/action/actions/CraftNew.d.ts +1 -1
  24. package/definitions/game/game/entity/action/actions/Dismantle.d.ts +1 -1
  25. package/definitions/game/game/entity/action/actions/Drop.d.ts +1 -1
  26. package/definitions/game/game/entity/action/actions/Eat.d.ts +1 -1
  27. package/definitions/game/game/entity/action/actions/GatherLiquid.d.ts +1 -1
  28. package/definitions/game/game/entity/action/actions/Harvest.d.ts +2 -1
  29. package/definitions/game/game/entity/action/actions/Ignite.d.ts +1 -1
  30. package/definitions/game/game/entity/action/actions/Plant.d.ts +2 -1
  31. package/definitions/game/game/entity/action/actions/SetCreatureAi.d.ts +1 -1
  32. package/definitions/game/game/entity/action/actions/SetCreatureAiAll.d.ts +1 -1
  33. package/definitions/game/game/entity/action/actions/SetTitle.d.ts +1 -1
  34. package/definitions/game/game/entity/action/actions/Stack.d.ts +2 -2
  35. package/definitions/game/game/entity/action/actions/Throw.d.ts +1 -1
  36. package/definitions/game/game/entity/action/usable/IUsableAction.d.ts +2 -1
  37. package/definitions/game/game/entity/action/usable/UsableAction.d.ts +3 -1
  38. package/definitions/game/game/entity/action/usable/UsableActionTranslator.d.ts +6 -6
  39. package/definitions/game/game/entity/action/usable/UsableActionType.d.ts +3 -1
  40. package/definitions/game/game/entity/action/usable/actions/UsableActionsDynamic.d.ts +3 -0
  41. package/definitions/game/game/entity/action/usable/actions/UsableActionsWorld.d.ts +1 -1
  42. package/definitions/game/game/entity/ai/AI.d.ts +7 -7
  43. package/definitions/game/game/entity/creature/zone/CreatureZone.d.ts +4 -3
  44. package/definitions/game/game/entity/creature/zone/CreatureZoneManager.d.ts +2 -2
  45. package/definitions/game/game/entity/creature/zone/ICreatureZone.d.ts +29 -1
  46. package/definitions/game/game/entity/creature/zone/zones/arid/AridCreatures.d.ts +12 -0
  47. package/definitions/game/game/entity/creature/zone/zones/arid/AridDoodadReplacements.d.ts +12 -0
  48. package/definitions/game/game/entity/creature/zone/zones/arid/AridGuardians.d.ts +12 -0
  49. package/definitions/game/game/entity/creature/zone/zones/arid/AridTileReplacements.d.ts +12 -0
  50. package/definitions/game/game/entity/creature/zone/zones/coastal/CoastalCreatures.d.ts +12 -0
  51. package/definitions/game/game/entity/creature/zone/zones/coastal/CoastalDoodadReplacements.d.ts +12 -0
  52. package/definitions/game/game/entity/creature/zone/zones/coastal/CoastalGuardians.d.ts +12 -0
  53. package/definitions/game/game/entity/creature/zone/zones/coastal/CoastalTileReplacements.d.ts +12 -0
  54. package/definitions/game/game/entity/creature/zone/zones/iceCap/IceCapCreatures.d.ts +12 -0
  55. package/definitions/game/game/entity/creature/zone/zones/iceCap/IceCapDoodadReplacements.d.ts +12 -0
  56. package/definitions/game/game/entity/creature/zone/zones/iceCap/IceCapGuardians.d.ts +12 -0
  57. package/definitions/game/game/entity/creature/zone/zones/iceCap/IceCapTileReplacements.d.ts +12 -0
  58. package/definitions/game/game/entity/creature/zone/zones/volcanic/VolcanicCreatures.d.ts +12 -0
  59. package/definitions/game/game/entity/creature/zone/zones/volcanic/VolcanicDoodadReplacements.d.ts +12 -0
  60. package/definitions/game/game/entity/creature/zone/zones/volcanic/VolcanicGuardians.d.ts +12 -0
  61. package/definitions/game/game/entity/creature/zone/zones/volcanic/VolcanicTileReplacements.d.ts +12 -0
  62. package/definitions/game/game/entity/creature/zone/zones/wetlands/WetlandsCreatures.d.ts +12 -0
  63. package/definitions/game/game/entity/creature/zone/zones/wetlands/WetlandsDoodadReplacements.d.ts +12 -0
  64. package/definitions/game/game/entity/creature/zone/zones/wetlands/WetlandsGuardians.d.ts +12 -0
  65. package/definitions/game/game/entity/creature/zone/zones/wetlands/WetlandsTileReplacements.d.ts +12 -0
  66. package/definitions/game/game/entity/flowfield/FlowFieldManager.d.ts +1 -1
  67. package/definitions/game/game/entity/player/IPlayer.d.ts +3 -4
  68. package/definitions/game/game/entity/player/quest/quest/Quest.d.ts +1 -0
  69. package/definitions/game/game/entity/status/IStatus.d.ts +3 -0
  70. package/definitions/game/game/inspection/InfoProvider.d.ts +3 -0
  71. package/definitions/game/game/inspection/Inspection.d.ts +1 -0
  72. package/definitions/game/game/inspection/infoProviders/item/use/ItemConsumeInfo.d.ts +1 -2
  73. package/definitions/game/game/inspection/infoProviders/item/use/ItemEquipInfo.d.ts +5 -8
  74. package/definitions/game/game/island/IIsland.d.ts +1 -1
  75. package/definitions/game/game/island/Island.d.ts +1 -1
  76. package/definitions/game/game/island/automation/Automation.d.ts +12 -3
  77. package/definitions/game/game/island/automation/AutomationStep.d.ts +1 -0
  78. package/definitions/game/game/island/automation/IAutomation.d.ts +103 -8
  79. package/definitions/game/game/island/automation/steps/ExecuteAction.d.ts +1 -1
  80. package/definitions/game/game/item/IItem.d.ts +25 -4
  81. package/definitions/game/game/item/IItemManager.d.ts +7 -3
  82. package/definitions/game/game/item/Item.d.ts +1 -0
  83. package/definitions/game/game/item/ItemFinder.d.ts +1 -0
  84. package/definitions/game/game/item/ItemManager.d.ts +6 -6
  85. package/definitions/game/game/magic/MagicalPropertyManager.d.ts +1 -3
  86. package/definitions/game/game/mapgen/IMapGen.d.ts +1 -1
  87. package/definitions/game/game/meta/prompt/IPrompt.d.ts +85 -83
  88. package/definitions/game/game/meta/prompt/PromptDescriptions.d.ts +2 -0
  89. package/definitions/game/game/milestones/MilestoneDefinition.d.ts +4 -4
  90. package/definitions/game/game/milestones/milestone/Runekeeper.d.ts +6 -2
  91. package/definitions/game/game/options/modifiers/milestone/modifiers/Versatile.d.ts +8 -2
  92. package/definitions/game/game/reference/IReferenceManager.d.ts +2 -2
  93. package/definitions/game/game/tile/Tile.d.ts +6 -4
  94. package/definitions/game/game/tile/TileEventManager.d.ts +5 -0
  95. package/definitions/game/language/DictionaryMap.d.ts +8 -8
  96. package/definitions/game/language/Translation.d.ts +9 -4
  97. package/definitions/game/language/dictionary/Message.d.ts +829 -848
  98. package/definitions/game/language/dictionary/Misc.d.ts +68 -69
  99. package/definitions/game/language/dictionary/Note.d.ts +1 -2
  100. package/definitions/game/language/dictionary/UiTranslation.d.ts +906 -924
  101. package/definitions/game/language/english/ui/RunekeeperDomains.d.ts +1 -1
  102. package/definitions/game/language/impl/TranslationImpl.d.ts +1 -0
  103. package/definitions/game/multiplayer/IMultiplayer.d.ts +68 -67
  104. package/definitions/game/renderer/IRenderer.d.ts +26 -24
  105. package/definitions/game/renderer/notifier/INotifier.d.ts +3 -1
  106. package/definitions/game/save/data/ISaveDataGlobal.d.ts +3 -0
  107. package/definitions/game/save/serializer/Serializer.d.ts +2 -1
  108. package/definitions/game/save/upgrade/UpgradeVersion.d.ts +3 -1
  109. package/definitions/game/save/upgrade/versions/beta2.14.0/beta2.14.0-dev20241129.d.ts +12 -0
  110. package/definitions/game/steamworks/Steamworks.d.ts +7 -0
  111. package/definitions/game/ui/ServerJoinHandler.d.ts +1 -0
  112. package/definitions/game/ui/Ui.d.ts +1 -0
  113. package/definitions/game/ui/component/Component.d.ts +2 -1
  114. package/definitions/game/ui/input/Bindable.d.ts +222 -222
  115. package/definitions/game/ui/screen/screens/GameScreen.d.ts +3 -4
  116. package/definitions/game/ui/screen/screens/game/DialogMap.d.ts +2 -0
  117. package/definitions/game/ui/screen/screens/game/Dialogs.d.ts +2 -1
  118. package/definitions/game/ui/screen/screens/game/component/Dialog.d.ts +1 -0
  119. package/definitions/game/ui/screen/screens/game/component/ItemComponent.d.ts +2 -0
  120. package/definitions/game/ui/screen/screens/game/component/container/ContainerBucketItemList.d.ts +3 -3
  121. package/definitions/game/ui/screen/screens/game/dialog/AltarDialog.d.ts +38 -0
  122. package/definitions/game/ui/screen/screens/game/dialog/ContainerDialog.d.ts +1 -0
  123. package/definitions/game/ui/screen/screens/game/static/actions/ActionSlot.d.ts +2 -1
  124. package/definitions/game/ui/screen/screens/game/static/actions/ActionsSelector.d.ts +2 -1
  125. package/definitions/game/ui/screen/screens/game/static/actions/IActionBar.d.ts +3 -1
  126. package/definitions/game/ui/screen/screens/menu/menus/options/TabDeveloper.d.ts +3 -2
  127. package/definitions/game/ui/util/ComponentManipulator.d.ts +5 -4
  128. package/definitions/game/utilities/Version.d.ts +1 -1
  129. package/definitions/game/utilities/WebWorker.d.ts +4 -1
  130. package/definitions/game/utilities/math/Direction.d.ts +1 -1
  131. package/definitions/hosts/electron/main/ipc/handlers/electron/electron.d.ts +1 -0
  132. package/definitions/hosts/shared/globals.d.ts +2 -2
  133. package/definitions/hosts/shared/interfaces.d.ts +10 -0
  134. package/definitions/hosts/shared/ipc/electron.d.ts +1 -0
  135. package/definitions/matchmakingserver/dedicatedServer.d.ts +2 -1
  136. package/definitions/matchmakingserver/shared.d.ts +1 -38
  137. package/definitions/test/core/applicationInteractions.d.ts +4 -0
  138. package/definitions/test/core/applicationManager.d.ts +5 -4
  139. package/definitions/test/interfaces.d.ts +0 -63
  140. package/definitions/test/testRunner.d.ts +2 -2
  141. package/definitions/utilities/Errors.d.ts +1 -0
  142. package/definitions/utilities/enum/IEnum.d.ts +1 -1
  143. package/definitions/utilities/object/Objects.d.ts +5 -15
  144. package/package.json +1 -1
  145. package/definitions/game/game/entity/creature/zone/GuardianZones.d.ts +0 -16
  146. /package/definitions/game/save/upgrade/versions/beta2.14.0/{beta2.14.0-dev20240927.d.ts → beta2.14.0-dev20241024.d.ts} +0 -0
@@ -0,0 +1,12 @@
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
+ declare const _default: import("@wayward/game/game/entity/creature/zone/ICreatureZone").IBiomeTileReplacements;
12
+ export default _default;
@@ -0,0 +1,12 @@
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
+ declare const _default: import("@wayward/game/game/entity/creature/zone/ICreatureZone").IBiomeCreatureZoneTiers;
12
+ export default _default;
@@ -0,0 +1,12 @@
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
+ declare const _default: import("@wayward/game/game/entity/creature/zone/ICreatureZone").IBiomeDoodadReplacements;
12
+ export default _default;
@@ -0,0 +1,12 @@
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
+ declare const _default: import("@wayward/game/game/entity/creature/zone/ICreatureZone").IBiomeGuardianZoneTiers;
12
+ export default _default;
@@ -0,0 +1,12 @@
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
+ declare const _default: import("@wayward/game/game/entity/creature/zone/ICreatureZone").IBiomeTileReplacements;
12
+ export default _default;
@@ -0,0 +1,12 @@
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
+ declare const _default: import("@wayward/game/game/entity/creature/zone/ICreatureZone").IBiomeCreatureZoneTiers;
12
+ export default _default;
@@ -0,0 +1,12 @@
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
+ declare const _default: import("@wayward/game/game/entity/creature/zone/ICreatureZone").IBiomeDoodadReplacements;
12
+ export default _default;
@@ -0,0 +1,12 @@
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
+ declare const _default: import("@wayward/game/game/entity/creature/zone/ICreatureZone").IBiomeGuardianZoneTiers;
12
+ export default _default;
@@ -0,0 +1,12 @@
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
+ declare const _default: import("@wayward/game/game/entity/creature/zone/ICreatureZone").IBiomeTileReplacements;
12
+ export default _default;
@@ -22,7 +22,7 @@ interface IFlowFieldHuman {
22
22
  export default class FlowFieldManager {
23
23
  private readonly island;
24
24
  private readonly size;
25
- flowFields: Map<"-1-0" | "-1-1" | "-1-2" | "-1-4" | "-1-8" | "-1-16" | "-1-32" | "-1-64" | "-1-128" | "-1-256" | "-1-512" | "-1-1024" | "-1-2048" | "-1-15" | "0-0" | "0-1" | "0-2" | "0-4" | "0-8" | "0-16" | "0-32" | "0-64" | "0-128" | "0-256" | "0-512" | "0-1024" | "0-2048" | "0-15" | "1-0" | "1-1" | "1-2" | "1-4" | "1-8" | "1-16" | "1-32" | "1-64" | "1-128" | "1-256" | "1-512" | "1-1024" | "1-2048" | "1-15", FlowField>;
25
+ flowFields: Map<"-1-0" | "-1-1" | "-1-2" | "-1-4" | "-1-8" | "-1-16" | "-1-32" | "-1-64" | "-1-128" | "-1-256" | "-1-512" | "-1-1024" | "-1-2048" | "-1-4096" | "-1-15" | "0-0" | "0-1" | "0-2" | "0-4" | "0-8" | "0-16" | "0-32" | "0-64" | "0-128" | "0-256" | "0-512" | "0-1024" | "0-2048" | "0-4096" | "0-15" | "1-0" | "1-1" | "1-2" | "1-4" | "1-8" | "1-16" | "1-32" | "1-64" | "1-128" | "1-256" | "1-512" | "1-1024" | "1-2048" | "1-4096" | "1-15", FlowField>;
26
26
  humans: IFlowFieldHuman[];
27
27
  private _flowFieldHumans;
28
28
  constructor(island: Island, size: number);
@@ -120,13 +120,12 @@ export interface IPlayerEvents extends Events<Human> {
120
120
  }
121
121
  export declare enum TurnTypeFlag {
122
122
  CheckUnderPlayer = 1,
123
- DontEnterCaves = 2,
124
- Idle = 4,
123
+ Idle = 2,
125
124
  /**
126
125
  * Indicates the turn is passing due to a movement
127
126
  */
128
- Movement = 8,
129
- DontTickAnim = 16
127
+ Movement = 4,
128
+ DontTickAnim = 8
130
129
  }
131
130
  export interface IAttackHand {
132
131
  mainHand: number;
@@ -67,4 +67,5 @@ export declare class RequirementInstance extends EventEmitter.Host<IQuestRequire
67
67
  getCompletionAmount(): number;
68
68
  getRelations(): HighlightSelector[];
69
69
  setVisible(): this;
70
+ private get description();
70
71
  }
@@ -39,6 +39,9 @@ export interface IStatusDescription {
39
39
  highlight?: SupplierOr<IHighlight | undefined, [IStatusContext]>;
40
40
  icon?: SupplierOr<IStatusIconDescription | undefined, [IStatusContext]>;
41
41
  particles?: SupplierOr<StatusParticle | undefined, [IStatusContext, StatusParticleEvent?]>;
42
+ /** A list of `StatusRenderer`s that could be returned by a supplier in the `renderer` property */
43
+ renderers?: StatusRenderer[];
44
+ /** Note that if you use a supplier, the renderer *must* also be in the `renderers` property so that it can be correctly preloaded */
42
45
  renderer?: SupplierOr<StatusRenderer | undefined, [IStatusContext]>;
43
46
  /** This function is not used automatically by Status, and must be implemented via a custom `onTick` handler */
44
47
  getDamageRange?(status: IStatusContext): IRange | undefined;
@@ -76,6 +76,7 @@ export interface ISerializedIcon extends IIcon {
76
76
  path: string | ISerializedImagePath;
77
77
  }
78
78
  export declare abstract class InfoProvider extends EventEmitter.Host<IInfoProviderEvents> implements IRefreshable {
79
+ private static bus?;
79
80
  static multiTextParagraph: string;
80
81
  static create(...translations: TranslationGenerator[]): SimpleInfoProvider;
81
82
  static dynamic<T>(observer: BaseObserver<T>, supplier: (value: T) => InfoProvider | undefined): SimpleInfoProvider;
@@ -106,6 +107,7 @@ export declare abstract class InfoProvider extends EventEmitter.Host<IInfoProvid
106
107
  hasContent(_context: InfoProviderContext): boolean;
107
108
  init(): void;
108
109
  readonly subscribeRefreshOn: BaseObserver.IRegistrar<this>;
110
+ private dirty;
109
111
  /**
110
112
  * Call when this info provider should be refreshed.
111
113
  */
@@ -123,6 +125,7 @@ export declare abstract class InfoProvider extends EventEmitter.Host<IInfoProvid
123
125
  */
124
126
  remove(): this;
125
127
  onStoppingPlay(): void;
128
+ onPreMoveToIsland(): void;
126
129
  private _shouldDisplayWhenEmpty;
127
130
  protected shouldDisplayWhenEmpty(): boolean;
128
131
  setShouldDisplayWhenEmpty(shouldDisplayWhenEmpty?: boolean): this;
@@ -31,6 +31,7 @@ export declare enum InspectionClasses {
31
31
  $Subtitle = "subtitle",
32
32
  ColorContext = "inspection-color-context",
33
33
  $ColorContext = "color-context",
34
+ $ColorContext_Optional = "color-context--optional",
34
35
  Icon = "inspection-icon",
35
36
  $Icon = "icon"
36
37
  }
@@ -9,14 +9,13 @@
9
9
  * https://github.com/WaywardGame/types/wiki
10
10
  */
11
11
  import { ActionType } from "@wayward/game/game/entity/action/IAction";
12
- import { SkillType } from "@wayward/game/game/entity/IHuman";
13
12
  import type { Stat } from "@wayward/game/game/entity/IStats";
14
13
  import UseInfo from "@wayward/game/game/inspection/infoProviders/UseInfo";
15
14
  import type Item from "@wayward/game/game/item/Item";
16
15
  import type Tooltip from "@wayward/game/ui/tooltip/Tooltip";
17
16
  declare const _default: UseInfo<{
18
17
  onConsume: [Stat, number][];
19
- skill: SkillType;
18
+ skill: import("../../../../entity/IHuman").SkillType | undefined;
20
19
  entityType: import("../../../../entity/IEntity").EntityType.Item;
21
20
  value?: Item | undefined;
22
21
  type: import("@wayward/game/game/item/IItem").ItemType;
@@ -9,7 +9,6 @@
9
9
  * https://github.com/WaywardGame/types/wiki
10
10
  */
11
11
  import { ActionType } from "@wayward/game/game/entity/action/IAction";
12
- import LabelledValue from "@wayward/game/game/inspection/infoProviders/LabelledValue";
13
12
  import UseInfo from "@wayward/game/game/inspection/infoProviders/UseInfo";
14
13
  import type Item from "@wayward/game/game/item/Item";
15
14
  import { MagicalPropertyEntry } from "@wayward/game/game/magic/MagicalPropertyManager";
@@ -37,16 +36,14 @@ declare const _default: UseInfo<{
37
36
  } & {
38
37
  getAttack: () => import("@wayward/game/game/inspection/InfoProvider").SimpleInfoProvider | undefined;
39
38
  } & {
40
- getDefense: () => (import("../../../../../language/impl/TranslationImpl").default | import("@wayward/game/game/inspection/InfoProvider").SimpleInfoProvider)[];
39
+ getDefense: () => import("../../../../../language/impl/TranslationImpl").default[];
41
40
  } & {
42
- formatInsulation: (insulation?: number | undefined, type?: TempType | undefined) => LabelledValue;
41
+ formatInsulation: (insulation?: number | undefined, type?: TempType | undefined) => import("../../../../../language/impl/TranslationImpl").default;
43
42
  } & {
44
- getInsulationOfType: (type: TempType) => LabelledValue | undefined;
43
+ getInsulation: () => (import("../../../../../language/impl/TranslationImpl").default | undefined)[];
45
44
  } & {
46
- getInsulation: () => (LabelledValue | undefined)[];
45
+ getMagicEffect: (magic: MagicalPropertyEntry) => import("../../../../../language/impl/TranslationImpl").default;
47
46
  } & {
48
- getMagicEffect: (magic: MagicalPropertyEntry) => LabelledValue;
49
- } & {
50
- getMagic: () => LabelledValue[];
47
+ getMagic: () => import("../../../../../language/impl/TranslationImpl").default[];
51
48
  }, Item>;
52
49
  export default _default;
@@ -225,7 +225,7 @@ export interface IIslandTickOptions {
225
225
  ticks: number;
226
226
  tickFlags?: TickFlag;
227
227
  playingHumans?: Human[];
228
- dueToAction?: boolean;
228
+ dueToAction?: Human;
229
229
  }
230
230
  export interface IIslandTickAsyncOptions extends IIslandTickOptions {
231
231
  onProgress?: (progess: number) => Promise<void>;
@@ -113,7 +113,7 @@ export default class Island extends EventEmitter.Host<IIslandEvents> implements
113
113
  /**
114
114
  * Entity move types in fov on this island
115
115
  */
116
- readonly moveTypesInFov: Map<"-1-0" | "-1-1" | "-1-2" | "-1-4" | "-1-8" | "-1-16" | "-1-32" | "-1-64" | "-1-128" | "-1-256" | "-1-512" | "-1-1024" | "-1-2048" | "-1-15" | "0-0" | "0-1" | "0-2" | "0-4" | "0-8" | "0-16" | "0-32" | "0-64" | "0-128" | "0-256" | "0-512" | "0-1024" | "0-2048" | "0-15" | "1-0" | "1-1" | "1-2" | "1-4" | "1-8" | "1-16" | "1-32" | "1-64" | "1-128" | "1-256" | "1-512" | "1-1024" | "1-2048" | "1-15", Set<Human<unknown, number, import("@wayward/game/game/reference/IReferenceManager").ReferenceType.NPC | import("@wayward/game/game/reference/IReferenceManager").ReferenceType.Player>>>;
116
+ readonly moveTypesInFov: Map<"-1-0" | "-1-1" | "-1-2" | "-1-4" | "-1-8" | "-1-16" | "-1-32" | "-1-64" | "-1-128" | "-1-256" | "-1-512" | "-1-1024" | "-1-2048" | "-1-4096" | "-1-15" | "0-0" | "0-1" | "0-2" | "0-4" | "0-8" | "0-16" | "0-32" | "0-64" | "0-128" | "0-256" | "0-512" | "0-1024" | "0-2048" | "0-4096" | "0-15" | "1-0" | "1-1" | "1-2" | "1-4" | "1-8" | "1-16" | "1-32" | "1-64" | "1-128" | "1-256" | "1-512" | "1-1024" | "1-2048" | "1-4096" | "1-15", Set<Human<unknown, number, import("@wayward/game/game/reference/IReferenceManager").ReferenceType.NPC | import("@wayward/game/game/reference/IReferenceManager").ReferenceType.Player>>>;
117
117
  /**
118
118
  * Helps instruct when to tick when in simulated turn mode
119
119
  */
@@ -10,16 +10,25 @@
10
10
  */
11
11
  import type Human from "@wayward/game/game/entity/Human";
12
12
  import type { AutomationStep } from "@wayward/game/game/island/automation/AutomationStep";
13
- import type { IAutomationInitialState } from "@wayward/game/game/island/automation/IAutomation";
13
+ import type { IAutomationSetup, IAutomationSetupResult } from "@wayward/game/game/island/automation/IAutomation";
14
14
  export declare class Automation {
15
15
  private running;
16
16
  private repeat;
17
17
  private repeatDelay;
18
- private initialState;
18
+ private setup;
19
+ private startDelay;
19
20
  private readonly steps;
20
21
  private readonly resetSteps;
22
+ /**
23
+ * Applys the setup to the player.
24
+ * Called during automation & tests.
25
+ * @param human Human to apply the setup too
26
+ * @param setup The setup
27
+ */
28
+ static applySetup(human: Human, setup: Readonly<IAutomationSetup>): IAutomationSetupResult;
21
29
  setRepeat(repeat: boolean, delay?: number): this;
22
- setInitialState(initialState: IAutomationInitialState): this;
30
+ setStartDelay(delay: number): this;
31
+ setSetup(setup: IAutomationSetup): this;
23
32
  addStep(step: AutomationStep): this;
24
33
  start(human: Human): Promise<void>;
25
34
  stop(): void;
@@ -11,4 +11,5 @@
11
11
  import type { IAutomationContextState } from "@wayward/game/game/island/automation/IAutomation";
12
12
  export declare abstract class AutomationStep {
13
13
  abstract execute(context: IAutomationContextState): Promise<void>;
14
+ protected waitForNoDelay(context: IAutomationContextState): Promise<void>;
14
15
  }
@@ -8,17 +8,23 @@
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 { DoodadType, GrowingStage } from "@wayward/game/game/doodad/IDoodad";
12
+ import type { ActionType } from "@wayward/game/game/entity/action/IAction";
13
+ import type { CreatureType } from "@wayward/game/game/entity/creature/ICreature";
11
14
  import type Human from "@wayward/game/game/entity/Human";
15
+ import type { EquipType } from "@wayward/game/game/entity/IHuman";
16
+ import type { StatusType } from "@wayward/game/game/entity/status/IStatus";
17
+ import type { Quality } from "@wayward/game/game/IObject";
12
18
  import type { IslandId } from "@wayward/game/game/island/IIsland";
13
- import type { ItemType, ItemTypeGroup } from "@wayward/game/game/item/IItem";
19
+ import type { ContainerSort, ItemType, ItemTypeGroup } from "@wayward/game/game/item/IItem";
14
20
  import type Item from "@wayward/game/game/item/Item";
15
- export interface IAutomationInitialState {
16
- items?: Array<ItemType | ItemTypeGroup>;
17
- /**
18
- * Delay before executing steps
19
- */
20
- delay?: number;
21
- }
21
+ import type { TerrainType } from "@wayward/game/game/tile/ITerrain";
22
+ import type { IOptions } from "@wayward/game/save/data/ISaveDataGlobal";
23
+ import type { SortDirection } from "@wayward/game/save/ISaveManager";
24
+ import type { DialogId } from "@wayward/game/ui/screen/screens/game/Dialogs";
25
+ import type { Direction } from "@wayward/game/utilities/math/Direction";
26
+ import type { IVector3 } from "@wayward/game/utilities/math/IVector";
27
+ import type WorldZ from "@wayward/utilities/game/WorldZ";
22
28
  export interface IAutomationContextState {
23
29
  human: Human;
24
30
  islandId: IslandId;
@@ -27,3 +33,92 @@ export interface IAutomationContextState {
27
33
  */
28
34
  items: Item[];
29
35
  }
36
+ export interface IAutomationSetup {
37
+ options?: Partial<IOptions>;
38
+ ui?: IAutomationSetupUi;
39
+ world?: IAutomationSetupWorld;
40
+ player?: IAutomationSetupPlayer;
41
+ }
42
+ export interface IAutomationSetupResult {
43
+ player?: {
44
+ items?: Item[];
45
+ };
46
+ }
47
+ export interface IAutomationSetupUi {
48
+ dialogs?: PartialRecord<DialogId, boolean>;
49
+ actionSlots?: Array<{
50
+ itemType?: ItemType;
51
+ actionType?: ActionType;
52
+ autoUse?: boolean;
53
+ }>;
54
+ }
55
+ export interface IAutomationSetupWorld {
56
+ /**
57
+ * The world resets by default (entities are cleared)
58
+ * Set to true to disable that.
59
+ */
60
+ disableReset?: true;
61
+ /**
62
+ * When set, all tiles will be set to this terrain type
63
+ */
64
+ defaultTerrain?: TerrainType;
65
+ tiles?: Array<{
66
+ type?: TerrainType;
67
+ /**
68
+ * Offset from the humans position
69
+ */
70
+ x?: number;
71
+ /**
72
+ * Offset from the humans position
73
+ */
74
+ y?: number;
75
+ z?: WorldZ;
76
+ items?: IAutomationSetupItem[];
77
+ tilled?: boolean;
78
+ fishAvailable?: number;
79
+ }>;
80
+ doodads?: Array<{
81
+ type: DoodadType;
82
+ growingStage?: GrowingStage;
83
+ decay?: number;
84
+ x?: number;
85
+ y?: number;
86
+ z?: number;
87
+ inventory?: IAutomationSetupItemContainer;
88
+ }>;
89
+ creatures?: Array<{
90
+ type: CreatureType;
91
+ x?: number;
92
+ y?: number;
93
+ z?: number;
94
+ tamed?: true;
95
+ /** Defaults to a massive number */
96
+ happiness?: number;
97
+ aberrant?: true;
98
+ }>;
99
+ corpses?: Array<{
100
+ type: CreatureType;
101
+ x?: number;
102
+ y?: number;
103
+ z?: number;
104
+ aberrant?: true;
105
+ }>;
106
+ }
107
+ export interface IAutomationSetupPlayer {
108
+ alwaysPassSkillChecks?: boolean;
109
+ position?: Partial<IVector3>;
110
+ direction?: Direction.Cardinal;
111
+ inventory?: IAutomationSetupItemContainer;
112
+ status?: StatusType[];
113
+ }
114
+ export interface IAutomationSetupItemContainer {
115
+ sort?: ContainerSort;
116
+ sortDirection?: SortDirection;
117
+ stacks?: ItemType[];
118
+ items?: IAutomationSetupItem[];
119
+ }
120
+ export interface IAutomationSetupItem {
121
+ type: ItemType | ItemTypeGroup;
122
+ equip?: EquipType;
123
+ quality?: Quality;
124
+ }
@@ -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 type { ActionArgumentsOf, AnyActionDescription } from "@wayward/game/game/entity/action/IAction";
11
+ import { type ActionArgumentsOf, type AnyActionDescription } from "@wayward/game/game/entity/action/IAction";
12
12
  import { AutomationStep } from "@wayward/game/game/island/automation/AutomationStep";
13
13
  import type { IAutomationContextState } from "@wayward/game/game/island/automation/IAutomation";
14
14
  export type GetActionArguments<T extends AnyActionDescription, AV = ActionArgumentsOf<T>> = AV | ((context: IAutomationContextState) => Promise<AV>);
@@ -17,7 +17,8 @@ import type { RuneChance } from "@wayward/game/game/deity/IDeities";
17
17
  import type { DoodadType, DoodadTypeGroup } from "@wayward/game/game/doodad/IDoodad";
18
18
  import type Human from "@wayward/game/game/entity/Human";
19
19
  import type { DamageType, Defense, EntityType, ICastable, MoveType } from "@wayward/game/game/entity/IEntity";
20
- import { SkillType, type Delay, type EquipType } from "@wayward/game/game/entity/IHuman";
20
+ import type { SkillType } from "@wayward/game/game/entity/IHuman";
21
+ import { type Delay, type EquipType } from "@wayward/game/game/entity/IHuman";
21
22
  import { Stat } from "@wayward/game/game/entity/IStats";
22
23
  import type { IActionApi } from "@wayward/game/game/entity/action/IAction";
23
24
  import { ActionType } from "@wayward/game/game/entity/action/IAction";
@@ -42,6 +43,7 @@ import type Message from "@wayward/game/language/dictionary/Message";
42
43
  import type { IModdable } from "@wayward/game/mod/ModRegistry";
43
44
  import type { ItemNotifierType } from "@wayward/game/renderer/notifier/INotifier";
44
45
  import type { SortDirection } from "@wayward/game/save/ISaveManager";
46
+ import type { DialogId } from "@wayward/game/ui/screen/screens/game/Dialogs";
45
47
  import type { IVector3 } from "@wayward/game/utilities/math/IVector";
46
48
  import type Vector2 from "@wayward/game/utilities/math/Vector2";
47
49
  import type { IRGB } from "@wayward/utilities/Color";
@@ -193,6 +195,7 @@ export interface IItemDescription extends IObjectDescription, IModdable, ITemper
193
195
  use?: ActionType[];
194
196
  ranged?: IRangedDescription;
195
197
  recipe?: IRecipe;
198
+ containerDialog?: DialogId;
196
199
  /**
197
200
  * A list of groups the item should belong too.
198
201
  */
@@ -335,9 +338,15 @@ export interface IItemDescription extends IObjectDescription, IModdable, ITemper
335
338
  */
336
339
  magicInert?: true;
337
340
  /**
338
- * Whether magical enhancement should be disabled
341
+ * A list of ActionTypes that should be disabled on this item.
342
+ * Note that support for this property must be added to each action's `canUse` individually. See the usage in `Enhance.ts`.
339
343
  */
340
- noEnhance?: true;
344
+ disabledActions?: ActionType[];
345
+ /**
346
+ * A list of ActionTypes that should not gain skill according to the item's associated skill.
347
+ * Note that support for this property must be added to each action's `canUse` individually. See the usage in `Refine.ts`.
348
+ */
349
+ disabledActionSkillGain?: ActionType[];
341
350
  /**
342
351
  * The item name to display instead of the item's default translation
343
352
  */
@@ -377,6 +386,14 @@ export interface IItemDescription extends IObjectDescription, IModdable, ITemper
377
386
  * When this item (or as a doodad) is melted, item types that match in this array against the disassembly object will be left behind.
378
387
  */
379
388
  dropDissassemblyItemsOnMelt?: Array<ItemType | ItemTypeGroup>;
389
+ /**
390
+ * When set to true, the item will provide no consumption bonuses when used based on its quality
391
+ */
392
+ qualityProvidesNoConsumeBonus?: boolean;
393
+ }
394
+ export declare namespace IItemDescription {
395
+ function actionDisabled(description: IItemDescription | undefined, action: ActionType): boolean;
396
+ function actionSkillGainDisabled(description: IItemDescription | undefined, action: ActionType): boolean;
380
397
  }
381
398
  export interface IConsumeItemStat {
382
399
  stat: Stat;
@@ -774,6 +791,9 @@ export interface INPCInventoryContainerReference extends IBaseContainerReference
774
791
  id: number;
775
792
  }
776
793
  export type ContainerReference = IInvalidContainerReference | IWorldContainerReference | IPlayerInventoryContainerReference | ITileContainerReference | IDoodadContainerReference | IItemContainerReference | INPCInventoryContainerReference;
794
+ export declare namespace ContainerReference {
795
+ function equals(a?: ContainerReference, b?: ContainerReference): boolean;
796
+ }
777
797
  export declare enum CraftResult {
778
798
  Fail = 0,
779
799
  Success = 1,
@@ -1682,7 +1702,8 @@ export type DisplayableItemType = ItemType | ItemTypeExtra;
1682
1702
  export declare enum ItemTag {
1683
1703
  None = 0,
1684
1704
  ShipperBoat = 1,
1685
- Rune = 2
1705
+ Rune = 2,
1706
+ VersatileApplied = 3
1686
1707
  }
1687
1708
  export declare enum ItemTypeGroup {
1688
1709
  Invalid = -9999,
@@ -65,13 +65,13 @@ export interface IGetItemOptions {
65
65
  */
66
66
  filterText?: string;
67
67
  }
68
- export interface IGetItemsOptions extends IGetItemOptions {
68
+ export interface IGetItemsOptions extends Pick<IGetItemOptions, "excludeProtectedItems" | "includeProtectedItemsThatWillNotBreak"> {
69
69
  /**
70
70
  * Include sub containers in the search
71
71
  */
72
72
  includeSubContainers: true;
73
73
  }
74
- export interface IGetBestItemsOptions extends IGetItemsOptions {
74
+ export interface IGetBestItemsOptions extends IGetItemOptions, IGetItemsOptions {
75
75
  action: ActionType;
76
76
  actionWith: Item | (() => Item | undefined);
77
77
  sort(itemA: Item, itemB: Item, options: Partial<IGetBestItemsOptions>): number | undefined;
@@ -79,6 +79,8 @@ export interface IGetBestItemsOptions extends IGetItemsOptions {
79
79
  filterQuality: ArrayOr<Quality>;
80
80
  filterGroup: ItemTypeGroup;
81
81
  filterConsumable: true;
82
+ filterContainer: IContainer;
83
+ filterStacked: boolean;
82
84
  targetCreature: Creature;
83
85
  filter(item: Item): any;
84
86
  }
@@ -135,6 +137,7 @@ export interface IMoveItemOptions {
135
137
  isTrading?: boolean;
136
138
  revertFromDoodad?: boolean;
137
139
  skipDrop?: true;
140
+ skipClearSort?: true;
138
141
  context?: ActionContext;
139
142
  }
140
143
  export interface IPlaceOnTileOptions {
@@ -159,7 +162,8 @@ export declare enum ContainerReferenceSource {
159
162
  WriteContainer = 12,
160
163
  GetContainerName = 13,
161
164
  Upgrade = 14,
162
- MoveItemOfTypeArgument = 15
165
+ MoveItemOfTypeArgument = 15,
166
+ ActionBarUsingContainer = 16
163
167
  }
164
168
  export interface ICraftResultChances {
165
169
  success: number;
@@ -159,6 +159,7 @@ export default class Item extends EntityMovable<IItemDescription, ItemType, Refe
159
159
  set durabilityMax(value: number);
160
160
  getDisplayItem(): DisplayableItemType;
161
161
  isContainer(): this is Item & IContainer;
162
+ isWithin(container?: IContainer): boolean;
162
163
  get builtDescription(): IDoodadDescription | undefined;
163
164
  countTradesWith(human?: Human): number;
164
165
  /**
@@ -36,6 +36,7 @@ declare class ItemFinder extends EventEmitter.Host<IItemFinderEvents> {
36
36
  private trackedItems?;
37
37
  private foundItemIds?;
38
38
  private foundItemBest?;
39
+ private disposed?;
39
40
  get human(): Human | undefined;
40
41
  get container(): IContainer | undefined;
41
42
  readonly observe: Observer.IRegistrar<this>;
@@ -162,7 +162,7 @@ export default class ItemManager extends EntityManager<Item, IItemRemoveOptions>
162
162
  * @returns Tile or undefined
163
163
  */
164
164
  getTile(itemOrContainer?: Item | IContainer): Tile | undefined;
165
- resolveContainer(container?: IContainer): Tile | Player | Item | Doodad | NPC | IContainer | undefined;
165
+ resolveContainer(container?: IContainer | ContainerReference): Tile | Player | Item | Doodad | NPC | IContainer | undefined;
166
166
  getContainerReference(containable: IContainable | undefined, source: ContainerReferenceSource | undefined): ContainerReference;
167
167
  derefenceContainerReference(containerReference: ContainerReference, showWarnings?: boolean): IContainable | undefined;
168
168
  hashContainer(containable: IContainable, containerReferenceSource?: ContainerReferenceSource): string;
@@ -195,12 +195,12 @@ export default class ItemManager extends EntityManager<Item, IItemRemoveOptions>
195
195
  * @param options Item move options
196
196
  * @returns Result that tells you what moved
197
197
  */
198
- moveItemsToContainer(human: Human | undefined, items: Item[], toContainer: IContainer, options?: IMoveItemOptions): IAddToContainerResult;
198
+ moveItemsToContainer(human: Human | undefined, items: readonly Item[], toContainer: IContainer, options?: IMoveItemOptions): IAddToContainerResult;
199
199
  setStacked(human: Human, container: IContainer, itemType: ItemType, stacked?: boolean, atIndex?: number): void;
200
200
  ensureContainerSorted(container?: IContainer, sorter?: ISorter<Item | undefined> | undefined): boolean;
201
201
  private ensureStacksStacked;
202
202
  createSorter(container?: IContainer): ISorter<Item | undefined> | undefined;
203
- tryMoveItemsToContainer(human: Human | undefined, items: Item[], toContainer: IContainer, options?: IMoveItemOptions): IAddToContainerResult | IActionNotUsable;
203
+ tryMoveItemsToContainer(human: Human | undefined, items: readonly Item[], toContainer: IContainer, options?: IMoveItemOptions): IAddToContainerResult | IActionNotUsable;
204
204
  /**
205
205
  * Return `number` to insert the item at a specific index. Return `undefined` to push the item to the end.
206
206
  * Defaults to `0` or `undefined` if sort is `ContainerSort.Recent`, or polling the sorting algorithm otherwise
@@ -241,7 +241,7 @@ export default class ItemManager extends EntityManager<Item, IItemRemoveOptions>
241
241
  * Drop items in a 3x3 square around the location.
242
242
  * This will ensure all items in the container are removed
243
243
  */
244
- placeItemsAroundTile(container: IContainer, tile: Tile, skipMessage?: boolean): void;
244
+ placeItemsAroundTile(container: IContainer, tile: Tile, skipMessage?: boolean, skipCurrentTile?: boolean): void;
245
245
  /**
246
246
  * Returns the "processed" weight of the given item.
247
247
  * - If the item is a "raw" item — ie, it was not created from other items, this is the `weightFraction` lerping the item's min & max weight.
@@ -341,9 +341,9 @@ export default class ItemManager extends EntityManager<Item, IItemRemoveOptions>
341
341
  isTileContainer(container: IContainable | undefined): container is Tile & ITileContainer;
342
342
  /**
343
343
  * Returns ordered items for the containers
344
- * Note: It ~~may~~ (will always) return the real containedItems array!
344
+ * Note: If not filtered, it will return the real containedItems array!
345
345
  */
346
- getOrderedContainerItems(container: IUncastableContainer, options?: Partial<IGetItemOptions>): Item[];
346
+ getOrderedContainerItems(container: IUncastableContainer, options?: Partial<IGetItemsOptions>): readonly Item[];
347
347
  capWeightOfItems(createdItems: Item[], itemWeight: number): void;
348
348
  getItemTypeTranslation(itemType: ItemType | ItemTypeGroup): Translation;
349
349
  getItemTypeTranslation(itemType: ItemType | ItemTypeGroup, count: number): Translation;