Difference between revisions of "ScriptHook: Key Binds"
From Nomad DB
Line 1: | Line 1: | ||
A [[WD2 ScriptHook: Script|Script]] can register Key bindings. | A [[WD2 ScriptHook: Script|Script]] can register Key bindings. | ||
− | == Registering a Key Bind == | + | ==Registering a Key Bind== |
To register a Key bind, use the [[WD2 ScriptHook: Script|Script]]'s [[WD2 ScriptHook: manifest.json|manifest.json]]. | To register a Key bind, use the [[WD2 ScriptHook: Script|Script]]'s [[WD2 ScriptHook: manifest.json|manifest.json]]. | ||
Line 13: | Line 13: | ||
'''[[Key Codes|List of Key Codes]]''' | '''[[Key Codes|List of Key Codes]]''' | ||
− | == Key Handler == | + | ==Key Handler== |
Use [[ScriptHook.RegisterKeyHandler]] function. | Use [[ScriptHook.RegisterKeyHandler]] function. | ||
− | === Example === | + | ===Example=== |
Registers a callback function to a Key binding. In combination with the ''manifest.json'' above, this code would print "Key Bind" to the [[WD2 ScriptHook: Console|Console]] when pressing F5. | Registers a callback function to a Key binding. In combination with the ''manifest.json'' above, this code would print "Key Bind" to the [[WD2 ScriptHook: Console|Console]] when pressing F5. | ||
Line 22: | Line 22: | ||
ScriptHook.RegisterKeyHandler("test", function() | ScriptHook.RegisterKeyHandler("test", function() | ||
print("Key Bind") | print("Key Bind") | ||
− | + | end) | |
</syntaxhighlight> | </syntaxhighlight> | ||
− | == Related Pages == | + | ==Related Pages== |
− | * [[WD2 ScriptHook]] | + | |
− | * [[WD2 ScriptHook: manifest.json]] | + | *[[WD2 ScriptHook]] |
− | * [[Key Codes]] | + | *[[WD2 ScriptHook: manifest.json]] |
+ | *[[Key Codes]] | ||
[[Category:WD2 ScriptHook]] | [[Category:WD2 ScriptHook]] |
Revision as of 12:41, 27 April 2020
A Script can register Key bindings.
Registering a Key Bind
To register a Key bind, use the Script's manifest.json.
manifest.json
"keyBinds": {
"test": "F5"
}
Key Handler
Use ScriptHook.RegisterKeyHandler function.
Example
Registers a callback function to a Key binding. In combination with the manifest.json above, this code would print "Key Bind" to the Console when pressing F5.
ScriptHook.RegisterKeyHandler("test", function()
print("Key Bind")
end)