@wayward/types 2.14.4-beta.dev.20250110.1 → 2.14.4-beta.dev.20250111.1

package/definitions/game/game/entity/Entity.d.ts

@@ -35,7 +35,8 @@ import { type ISerializedTranslation } from "@wayward/game/language/ITranslation
 import type Translation from "@wayward/game/language/Translation";
 import type { RenderSource, UpdateRenderFlag } from "@wayward/game/renderer/IRenderer";
 import type { Renderer } from "@wayward/game/renderer/Renderer";
-import type { INotificationLocation, ItemNotifierType, MarkerIconType, StatNotificationType } from "@wayward/game/renderer/notifier/INotifier";
+import type { INotificationLocation, ItemNotifierType, MarkerDescription, StatNotificationType } from "@wayward/game/renderer/notifier/INotifier";
+import type { MarkerType } from "@wayward/game/renderer/notifier/INotifier";
 import type { IVector3 } from "@wayward/game/utilities/math/IVector";
 import type { IVector4 } from "@wayward/game/utilities/math/Vector4";
 import EventEmitter from "@wayward/utilities/event/EventEmitter";
@@ -121,10 +122,10 @@ export default abstract class Entity<DescriptionType = unknown, TypeType extends
      * This is called clientside the first time the renderer seens the entity
      */
     onFirstRender(renderer: Renderer): void;
-    getCurrentMarkerIconType(): MarkerIconType | undefined;
+    getCurrentMarkerType(): MarkerType | undefined;
     setMarkerIconHidden(hidden: boolean): void;
-    addMarkerIcon(type: MarkerIconType): void;
-    removeMarkerIcon(...types: MarkerIconType[]): void;
+    addMarker(description: MappedOmit<MarkerDescription, "guid">): void;
+    removeMarker(...types: MarkerType[]): void;
     getProducedTemperature(): number | undefined;
     setName(renamed: string | ISerializedTranslation | undefined): void;
     canInspect(human: Human): boolean;

package/definitions/game/game/tile/Tile.d.ts

@@ -103,6 +103,10 @@ export default class Tile implements IVector4, Partial<ITileContainer>, IFieldOf
     private _minDur?;
     private _maxDur?;
     get zone(): CreatureZone;
+    /**
+     * Gets the tier of the zone the tile is in
+     */
+    get zoneTier(): number;
     /**
      * Creates a fake tile
      */

package/definitions/game/renderer/RenderersNotifiers.d.ts

@@ -12,7 +12,7 @@ import type { CreatureType } from "@wayward/game/game/entity/creature/ICreature"
 import type { StatusChangeReason } from "@wayward/game/game/entity/IEntity";
 import type Status from "@wayward/game/game/entity/status/Status";
 import type { DisplayableItemType } from "@wayward/game/game/item/IItem";
