RegisterHookFunction - Revision history

EK: Redirected page to Global Command: registerHookFunction

2023-05-19T11:28:50Z

Redirected page to Global Command: registerHookFunction

Vis apiuser at 20:27, 30 September 2014

2014-09-30T20:27:56Z

Vis apiuser at 13:56, 26 November 2013

2013-11-26T13:56:47Z

Vis apiuser at 16:12, 22 November 2013

2013-11-22T16:12:08Z

AFRLme at 20:45, 17 June 2013

2013-06-17T20:45:07Z

AFRLme at 18:41, 7 March 2013

2013-03-07T18:41:01Z

AFRLme at 18:38, 7 March 2013

2013-03-07T18:38:13Z

AFRLme: Created page with "
Command History

2013-03-07T18:37:33Z

Created page with "<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%"> <b>Command History</b> <div class="mw-collapsible-co..."

New page
<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
<b>Command History</b>
<div class="mw-collapsible-content">
<div style="background:#ebebeb" width="100%">Available since <span style="color:orange">v3.7</span></div>
</div></div>

Registers a hook function for a specific operation!

Syntax:
<syntaxhighlight>
registerHookFunction(hook, hookFunction)
</syntaxhighlight>

Example 1: basic stop animation method
<syntaxhighlight>
n/a
</syntaxhighlight>

<b><u>Arguments</u></b>

hook: "string" <br/>
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" <br/>
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
{{i18n|StopAnimation}}

← Older revision		Revision as of 11:28, 19 May 2023
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), "getWalkAnimationIndex" (the hook is called everytime a character changes its direction during walking).
−	~~====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.
−	:"getCharacterAnimationIndex": The function takes exactly 3 arguments: the character (visionaire object), animation type () and new direction (degrees). The function must return an integer value which specifies the walk animation to use for the new direction (0-based index).
−	~~:If -1 is returned the index is handled by the engine (as if there were no hook).~~
−	~~===Flags===~~
−	~~===Return Values===~~
−	~~None.~~
−	~~===Examples===~~
−	~~Example 1: setTextPosition~~
−	~~<syntaxhighlight>~~
−	~~function adaptedTextPosition(text)~~
−	~~-- show texts of character Hero 10 pixel below character position~~
−	~~local owner = text:getLink(VTextOwner)~~
−	~~if owner:getId().tableId == eCharacters and owner:getName() == 'Hero' then~~
−	~~local pos = owner:getPoint(VCharacterPosition)~~
−	~~pos.y = pos.y + 10~~
−	~~text:setValue(VTextPosition, pos)~~
−	~~return true~~
−	~~end~~
−	~~return false~~
−	~~end~~
−
−	~~registerHookFunction("setTextPosition", "adaptedTextPosition")~~
−
−	~~</syntaxhighlight>~~
−	~~Example 2: getActionText~~
−	~~<syntaxhighlight>~~
−	~~function myActionText(mousePos)~~
−	~~-- individual action text: object name (in current language) of object below cursor, if there is no object then '<empty>' is shown as action text~~
−	~~local obj = game:getLink(VGameCurrentObject)~~
−	~~if obj:getId().tableId == eObjects then~~
−	~~return 'current object: ' .. obj~~:~~getTextStr(VObjectName)~~
−	~~end~~
−	~~return '<empty>'~~
−	~~end~~
−
−	registerHookFunction~~("getActionText", "myActionText")~~
−
−	~~</syntaxhighlight>~~

@@ Line 9: / Line 9: @@
 ===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).
+:'''"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), "getWalkAnimationIndex" (the hook is called everytime a character changes its direction during walking).
 ====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).
+:'''"string"''' - The name of the lua function which is called when the hook is executed.
 :"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.
+Example 1: setTextPosition
-[[Category:Player Commands]]
+<syntaxhighlight>

← Older revision		Revision as of 13:56, 26 November 2013
Line 18:		Line 18:
	===Examples===		===Examples===
	None.		None.
		+	[[Category:Player Commands]]

@@ Line 1: / Line 1: @@
-<div class="toccolours mw-collapsible mw-collapsed" style="background: #f0f0f0; border: 1px dashed darkgrey" width="100%">
+==registerHookFunction==
-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>
-<syntaxhighlight>
+===Arguments===
-registerHookFunction(hook, hookFunction)
+====hook====
-</syntaxhighlight>
+:'''"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).
-Example:
+:"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.
-<syntaxhighlight>
+===Flags===
-n/a
+===Return Values===
-</syntaxhighlight>
+None.
+===Examples===
+None.

@@ Line 33: / Line 33: @@
 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!
+*"getActionText": The function should take exactly one argument which is the current mouse position (a table containing the 'absolute' x and y position). The function must return a string value which will be used as the current action text!

@@ Line 28: / Line 28: @@
 * "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" <br/>
@@ Line 33: / Line 34: @@
 * "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