Simple Key Event Helper (SKEH)

This mod is for mod developers who wish to incorporate custom keybindings into their mod. You will need to install this helper mod if a mod requires it.

Source code and nicer looking readme @ https://github.com/Notexe/h3-simple-key-event-helper

Example mods using this

• []Simple HUD Toggle

  []Keyboard Keypad Input

• Toggling the m_bEnabled property results in the keybinds not being set correctly if you are using the dynamic object method. I suspect the game for some reason falls back to the m_sModifierKeyName and m_sKeyName properties. Workaround: Use the Enable/Disable pins instead or send the NotifyDataChanged input pin to the dynamic object entity for the keybinds to get restored.

This helper mod allows you to setup custom keybinds which you can then use to fire pins in your mod. Please reference this mod in the "requirements" section in your mod's manifest like so:

"requirements": [

"Notex. SimpleKeyEventHelper"

There are two methods of using this mod:

1. First method: With this method you can just use the m_sModifierKeyName and m_sKeyName properties in the SimpleKeyEventHelper entity to configure the keybind.

2. Second method: This method involves using a dynamic object entity referenced in a property called m_pDataProvider in the SimpleKeyEventHelper` entity. The second method can be used if you wish to provide customisability options in your SMF mod without having to use duplicated entity.json or entity.patch.json files.

First method

SimpleKeyEventHelper entity:

"parent": null,

"name": "SimpleKeyEventHelper",

"factory": ".pc_entitytype",

"blueprint": ".pc_entityblueprint",

"properties": {

"m_sModifierKeyName": {

"type": "ZString",

"value": "None"

"m_sKeyName": {

"type": "ZString",

"value": "F7"

"events": {

"Pressed": {},

"Down": {},