Class: MapWaypointSpriteIcon<T>

Defined in: src/sdk/components/map/MapWaypointIcon.ts:167

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

Extends

• AbstractMapWaypointIcon<T>

Type Parameters

Type Parameter
T extends MapWaypoint

Constructors

Constructor

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

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

Constructor.

Parameters

Parameter	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) => number	An optional handler to determine the sprite frame to draw.

Returns

MapWaypointSpriteIcon<T>

Overrides

AbstractMapWaypointIcon.constructor

Properties

anchor

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

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

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

---

frameHeight

protected readonly frameHeight: number

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

The frame height of the sprite, in pixels.

---

frameWidth

protected readonly frameWidth: number

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

The frame width of the sprite, in pixels.

---

img

protected readonly img: HTMLImageElement

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

This icon's sprite's image source.

---

offset

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

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

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

Inherited from

AbstractMapWaypointIcon.offset

---

priority

readonly priority: Subscribable<number>

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

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

Inherited from

AbstractMapWaypointIcon.priority

---

size

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

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

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

Inherited from

AbstractMapWaypointIcon.size

---

waypoint

readonly waypoint: T

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

The waypoint associated with this icon.

Inherited from

AbstractMapWaypointIcon.waypoint

---

tempVec2

protected readonly static tempVec2: Float64Array

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

Inherited from

AbstractMapWaypointIcon.tempVec2

Methods

draw()

draw(context, mapProjection): void

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

Renders this icon to a canvas.

Parameters

Parameter	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

---

drawIconAt()

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

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

Draws the icon at the specified position.

Parameters

Parameter	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

---

getSpriteFrame()

protected getSpriteFrame(mapProjection): number

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

Gets the sprite frame to render.

Parameters

Parameter	Type	Description
mapProjection	MapProjection	The map projection to use.

Returns

number

The sprite frame to render.