Class TextModule

Readonly description

Readonly displayName

Readonly id

Readonly key

Readonly name

on

Readonly visible

Readonly visual

addBoolSetting

• addBoolSetting(name, displayName, description, defVal): Setting

• Adds a setting.

  Parameters

  • name: string

    The internal name

  • displayName: string

    The name that shows in the menu

  • description: string

    A short description of what the setting does

  • defVal: boolean

    The default value

  Returns Setting

addColorSetting

• addColorSetting(name, displayName, description, defVal): Setting

• Adds a setting. *

  Parameters

  • name: string

    The internal name *

  • displayName: string

    The name that shows in the menu *

  • description: string

    A short description of what the setting does *

  • defVal: Color

    The default value

  Returns Setting

addKeySetting

• addKeySetting(name, displayName, description, defVal): Setting

• Adds a setting. *

  Parameters

  • name: string

    The internal name *

  • displayName: string

    The name that shows in the menu *

  • description: string

    A short description of what the setting does *

  • defVal: KeyCode

    The default value

  Returns Setting

addNumberSetting

• addNumberSetting(name, displayName, description, min, max, interval, defVal): Setting

• Adds a setting.

  Parameters

  • name: string

    The internal name

  • displayName: string

    The name that shows in the menu

  • description: string

    A short description of what the setting does

  • min: number

    The minimum value

  • max: number

    The maximum value

  • interval: number

    The precision of the setting

  • defVal: number

    The default value

  Returns Setting

addTextSetting

• addTextSetting(name, displayName, description, defVal): Setting

• Adds a setting. *

  Parameters

  • name: string

    The internal name *

  • displayName: string

    The name that shows in the menu *

  • description: string

    A short description of what the setting does *

  • defVal: string

    The default value

  Returns Setting

getPos

• getPos(): Vector2

• Returns Vector2

getRect

• getRect(): Rect

• Returns Rect

getSettings

• getSettings(): Setting[]

• Gets the settings of the module.

  Returns Setting[]

getSize

• getSize(): number

• Returns number

isBlocked

• isBlocked(): boolean

• Check if the module is blocked.

  Returns boolean

isEnabled

• isEnabled(): boolean

• Checks if the module is enabled.

  Returns boolean

setBounds

• setBounds(width, height): void

• Parameters

  • width: number

  • height: number

  Returns void

setEnabled

• setEnabled(b): void

• Set the module to be enabled or not.

  Parameters

  • b: boolean

    The new status of the module.

  Returns void

setPos

• setPos(x, y): void

• Parameters

  • x: number

  • y: number

  Returns void

setRect

• setRect(newRect): void

• Parameters

  • newRect: Rect

  Returns void

setSize

• setSize(): number

• Returns number