Skip to main content

Class: MapModulePropsController<ModuleKey, Module>

Defined in: src/sdk/components/mapsystem/controllers/MapModulePropsController.ts:221

Updates the properties in a MapAutopilotPropsModule.

Extends​

Extended by​

Type Parameters​

Type Parameter
ModuleKey extends string
Module extends object

Constructors​

Constructor​

new MapModulePropsController<ModuleKey, Module>(context, moduleKey, bindings): MapModulePropsController<ModuleKey, Module>

Defined in: src/sdk/components/mapsystem/controllers/MapModulePropsController.ts:233

Creates a new instance of MapModulePropsController.

Parameters​

ParameterTypeDescription
contextMapSystemContext<MapModulePropsControllerModules<ModuleKey, Module>>This controller's map context.
moduleKeyModuleKeyThe key of the module controlled by the controller.
bindingsIterable<MapModulePropsControllerBinding<Module>>An iterable containing definitions of the bindings to create between module properties and external data sources.

Returns​

MapModulePropsController<ModuleKey, Module>

Overrides​

MapSystemController.constructor

Properties​

context​

protected readonly context: MapSystemContext<MapModulePropsControllerModules<ModuleKey, Module>, any, any, any>

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:24

Inherited from​

MapSystemController.context

Accessors​

isAlive​

Get Signature​

get isAlive(): boolean

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:20

Whether this controller is alive.

Returns​

boolean

Inherited from​

MapSystemController.isAlive

Methods​

destroy()​

destroy(): void

Defined in: src/sdk/components/mapsystem/controllers/MapModulePropsController.ts:273

Destroys this controller.

Returns​

void

Overrides​

MapSystemController.destroy


onAfterMapRender()​

onAfterMapRender(): void

Defined in: src/sdk/components/mapsystem/controllers/MapModulePropsController.ts:254

This method is called after this controller' map is rendered.

Returns​

void

Overrides​

MapSystemController.onAfterMapRender


onAfterUpdated()​

onAfterUpdated(time, elapsed): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:78

This method is called immediately after this controller's map updates its layers.

Parameters​

ParameterTypeDescription
timenumberThe current time, as a Javascript timestamp.
elapsednumberThe elapsed time, in milliseconds, since the last update.

Returns​

void

Inherited from​

MapSystemController.onAfterUpdated


onBeforeUpdated()​

onBeforeUpdated(time, elapsed): void

Defined in: src/sdk/components/mapsystem/controllers/MapModulePropsController.ts:261

This method is called immediately before this controller's map updates its layers.

Parameters​

ParameterTypeDescription
timenumberThe current time, as a Javascript timestamp.
elapsednumberThe elapsed time, in milliseconds, since the last update.

Returns​

void

Overrides​

MapSystemController.onBeforeUpdated


onDeadZoneChanged()​

onDeadZoneChanged(deadZone): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:48

This method is called when the dead zone of this controller's map changes.

Parameters​

ParameterTypeDescription
deadZoneReadonlyFloat64ArrayThe map's new dead zone.

Returns​

void

Inherited from​

MapSystemController.onDeadZoneChanged


onMapDestroyed()​

onMapDestroyed(): void

Defined in: src/sdk/components/mapsystem/controllers/MapModulePropsController.ts:268

This method is called when this controller's map is destroyed.

Returns​

void

Overrides​

MapSystemController.onMapDestroyed


onMapProjectionChanged()​

onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:58

This method is called when the projection of this controller's map changes.

Parameters​

ParameterTypeDescription
mapProjectionMapProjectionThe map projection.
changeFlagsnumberBit flags describing the type of change.

Returns​

void

Inherited from​

MapSystemController.onMapProjectionChanged


onSleep()​

onSleep(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:92

This method is called when this controller's map is put to sleep.

Returns​

void

Inherited from​

MapSystemController.onSleep


onWake()​

onWake(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:85

This method is called when this controller's map is awakened.

Returns​

void

Inherited from​

MapSystemController.onWake