Class: MapSystemLabelFactory
A class that create labels for the map system waypoint renderer.
Implements
Constructors
constructor
• new MapSystemLabelFactory(): MapSystemLabelFactory
Returns
Methods
addDefaultLabelFactory
▸ addDefaultLabelFactory<T>(role, factory): void
Adds a default label factory for a role.
Type parameters
| Name | Type |
|---|---|
T | extends Waypoint |
Parameters
| Name | Type | Description |
|---|---|---|
role | number | The role to add a default label factory for. |
factory | (waypoint: T) => MapCullableLocationTextLabel | The factory that will produce the labels. |
Returns
void
Defined in
src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:249
addLabelFactory
▸ addLabelFactory<T>(role, iconType, factory): void
Adds an label factory to the container.
Type parameters
| Name | Type |
|---|---|
T | extends Waypoint |
Parameters
| Name | Type | Description |
|---|---|---|
role | number | The role to add this label factory for. |
iconType | string | The unique string type name of the waypoint. |
factory | (waypoint: T) => MapCullableLocationTextLabel | The factory that will produce the waypoint label. |
Returns
void
Defined in
src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:235
createLabel
▸ createLabel(role, waypoint): MapCullableLocationTextLabel
Creates a new label for a waypoint.
Parameters
| Name | Type | Description |
|---|---|---|
role | number | The role that has been selected to render. |
waypoint | Waypoint | The waypoint to create a label for. |
Returns
A new waypoint label.
Defined in
src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:275
getLabel
▸ getLabel<T>(role, waypoint): MapCullableTextLabel
Gets a label for a waypoint.
Type parameters
| Name | Type |
|---|---|
T | extends Waypoint |
Parameters
| Name | Type | Description |
|---|---|---|
role | number | The role that was selected for the waypoint for rendering. |
waypoint | T | A waypoint. |
Returns
a waypoint label.
Implementation of
MapWaypointRendererLabelFactory.getLabel
Defined in
src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:254