Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

Index

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 Slider2DModel

Properties

backgroundImgPath

backgroundImgPath: string = ''

Path of the background image.

Readonly id

id: string

Unique Id of this module.

labelBottomLeft

labelBottomLeft: string = ''

Text at the bottom left corner of the slider.

labelBottomRight

labelBottomRight: string = ''

Text at the bottom right corner of the slider.

labelTopLeft

labelTopLeft: string = ''

Text at the top left corner of the slider.

labelTopRight

labelTopRight: string = ''

Text at the top right corner of the slider.

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

Indicates which type of module this is.

xValue

xValue: AggregatorValue<number> = ...

The marker's horizontal position.

yValue

yValue: AggregatorValue<number> = ...

The marker's vertical position.

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.

setBackgroundImgPath

  • Builder function to set the path of the background image.

    Parameters

    • backgroundImgPath: string

      The new path of the background image.

    Returns Slider2DModel

    A copy of the object with updated settings.

setLabelBottomLeft

  • Builder function to set the text at the bottom left corner of the slider.

    Parameters

    • labelBottomLeft: string

      The new text at the bottom left corner of the slider.

    Returns Slider2DModel

    A copy of the object with updated settings.

setLabelBottomRight

  • Builder function to set the text at the bottom right corner of the slider.

    Parameters

    • labelBottomRight: string

      The new text at the bottom right corner of the slider.

    Returns Slider2DModel

    A copy of the object with updated settings.

setLabelTopLeft

  • Builder function to set the text at the top left corner of the slider.

    Parameters

    • labelTopLeft: string

      The new text at the top left corner of the slider.

    Returns Slider2DModel

    A copy of the object with updated settings.

setLabelTopRight

  • Builder function to set the text at the top right corner of the slider.

    Parameters

    • labelTopRight: string

      The new text at the top right corner of the slider.

    Returns Slider2DModel

    A copy of the object with updated settings.

setXValue

  • Builder function to set the initial horizontal position or value of the marker.

    Parameters

    • xValue: number

      The initial horizontal position or value of the marker.

    Returns Slider2DModel

    A copy of the object with updated settings.

setYValue

  • Builder function to set the initial vertical position or value of the marker.

    Parameters

    • yValue: number

      The initial vertical position or value of the marker.

    Returns Slider2DModel

    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