defineFunction

From MapToolDoc
Jump to: navigation, search

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Could use examples of the ignoreOutput and newScope parameters.

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. A special macro labeled onCampaignLoad is useful for defining functions upon the loading of your campaign. This because the function will be defined AFTER the macro has been run. In case of onCampaignLoad, that macro is always run when the campaign is loaded. This saves you the hassle of manually requiring to run this macro to enable the definition.

Usage

  1. defineFunction(function, macro)
  1. defineFunction(function, macro, ignoreOutput)
  1. defineFunction(function, macro, ignoreOutput, newScope)

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.
  • ignoreOutput - If the defined function should ignore all output and only return the value of macro.return, defaults to false(0).
  • newScope - If the defined function should create a new variable scope when executed, defaults to true(1). A new variable scope means that the defined function can only read the variables of the macro that called it; if you do not create a new scope the defined function can read, update, and create variables in its parent's variable scope. Updating variables in the parent's scope includes over-writing any parameters that a parent might have stored within arg(), if a user-defined function that does not create a new scope is called within another user-defined function.

Example

  1. [h: defineFunction("character.heal", "heal@Lib:Character")]

Defines a function character.heal() which calls heal@Lib:Character when evoked. Note that in this case there must exist a function called "heal" on a token called "lib:Character". The advantage of using the prefix "lib:" on the token name is that it becomes a "lib:token" which is accessible from ANY map instead of only the map you happen to have active.

Should you pass on any arguments e.g.

  1. [h: character.heal("hello", "hi")]

then these parameters can be accessed inside character.heal() by using

  1. [h: firstArg = arg(0)]
  2. [h: theOtherOne = arg(1)]

See Also

oldFunction(), arg(), argCount(), onCampaignLoad

Version Changes

  • 1.3b56 - Added ignoreOutput and newScope parameter options.