RegisterHookFunction

Command History

Available since v3.7

Registers a hook function for a specific operation!

Syntax:

registerHookFunction(hook, hookFunction)

Example 1: basic stop animation method

n/a

Arguments

hook: "string"
The operation for which the hook function should be called!

• "setTextPosition" (the hook is called every time the position of a displayed text is set)
• "getActionText" (the hook is called every time 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: none

Return: none

---

日本語 – 正體中文 – 한국어 – Dansk – Deutsch – English – Español – Français – Italiano – Nederlands – Polski – Português – Svenska – Русский