Module

Module Object

setToggled

module.setToggled(false)

module.setToggled(true)

Sets the module to a new toggled state.

Parameter

Type

Description

state

Boolean

The new state of the module

toggle

module.toggle()

Toggles the module

toggleSilent

module.toggleSilent()

Toggles the module without sending a notification

isEnabled

if(aura.isEnabled()){...

if(keystrokes.isEnabled()){...

Returns true if the module is enabled

setKey

module.setKey(code)

Sets the keybind to the new keycode

Parameter

Type

Description

code

Number

The new keybind code of the module

getName

var modName = module.getName()

Returns the name of the module as a String

getDescription

var modDesc = module.getDescription()

Returns the description of the module as a String

getKeybindCode

var code = module.getKeybindCode()

Returns the current code of the keybind for the module as a Number

Get Settings

These functions allow for getting settings within the module

The only parameter is the setting name and it returns its respective setting object

Will return null if the setting does not exist

var numSetting = module.getNumberSetting(name)

var boolSetting = module.getBooleanSetting(name)

var modeSetting = module.getModeSetting(name)

var stringSetting = module.getStringSetting(name)

var multiBoolSetting = module.getMultiBoolSetting(name)

var colorSetting = module.getColorSetting(name)

Last updated