Interface: MapWaypointRendererLabelFactory<W>

Defined in: src/sdk/components/map/MapWaypointRenderer.ts:37

A waypoint label factory.

Type Parameters

Type Parameter
`W` extends `MapWaypoint`

optional cleanupLabel<T>(role, waypoint, label): void

Defined in: src/sdk/components/map/MapWaypointRenderer.ts:56

Cleans up a label for a waypoint. This method is called when a label that was previously selected to be rendered is no longer needed for rendering.

Note that even though the label to clean up is no longer being rendered, external references to the label may still exist.

Type Parameter
`T` extends `MapWaypoint`

Parameter	Type	Description
`role`	`number`	The role under which the label to clean up was rendered.
`waypoint`	`T`	The waypoint for the label to clean up.
`label`	`MapCullableTextLabel`	-

void

getLabel<T>(role, waypoint): MapCullableTextLabel | null

Defined in: src/sdk/components/map/MapWaypointRenderer.ts:44

Gets a label for a waypoint.

Type Parameter
`T` extends `MapWaypoint`

Parameter	Type	Description
`role`	`number`	The role that was selected for the waypoint for rendering.
`waypoint`	`T`	The waypoint for which to get a label.

A waypoint label.