Class HudModule

Hierarchy

Module
- HudModule
  - TextModule

Index

Constructors

Properties

description displayName id key name on visible visual

Methods

addBoolSetting addColorSetting addKeySetting addNumberSetting addTextSetting getPos getRect getSettings getSize isBlocked isEnabled setBounds setEnabled setPos setRect setSize

Constructors

constructor

new HudModule(name, displayName, description, key, resizable): HudModule
Parameters
- name: string
- displayName: string
- description: string
- key: KeyCode
- resizable: boolean
Returns HudModule
Overrides Module.constructor
- Defined in feature/hudmodule.d.ts:2

Properties

`Readonly` description

description: string

`Readonly` displayName

displayName: string

`Readonly` id

id: number

IDs for script modules are always 255.

`Readonly` key

`Readonly` name

name: string

on

on: (<K>(eventName, handler) => void)

Type declaration

- <K>(eventName, handler): void
- Type Parameters
  - K extends keyof ModuleEvents
  Parameters
  - eventName: K
  - handler: ModuleEvents[K]
  Returns void

`Readonly` visible

visible: boolean

If the module is visible in the ClickGui

`Readonly` visual

visual: boolean

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

Methods

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
Inherited from Module.addBoolSetting
- Defined in feature/module.d.ts:92

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
Inherited from Module.addColorSetting
- Defined in feature/module.d.ts:131

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
Inherited from Module.addKeySetting
- Defined in feature/module.d.ts:113

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
Inherited from Module.addNumberSetting
- Defined in feature/module.d.ts:104

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
Inherited from Module.addTextSetting
- Defined in feature/module.d.ts:122

getPos

getPos(): Vector2
Returns Vector2
- Defined in feature/hudmodule.d.ts:9

getRect

getRect(): Rect
Returns Rect
- Defined in feature/hudmodule.d.ts:4

getSettings

getSettings(): Setting[]
Gets the settings of the module.

Returns Setting[]
Inherited from Module.getSettings
- Defined in feature/module.d.ts:83

getSize

getSize(): number
Returns number
- Defined in feature/hudmodule.d.ts:7

isBlocked

isBlocked(): boolean
Check if the module is blocked.

Returns boolean
Inherited from Module.isBlocked
- Defined in feature/module.d.ts:78

isEnabled

isEnabled(): boolean
Checks if the module is enabled.

Returns boolean
Inherited from Module.isEnabled
- Defined in feature/module.d.ts:67

setBounds

setBounds(width, height): void
Parameters
- width: number
- height: number
Returns void
- Defined in feature/hudmodule.d.ts:6

setEnabled

setEnabled(b): void
Set the module to be enabled or not.
Parameters
- b: boolean
  
  The new status of the module.
Returns void
Inherited from Module.setEnabled
- Defined in feature/module.d.ts:73

setPos

setPos(x, y): void
Parameters
- x: number
- y: number
Returns void
- Defined in feature/hudmodule.d.ts:10

setRect

setRect(newRect): void
Parameters
- newRect: Rect
Returns void
- Defined in feature/hudmodule.d.ts:5

setSize

setSize(): number
Returns number
- Defined in feature/hudmodule.d.ts:8

Generated using TypeDoc