Class: MapSystemIconFactory
Defined in: src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:148
A class that creates icons for the map system waypoint renderer.
Implements
Constructors
Constructor
new MapSystemIconFactory():
MapSystemIconFactory
Returns
MapSystemIconFactory
Methods
addDefaultIconFactory()
addDefaultIconFactory<
T
>(role
,factory
):void
Defined in: src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:173
Adds a default icon factory for a role.
Type Parameters
Type Parameter |
---|
T extends Waypoint |
Parameters
Parameter | Type | Description |
---|---|---|
role | number | The role to add a default icon factory for. |
factory | (waypoint ) => MapWaypointIcon <T > | The factory that will produce the icons. |
Returns
void
addIconFactory()
addIconFactory<
T
>(role
,iconType
,factory
):void
Defined in: src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:159
Adds an icon factory to the container.
Type Parameters
Type Parameter |
---|
T extends Waypoint |
Parameters
Parameter | Type | Description |
---|---|---|
role | number | The role that this icon factory will be assigned to. |
iconType | string | The unique string type name of the icon. |
factory | (waypoint ) => MapWaypointIcon <T > | The factory that will produce the icon. |
Returns
void
getIcon()
getIcon<
T
>(role
,waypoint
):MapWaypointIcon
<T
>
Defined in: src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:178
Gets an icon 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
a waypoint icon.