Difference between revisions of "RegisterHookFunction"
From The Official Visionaire Studio: Adventure Game Engine Wiki
m |
|||
| Line 1: | Line 1: | ||
| − | + | ==registerHookFunction== | |
| − | |||
| − | |||
| − | |||
| − | |||
| + | <div class="command-min-version-info">Available since: <span class="command-min-version">v3.0</span></div> | ||
| − | Registers a hook function for a specific operation | + | <div class="command-doc">Registers a hook function for a specific operation.</div> |
| − | + | Lua Syntax: | |
| − | Syntax: | + | <pre class="command-syntax">registerHookFunction(hook, hookFunction)</pre> |
| − | < | + | ===Arguments=== |
| − | registerHookFunction(hook, hookFunction) | + | ====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. | |
| − | |||
| − | |||
| − | |||
| − | |||
| − | The operation for which the hook function should be called | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | The name of the lua function which is called when the hook is executed | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Revision as of 17:12, 22 November 2013
Contents
registerHookFunction
Available since: v3.0
Registers a hook function for a specific operation.
Lua Syntax:
registerHookFunction(hook, hookFunction)
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.
