Interface ModuleEvents

Hierarchy

ModuleEvents

Index

Properties

disable enable get-hold-to-toggle render text

Properties

disable

disable: (() => void)

Type declaration

- (): void
- Called on any module being disabled.
  
  Returns void

enable

enable: (() => void)

Type declaration

- (): void
- Called on any module being enabled.
  
  Returns void

get-hold-to-toggle

get-hold-to-toggle: (() => boolean)

Type declaration

- (): boolean
- Called on every frame. Return a bool to set the toggle form of the module - true makes it a hold module, like player list; false, standard toggle form.
  
  Returns boolean

render

render: ((isPreview, isEditor) => void)

Type declaration

- (isPreview, isEditor): void
- Called on every frame; use this to render something arbitrary.
  Parameters
  - isPreview: boolean
    
    If it's a preview in the main menu (when module settings are extended.)
  - isEditor: boolean
    
    If it's in the HUD editor where you move modules around.
  Returns void
  
  Note
  Only available in HUD modules.

text

text: ((isPreview, isEditor) => string)

Type declaration

- (isPreview, isEditor): string
- Called on every frame; use this to render text. Return a string to render it on the next frame.
  Parameters
  - isPreview: boolean
  - isEditor: boolean
  Returns string
  
  Note
  Only available in text modules.

Generated using TypeDoc