-import type { INotificationLocation, NotifierIconType, ItemNotifierType, CreatureNotifierType, MarkerIconType } from "@wayward/game/renderer/notifier/INotifier";
+import type { INotificationLocation, NotifierIconType, ItemNotifierType, CreatureNotifierType, MarkerDescription } from "@wayward/game/renderer/notifier/INotifier";
 import { StatNotificationType } from "@wayward/game/renderer/notifier/INotifier";
 import type Renderers from "@wayward/game/renderer/Renderers";
 export declare class RenderersNotifiers {
@@ -25,6 +25,6 @@ export declare class RenderersNotifiers {
     addStatus(location: INotificationLocation, status: Status, reason: StatusChangeReason): void;
     addItem(location: INotificationLocation, itemNotifierType: ItemNotifierType, type: DisplayableItemType): void;
     addCreature(location: INotificationLocation, creatureNotifierType: CreatureNotifierType, type: CreatureType, aberrant?: boolean): void;
-    addMarker(location: INotificationLocation, markerType: MarkerIconType, markerGuid: string): void;
+    addMarker(location: INotificationLocation, marker: MarkerDescription): void;
     removeMarker(location: INotificationLocation, guid: string): void;
 }

package/definitions/game/renderer/notifier/INotifier.d.ts

@@ -9,8 +9,10 @@
  * https://github.com/WaywardGame/types/wiki
  */
 import type { SfxType } from "@wayward/game/audio/IAudio";
+import type { ItemType } from "@wayward/game/game/item/IItem";
 import type { IVector2 } from "@wayward/game/utilities/math/IVector";
 import type { IVector4 } from "@wayward/game/utilities/math/Vector4";
+import type { IRGB } from "@wayward/utilities/Color";
 export interface INotificationLocation extends IVector4 {
     getMovementPoint?(timeStamp: number): IVector2;
     getMovementProgress?(timeStamp: number): number;
@@ -53,10 +55,43 @@ export declare enum NotifierIconType {
     DualWieldEnabled = 7,
     DualWieldDisabled = 8
 }
-export declare enum MarkerIconType {
+export declare enum MarkerType {
     Tamed = 0,
     AlertedHostile = 1,
-    AlertedScared = 2
+    AlertedScared = 2,
+    Text = 3,
+    Item = 4
 }
+export interface IBaseMarkerDescription {
+    guid: string;
+    size?: number;
+    offsetY?: number;
+}
+/**
+ * Specific sprite icons
+ */
+export interface ISpriteMarkerDescription extends IBaseMarkerDescription {
+    type: MarkerType.Tamed | MarkerType.AlertedHostile | MarkerType.AlertedScared;
+}
+/**
+ * Item icon
+ */
+export interface IItemMarkerDescription extends IBaseMarkerDescription {
+    type: MarkerType.Item;
+    itemType: ItemType;
+}
+/**
+ * Generic text.
+ * This won't actually work because our text.png sprite only has numbers
+ */
+export interface ITextMarkerDescription extends IBaseMarkerDescription {
+    type: MarkerType.Text;
+    text: string;
+    textColor: IRGB;
+}
+/**
+ * This value may be saved into Entity._persistentMarker!
+ */
+export type MarkerDescription = ISpriteMarkerDescription | ITextMarkerDescription | IItemMarkerDescription;
 export declare const itemDamageNotifierThreshold = 3;
 export declare const doodadDamageNotifierThreshold = 5;

package/definitions/game/renderer/notifier/Notifier.d.ts

@@ -13,7 +13,7 @@ import { StatusChangeReason } from "@wayward/game/game/entity/IEntity";
 import type Status from "@wayward/game/game/entity/status/Status";
 import type { DisplayableItemType } from "@wayward/game/game/item/IItem";
 import type { IRendererContext } from "@wayward/game/renderer/context/IRendererContext";
-import type { INotificationLocation, MarkerIconType } from "@wayward/game/renderer/notifier/INotifier";
+import type { INotificationLocation, MarkerDescription } from "@wayward/game/renderer/notifier/INotifier";
 import { CreatureNotifierType, ItemNotifierType, NotifierIconType, StatNotificationType } from "@wayward/game/renderer/notifier/INotifier";
 import type { IResourceContainer } from "@wayward/game/renderer/resources/IResourceContainer";
 export declare class Notifier {
@@ -37,7 +37,7 @@ export declare class Notifier {
     addStat(location: INotificationLocation, type: StatNotificationType, value: number): void;
     addStatus(location: INotificationLocation, status: Status, reason: StatusChangeReason): void;
     addNotifierIcon(location: INotificationLocation, type: NotifierIconType): void;
-    addMarker(location: INotificationLocation, type: MarkerIconType, markerGuid: string): void;
+    addMarker(location: INotificationLocation, marker: MarkerDescription): void;
     removeMarker(guid: string): void;
     suspend(): void;
     resume(): void;

package/definitions/game/renderer/world/WorldRenderer.d.ts

@@ -143,7 +143,8 @@ export declare class WorldRenderer extends EventEmitter.Host<IWorldRendererEvent
     private creatureFlyingBatch;
     private overlayBatch;
     private vehicleBatch;
-    private readonly entitiesInViewport;
+    private readonly entitiesToRenderInViewport;
+    private readonly doodadsToNotRenderInViewport;
     /**
      * A set of entities seen before (rendered on screen at least once)
      */

package/definitions/game/ui/screen/screens/game/util/item/ItemStylesheet.d.ts

@@ -8,9 +8,19 @@
  * 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 { Quality } from "@wayward/game/game/IObject";
 import type { ILoadOnIslandOptions } from "@wayward/game/game/entity/IHuman";
 import type Island from "@wayward/game/game/island/Island";
+import type { DisplayableItemType } from "@wayward/game/game/item/IItem";
 import SpriteEditor from "@wayward/game/ui/screen/screens/game/util/item/SpriteEditor";
+declare enum Type {
+    Normal = 0,
+    Dim = 1,
+    Highlight = 2
+}
+type BackgroundIDTypeSuffix = `` | `-${Lowercase<keyof typeof Type>}`;
+type BackgroundIDQuality = Lowercase<Exclude<keyof typeof Quality, "None" | "Random">>;
+type BackgroundID = `default${BackgroundIDTypeSuffix}` | `quality-${BackgroundIDQuality}${BackgroundIDTypeSuffix}` | `damaged${BackgroundIDTypeSuffix}` | `trading${BackgroundIDTypeSuffix}` | `non-craftable` | `discovery-active` | `non-craftable-discovery`;
 export default class ItemStylesheetHandler {
     private readonly backgroundDefinitions;
     readonly editor: SpriteEditor;
@@ -28,6 +38,7 @@ export default class ItemStylesheetHandler {
      * Append items for the specified stage to the stylesheet.
      */
     private appendStylesheetsStage;
+    getItemSprite(backgroundID: BackgroundID, item: DisplayableItemType, abortSignal?: AbortSignal, itemPath?: string): Promise<string | undefined>;
     /**
      * Appends an array of item types to the specified stylesheet.
      * This no-ops for items that were already appended to the sheet.
@@ -38,3 +49,4 @@ export default class ItemStylesheetHandler {
     private getCSSColor;
     private getItemTypes;
 }
+export {};

package/definitions/utilities/types/Types.d.ts

@@ -19,6 +19,9 @@ interface PartialUnionizer<TYPES extends any[]> {
 }
 declare global {
     type PartialUnion<TYPES extends any[]> = TYPES[number] & PartialUnionizer<TYPES>[Extract<TYPES["length"], keyof PartialUnionizer<TYPES>>];
+    type MappedOmit<T, K extends keyof T> = {
+        [P in keyof T as P extends K ? never : P]: T[P];
+    };
 }
 declare const _default: {};
 export default _default;

package/package.json

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