Class MemoryRecordHotkey

The memoryrecord hotkey class is mainly readonly with the exception of the event properties to be used to automatically create trainers.

Use the generic hotkey class if you wish to create your own hotkeys

Inheritance

Object MemoryRecordHotkey 🡄 Object

Properties

ActivateSound Tablefile name of a WAV file inside the table which will get played on activate events.
DeactivateSound Tablefile name of a .WAV file inside the table which will get played on deactivate events.
Description The description of this hotkey.
HotkeyString The hotkey formatted as a string (ReadOnly).
ID Unique id of this hotkey (ReadOnly).
Keys Table containing the keys(combination) for this hotkey.
OnHotkey Function to be called when a hotkey has just been pressed.
OnPostHotkey Function to be called when a hotkey has been pressed and the action has been performed.
Owner The memoryrecord this hotkey belongs to (ReadOnly).
value Value used depending on what kind of hotkey is used.
action: The action that should happen when this hotkey triggers.

Methods

doHotkey () Executes the hotkey as if it got triggered by the keyboard.


Inheritance

Object
MemoryRecordHotkey 🡄 Object

Properties

ActivateSound
Tablefile name of a WAV file inside the table which will get played on activate events.

Type:

DeactivateSound
Tablefile name of a .WAV file inside the table which will get played on deactivate events.

Type:

Description
The description of this hotkey.

Type:

HotkeyString
The hotkey formatted as a string (ReadOnly).

Type:

ID
Unique id of this hotkey (ReadOnly).

Type:

    integer
Keys
Table containing the keys(combination) for this hotkey.

Type:

OnHotkey
Function to be called when a hotkey has just been pressed.

Type:

    function

Usage:

    MemoryRecordHotkey.OnHotkey = function(sender)
OnPostHotkey
Function to be called when a hotkey has been pressed and the action has been performed.

Type:

    function

Usage:

    MemoryRecordHotkey.OnPostHotkey = function(sender)
Owner
The memoryrecord this hotkey belongs to (ReadOnly).

Type:

value
Value used depending on what kind of hotkey is used.

Type:

action:
The action that should happen when this hotkey triggers.

   mrhToggleActivation(0): Toggles between active/deactive
  mrhToggleActivationAllowIncrease(1): Toggles between active/deactive. Allows increase when active
  mrhToggleActivationAllowDecrease(2): Toggles between active/deactive. Allows decrease when active
  mrhActivate(3): Sets the state to active
  mrhDeactivate(4):  Sets the state to deactive
  mrhSetValue(5):  Sets a specific value to the value properyy (see value)
  mrhIncreaseValue(6):  Increases the current value with the value property (see value)
  mrhDecreaseValue(7):  Decreases the current value with the value property (see value)

integer

Methods

doHotkey ()
Executes the hotkey as if it got triggered by the keyboard.
generated by LDoc 1.4.6-antum-dev-1 Last updated 2019-02-27 23:30:35