defineFunction: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 15: Line 15:
* {{code|macro}} - The name and location of the macro that is called when the user defined function is used.
* {{code|macro}} - The name and location of the macro that is called when the user defined function is used.


}}
 
 
|examples=
|examples=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
Line 22: Line 23:


Defines a function character.heal() which calls heal@Lib:Character when evoked.
Defines a function character.heal() which calls heal@Lib:Character when evoked.
}}


[[Category:Miscellaneous Function]]
[[Category:Miscellaneous Function]]

Revision as of 16:19, 10 March 2009

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

defineFunction() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.3b51
Defines a user function that can be used anywhere that core functions can be used. A user defined function is a link to another macro.

Usage

defineFunction(function, macro)

Parameters

  • function - The name of the user defined function to be defined.
  • macro - The name and location of the macro that is called when the user defined function is used.

Examples

[h: defineFunction(character.heal, "heal@Lib:Character")]
Defines a function character.heal() which calls heal@Lib:Character when evoked.