Class: MapSystemLabelFactory

Defined in: src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:224

A class that create labels for the map system waypoint renderer.

Implements

• MapWaypointRendererLabelFactory<Waypoint>

Constructors

Constructor

new MapSystemLabelFactory(): MapSystemLabelFactory

Returns

MapSystemLabelFactory

Methods

addDefaultLabelFactory()

addDefaultLabelFactory<T>(role, factory): void

Defined in: src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:249

Adds a default label factory for a role.

Type Parameters

Type Parameter
T extends Waypoint

Parameters

Parameter	Type	Description
role	number	The role to add a default label factory for.
factory	(waypoint) => MapCullableLocationTextLabel	The factory that will produce the labels.

Returns

void

---

addLabelFactory()

addLabelFactory<T>(role, iconType, factory): void

Defined in: src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:235

Adds an label factory to the container.

Type Parameters

Type Parameter
T extends Waypoint

Parameters

Parameter	Type	Description
role	number	The role to add this label factory for.
iconType	string	The unique string type name of the waypoint.
factory	(waypoint) => MapCullableLocationTextLabel	The factory that will produce the waypoint label.

Returns

void

---

createLabel()

createLabel(role, waypoint): MapCullableLocationTextLabel

Defined in: src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:275

Creates a new label for a waypoint.

Parameters

Parameter	Type	Description
role	number	The role that has been selected to render.
waypoint	Waypoint	The waypoint to create a label for.

Returns

MapCullableLocationTextLabel

A new waypoint label.

---

getLabel()

getLabel<T>(role, waypoint): MapCullableTextLabel

Defined in: src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:254

Gets a label for a waypoint.

Type Parameters

Type Parameter
T extends Waypoint

Parameters

Parameter	Type	Description
role	number	The role that was selected for the waypoint for rendering.
waypoint	T	A waypoint.

Returns

MapCullableTextLabel

a waypoint label.

Implementation of

MapWaypointRendererLabelFactory.getLabel