Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TextModel

A text block with a header.

Settings

  • @member heading Header of this text block.
  • @member content Content of this text block.

Controls

  • None

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Parameters

    • Optional name: string

      The displayed name of this module.

    • Optional playerRole: PlayerRoleFlag

      Indicates which user is able to see this module.

    Returns TextModel

Properties

content

content: string = ''

Content of this text block.

heading

heading: string = ''

Header of this text block.

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

aggregatorValues

  • Returns undefined | AggregatorValue<number>[]

Methods

init

  • 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.

setContent

  • Builder function to set the content of this text block.

    Parameters

    • content: string

      The new content of this text block.

    Returns TextModel

    A copy of the object with updated settings.

setHeading

  • Builder function to set the header of this text block.

    Parameters

    • heading: string

      The new header of this text block.

    Returns TextModel

    A copy of the object with updated settings.

updateModule

  • Updates a module with new settings.

    Parameters

    • newModule: ModuleModel

      A module that holds the new settings.

    Returns void

updateMyself

Generated using TypeDoc