Skip to main content

Class: MapSystemIconFactory

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

Adds a default icon factory for a role.

Type parameters

NameType
Textends Waypoint

Parameters

NameTypeDescription
rolenumberThe role to add a default icon factory for.
factory(waypoint: T) => MapWaypointIcon<T>The factory that will produce the icons.

Returns

void

Defined in

src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:173


addIconFactory

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

Adds an icon factory to the container.

Type parameters

NameType
Textends Waypoint

Parameters

NameTypeDescription
rolenumberThe role that this icon factory will be assigned to.
iconTypestringThe unique string type name of the icon.
factory(waypoint: T) => MapWaypointIcon<T>The factory that will produce the icon.

Returns

void

Defined in

src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:159


getIcon

getIcon<T>(role, waypoint): MapWaypointIcon<T>

Gets an icon for a waypoint.

Type parameters

NameType
Textends Waypoint

Parameters

NameTypeDescription
rolenumberThe role that was selected for the waypoint for rendering.
waypointTA waypoint.

Returns

MapWaypointIcon<T>

a waypoint icon.

Implementation of

MapWaypointRendererIconFactory.getIcon

Defined in

src/sdk/components/mapsystem/MapSystemWaypointsRenderer.ts:178