|
|
| (One intermediate revision by one other user not shown) |
| Line 1: |
Line 1: |
| − | ==registerHookFunction==
| + | #REDIRECT [[Global Command: registerHookFunction]] |
| − | | |
| − | <div class="command-min-version-info">Available since: <span class="command-min-version">v3.0</span></div>
| |
| − | | |
| − | <div class="command-doc">Registers a hook function for a specific operation.</div>
| |
| − | | |
| − | Lua Syntax:
| |
| − | <pre class="command-syntax">registerHookFunction(hook, hookFunction)</pre>
| |
| − | ===Arguments===
| |
| − | ====hook====
| |
| − | :'''"string"''' - The operation for which the hook function should be called. Currently supported hooks: "setTextPosition" (the hook is called everytime the position of a displayed text is set), "getActionText" (the hook is called everytime to get the currently displayed action text).
| |
| − | ====hookFunction====
| |
| − | :'''"string"''' - The name of the lua function which is called when the hook is executed. "setTextPosition": The function should take exactly one argument which is the affected visionaire object. The function must return a boolean value: true if the operation was handled in the hook function, false if the operation was not handled and should be handled by the engine (as if there were no hook).
| |
| − | :"getActionText": The function should take exactly one argument which is the current mouse position (a table containing x- and y-position). The function must return a string value which will be used as the current action text.
| |
| − | ===Flags===
| |
| − | ===Return Values===
| |
| − | None.
| |
| − | ===Examples===
| |
| − | None.
| |
| − | [[Category:Player Commands]] | |
