defineFunction

Contents 1 defineFunction() Function 1.1 Usage 1.2 Example 1.3 See Also 1.4 Version Changes

defineFunction() Function

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.

Usage

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

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

See Also

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

Version Changes

• 1.3b56 - Added ignoreOutput and newScope parameter options.

Trusted Macro: A macro run from a Library token or run by the GM, that cannot be edited by a player.Macro: A series of text instructions used to automate processes in MapTool.Campaign: A zipped XML file with the '''.cmpgn''' file extension containing tokens, maps, token macros, campaign macros, and token propertiesMap: An image file displayed in the map display area in MapTool. This image is shared among all connected players and the GM.