Interface: MapWaypointRendererIconFactory<W>
Defined in: src/sdk/components/map/MapWaypointRenderer.ts:12
A waypoint icon factory.
Type Parameters
| Type Parameter |
|---|
W extends MapWaypoint |
Methods
cleanupIcon()?
optionalcleanupIcon<T>(role,waypoint,icon):void
Defined in: src/sdk/components/map/MapWaypointRenderer.ts:31
Cleans up an icon for a waypoint. This method is called when an icon that was previously selected to be rendered is no longer needed for rendering.
Note that even though the icon to clean up is no longer being rendered, external references to the icon may still exist.
Type Parameters
| Type Parameter |
|---|
T extends MapWaypoint |
Parameters
| Parameter | Type | Description |
|---|---|---|
role | number | The role under which the icon to clean up was rendered. |
waypoint | T | The waypoint for the icon to clean up. |
icon | MapWaypointIcon<T> | The icon to clean up. |
Returns
void
getIcon()
getIcon<
T>(role,waypoint):MapWaypointIcon<T> |null
Defined in: src/sdk/components/map/MapWaypointRenderer.ts:19
Gets an icon for a waypoint.
Type Parameters
| Type Parameter |
|---|
T extends MapWaypoint |
Parameters
| Parameter | Type | Description |
|---|---|---|
role | number | The role that was selected for the waypoint for rendering. |
waypoint | T | The waypoint for which to get an icon. |
Returns
MapWaypointIcon<T> | null
A waypoint icon.