Leunsel: Syntax Highlighting.

2026-06-25T18:49:57Z

Syntax Highlighting.

Leunsel: Initial page creation.

2025-07-11T13:03:24Z

Initial page creation.

New page

[[Category:MemoryRecordHotkey]]
'''class''' MemoryRecordHotkey ('''Inheritance''': ''[[Lua:Class:Object|Object]]'')

The MemoryRecordHotkey class represents a hotkey attached to a memory record.
It is mainly read-only, except for event properties used for trainer creation.
For custom hotkeys not tied to memory records, use the generic hotkey class.

===Properties===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Property
!align="left"|Type
!style="width: 80%;background-color:white;" align="left"|Description
|-
|Owner
|MemoryRecord
|The memory record this hotkey belongs to (ReadOnly).
|-
|Keys
|Table
|Table containing the key combination for this hotkey.
|-
|action
|Integer
|The action that should happen when this hotkey triggers. See action values below.
|-
|value
|String
|Value used depending on the hotkey type (see action).
|-
|ID
|Integer
|Unique ID of this hotkey (ReadOnly).
|-
|Active
|Boolean
|True if this hotkey will be handled, false if ignored.
|-
|Description
|String
|The description of this hotkey.
|-
|HotkeyString
|String
|The hotkey formatted as a string (ReadOnly).
|-
|ActivateSound
|String
|Tablefile name of a WAV file inside the table to play on activate events.
|-
|DeactivateSound
|String
|Tablefile name of a WAV file inside the table to play on deactivate events.
|-
|OnHotkey
|Function(sender)
|Function called when a hotkey has just been pressed.
|-
|OnPostHotkey
|Function(sender)
|Function called when a hotkey has been pressed and the action has been performed.
|}

===Action Values===
{|width="85%" cellpadding="5" cellspacing="0" border="0"
!align="left"|Constant
!align="left"|Value
!align="left"|Description
|-
|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 property.
|-
|mrhIncreaseValue
|6
|Increases the current value with the value property.
|-
|mrhDecreaseValue
|7
|Decreases the current value with the value property.
|}

===Methods===
{|width="85%" cellpadding="10%" cellspacing="0" border="0"
!align="left"|Method
!align="left"|Parameters
!align="left"|Returns
!style="width: 80%;background-color:white;" align="left"|Description
|-
|doHotkey
|None
|None
|Executes the hotkey as if it got triggered by the keyboard.
|}

===Examples===
<pre>
-- List all hotkeys for a memory record
local mr = AddressList[0]
for i=0, mr.HotkeyCount-1 do
local hk = mr.Hotkey[i]
print("Hotkey:", hk.HotkeyString, "Action:", hk.action, "Active:", hk.Active)
end

-- Set a function to run when a hotkey is pressed
local hk = mr.Hotkey[0]
hk.OnHotkey = function(sender)
print("Hotkey pressed for:", sender.Owner.Description)
end

-- Execute a hotkey manually
hk:doHotkey()
</pre>

== See also ==
* [[Lua:Class:MemoryRecord|MemoryRecord]]
* [[Lua:AddressList|AddressList]]

@@ Line 114: / Line 114: @@
 ===Examples===
-<pre>
+<syntaxhighlight lang="lua" line>
 -- List all hotkeys for a memory record
 local mr = AddressList[0]
@@ Line 130: / Line 130: @@
 -- Execute a hotkey manually
 hk:doHotkey()
-</pre>
+</syntaxhighlight>
 == See also ==
 * [[Lua:Class:MemoryRecord|MemoryRecord]]
 * [[Lua:AddressList|AddressList]]

Lua:Class:MemoryRecordHotkey - Revision history

Leunsel: Syntax Highlighting.

Leunsel: Initial page creation.