Class: MapWaypointSpriteIcon<T>

A waypoint icon with a sprite as the icon's graphic source.

Type parameters

Name	Type
T	extends MapWaypoint

Hierarchy

• AbstractMapWaypointIcon<T>

  ↳ MapWaypointSpriteIcon

Constructors

constructor

• new MapWaypointSpriteIcon<T>(waypoint, priority, img, frameWidth, frameHeight, size, options?, spriteFrameHandler?): MapWaypointSpriteIcon<T>

Constructor.

Type parameters

Name	Type
T	extends MapWaypoint

Parameters

Name	Type	Description
waypoint	T	The waypoint associated with this icon.
priority	number | Subscribable<number>	The render priority of this icon. Icons with higher priorities should be rendered above those with lower priorities.
img	HTMLImageElement	This icon's sprite's image source.
frameWidth	number	The frame width of the sprite, in pixels.
frameHeight	number	The frame height of the sprite, in pixels.
size	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>	The size of this icon, as [width, height] in pixels, or a subscribable which provides it.
options?	AbstractMapWaypointIconOptions	Options with which to initialize this icon.
spriteFrameHandler?	(mapProjection: MapProjection) => number	An optional handler to determine the sprite frame to draw.

Returns

MapWaypointSpriteIcon<T>

Overrides

AbstractMapWaypointIcon.constructor

Defined in

src/sdk/components/map/MapWaypointIcon.ts:180

Properties

anchor

• Readonly anchor: Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

The anchor point of this icon, expressed relative to its width and height. [0, 0] is the top-left corner, and [1, 1] is the bottom-right corner.

Inherited from

AbstractMapWaypointIcon.anchor

Defined in

src/sdk/components/map/MapWaypointIcon.ts:86

---

frameHeight

• Protected Readonly frameHeight: number

The frame height of the sprite, in pixels.

Defined in

src/sdk/components/map/MapWaypointIcon.ts:185

---

frameWidth

• Protected Readonly frameWidth: number

The frame width of the sprite, in pixels.

Defined in

src/sdk/components/map/MapWaypointIcon.ts:184

---

img

• Protected Readonly img: HTMLImageElement

This icon's sprite's image source.

Defined in

src/sdk/components/map/MapWaypointIcon.ts:183

---

offset

• Readonly offset: Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

The offset of this icon from the projected position of its associated waypoint, as [x, y] in pixels.

Inherited from

AbstractMapWaypointIcon.offset

Defined in

src/sdk/components/map/MapWaypointIcon.ts:89

---

priority

• Readonly priority: Subscribable<number>

The render priority of this icon. Icons with higher priorities will be rendered on top of icons with lower priorities.

Inherited from

AbstractMapWaypointIcon.priority

Defined in

src/sdk/components/map/MapWaypointIcon.ts:77

---

size

• Readonly size: Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

The size of this icon, as [width, height] in pixels.

Inherited from

AbstractMapWaypointIcon.size

Defined in

src/sdk/components/map/MapWaypointIcon.ts:80

---

waypoint

• Readonly waypoint: T

The waypoint associated with this icon.

Inherited from

AbstractMapWaypointIcon.waypoint

Defined in

src/sdk/components/map/MapWaypointIcon.ts:100

---

tempVec2

▪ Static Protected Readonly tempVec2: Float64Array

Inherited from

AbstractMapWaypointIcon.tempVec2

Defined in

src/sdk/components/map/MapWaypointIcon.ts:74

Methods

draw

▸ draw(context, mapProjection): void

Renders this icon to a canvas.

Parameters

Name	Type	Description
context	CanvasRenderingContext2D	The canvas 2D rendering context to which to render.
mapProjection	MapProjection	The projection to use for rendering.

Returns

void

Inherited from

AbstractMapWaypointIcon.draw

Defined in

src/sdk/components/map/MapWaypointIcon.ts:113

---

drawIconAt

▸ drawIconAt(context, mapProjection, left, top): void

Draws the icon at the specified position.

Parameters

Name	Type	Description
context	CanvasRenderingContext2D	The canvas rendering context to use.
mapProjection	MapProjection	The map projection to use.
left	number	The x-coordinate of the left edge of the icon.
top	number	The y-coordinate of the top edge of the icon.

Returns

void

Overrides

AbstractMapWaypointIcon.drawIconAt

Defined in

src/sdk/components/map/MapWaypointIcon.ts:194

---

getSpriteFrame

▸ getSpriteFrame(mapProjection): number

Gets the sprite frame to render.

Parameters

Name	Type	Description
mapProjection	MapProjection	The map projection to use.

Returns

number

The sprite frame to render.

Defined in

src/sdk/components/map/MapWaypointIcon.ts:213