Class Module

Hierarchy

Module
- HudModule

Index

Constructors

Properties

description displayName id key name on visible visual

Methods

addBoolSetting addColorSetting addKeySetting addNumberSetting addTextSetting getSettings isBlocked isEnabled setEnabled

Constructors

constructor

new Module(name, displayName, description, key): Module
Parameters
- name: string
  
  The internal name of the module.
- displayName: string
  
  The display name of the module. Shown in the ClickGUI.
- description: string
  
  A short description of what the module does.
- key: KeyCode
  
  The default keybind to activate the module.
Returns Module
- Defined in feature/module.d.ts:60

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

getSettings

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

Returns Setting[]
- Defined in feature/module.d.ts:83

isBlocked

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

Returns boolean
- Defined in feature/module.d.ts:78

isEnabled

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

Returns boolean
- Defined in feature/module.d.ts:67

setEnabled

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

Generated using TypeDoc