Class ModuleModel

Abstract class from which every model inherits general properties.

Settings

@member name The displayed name of this module.
@member playerRole Indicates which user is able to see this module.

Controls

None

Hierarchy

ModuleModel

Index

Constructors

constructor

Properties

Accessors

aggregatorValues

Methods

Constructors

constructor

new ModuleModel(name?: string, playerRole?: PlayerRoleFlag): ModuleModel

- Defined in shared/moduleModel.class.ts:71
Parameters
- Optional name: string
  
  The displayed name of this module.
- Optional playerRole: PlayerRoleFlag
  
  Indicates which user is able to see this module.
Returns ModuleModel

Properties

Readonly id

id: string

Unique Id of this module.

name

name: string

The displayed name of also meant for displaying.

playerRole

playerRole: PlayerRoleFlag

Indicates which user is able to see this module.

Readonly type

type: ModuleEnum

Indicates which type of module this is.

Accessors

Abstract aggregatorValues

get aggregatorValues(): undefined | AggregatorValue<number>[]

- Defined in shared/moduleModel.class.ts:100
Returns a list of all AggregatorValues a module has.

Returns undefined | AggregatorValue<number>[]
A list if the module has AggregatorValues, undefined otherwise.

Methods

Protected Abstract init

init(): ModuleEnum

- Defined in shared/moduleModel.class.ts:90
Forces inherited child classes to identify themself with the type of modul they are.

Returns ModuleEnum
The module enum that belongs to this type of module.

updateModule

updateModule(newModule: ModuleModel): void

- Defined in shared/moduleModel.class.ts:106
Updates a module with new settings.

Parameters
- newModule: ModuleModel
  
  A module that holds the new settings.
Returns void

Protected Abstract updateMyself

updateMyself(newModule: ModuleModel): void

- Defined in shared/moduleModel.class.ts:95
Updates module specific settings.

Parameters
- newModule: ModuleModel
  
  A module that holds the new settings.
Returns void

Generated using TypeDoc