class.TextModule.md

Latite Scripting Documentation (Exports)

---

Exports > feature/hudmodule > TextModule

TextModule

Class

Source: feature/hudmodule.d.ts:13

Hierarchy

• HudModule.TextModule

Constructors

constructor()

new TextModule( name: string, displayName: string, description: string, key: KeyCode): TextModule

Source: feature/hudmodule.d.ts:14

Parameters

Parameter	Type
name	string
displayName	string
description	string
key	KeyCode

Returns

TextModule

Overrides

HudModule.constructor

Properties

description

readonly description: string

Source: feature/module.d.ts:37

Inherited from

HudModule.description

displayName

readonly displayName: string

Source: feature/module.d.ts:36

Inherited from

HudModule.displayName

id

readonly id: number

IDs for script modules are always 255.

Source: feature/module.d.ts:43

Inherited from

HudModule.id

key

readonly key: KeyCode

Source: feature/module.d.ts:38

Inherited from

HudModule.key

name

readonly name: string

Source: feature/module.d.ts:35

Inherited from

HudModule.name

on

on: Function

Source: feature/module.d.ts:62

Type declaration (on)

<K>(eventName: K, handler: ModuleEvents[K]): void

Source: feature/module.d.ts:62

Type parameters

Parameter
K extends keyof ModuleEvents

Parameters

Parameter	Type
eventName	K
handler	ModuleEvents[K]

Returns

void

Inherited from

HudModule.on

visible

readonly visible: boolean

If the module is visible in the ClickGui

Source: feature/module.d.ts:51

Inherited from

HudModule.visible

visual

readonly visual: boolean

If the module is a HUD module (that you can move in the hud editor)

Source: feature/module.d.ts:47

Inherited from

HudModule.visual

Methods

addBoolSetting()

addBoolSetting( name: string, displayName: string, description: string, defVal: boolean): Setting

Adds a setting.

Source: feature/module.d.ts:92

Parameters

Parameter	Type	Description
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

Inherited from

HudModule.addBoolSetting

addColorSetting()

addColorSetting( name: string, displayName: string, description: string, defVal: Color): Setting

Adds a setting.

• Source: feature/module.d.ts:131

Parameters

Parameter	Type	Description
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

Inherited from

HudModule.addColorSetting

addKeySetting()

addKeySetting( name: string, displayName: string, description: string, defVal: KeyCode): Setting

Adds a setting.

• Source: feature/module.d.ts:113

Parameters

Parameter	Type	Description
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

Inherited from

HudModule.addKeySetting

addNumberSetting()

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

Adds a setting.

Source: feature/module.d.ts:104

Parameters

Parameter	Type	Description
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

Inherited from

HudModule.addNumberSetting

addTextSetting()

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

Adds a setting.

• Source: feature/module.d.ts:122

Parameters

Parameter	Type	Description
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

Inherited from

HudModule.addTextSetting

getLastText()

getLastText(): string

Source: feature/hudmodule.d.ts:17

Returns

string

getPos()

getPos(): Vector2

Source: feature/hudmodule.d.ts:9

Returns

Vector2

Inherited from

HudModule.getPos

getRect()

getRect(): Rect

Source: feature/hudmodule.d.ts:4

Returns

Rect

Inherited from

HudModule.getRect

getSettings()

getSettings(): Setting[]

Gets the settings of the module.

Source: feature/module.d.ts:83

Returns

Setting[]

Inherited from

HudModule.getSettings

getSize()

getSize(): number

Source: feature/hudmodule.d.ts:7

Returns

number

Inherited from

HudModule.getSize

isBlocked()

isBlocked(): boolean

Check if the module is blocked.

Source: feature/module.d.ts:78

Returns

boolean

Inherited from

HudModule.isBlocked

isEnabled()

isEnabled(): boolean

Checks if the module is enabled.

Source: feature/module.d.ts:67

Returns

boolean

Inherited from

HudModule.isEnabled

setBounds()

setBounds(width: number, height: number): void

Source: feature/hudmodule.d.ts:6

Parameters

Parameter	Type
width	number
height	number

Returns

void

Inherited from

HudModule.setBounds

setEnabled()

setEnabled(b: boolean): void

Set the module to be enabled or not.

Source: feature/module.d.ts:73

Parameters

Parameter	Type	Description
b	boolean	The new status of the module.

Returns

void

Inherited from

HudModule.setEnabled

setPos()

setPos(x: number, y: number): void

Source: feature/hudmodule.d.ts:10

Parameters

Parameter	Type
x	number
y	number

Returns

void

Inherited from

HudModule.setPos

setRect()

setRect(newRect: Rect): void

Source: feature/hudmodule.d.ts:5

Parameters

Parameter	Type
newRect	Rect

Returns

void

Inherited from

HudModule.setRect

setSize()

setSize(): number

Source: feature/hudmodule.d.ts:8

Returns

number

Inherited from

HudModule.setSize