macro.args

The variable macro.args holds the value of the argument passed to a trusted macro via the MACRO() roll option. macro.args exists only within the macro that is called, and may be manipulated like any variable in a macro.

Contents 1 Examples 1.1 1: Single parameter 1.1.1 Calling Macro 1.1.2 Called Macro 1.2 2A: Multiple parameters using String Property List 1.2.1 Calling Macro 1.2.2 Called Macro 1.3 2B: Multiple parameters using JSON Array 1.3.1 Calling Macro using JSON Array 1.3.2 Called Macro using JSON Array 1.4 2C: Multiple parameters using JSON Object 1.4.1 Calling Macro using JSON Object 1.4.2 Called Macro using JSON Object 2 See Also

Examples

1: Single parameter

When a macro on a library token is called by another macro, the calling macro may pass one argument to the called macro:

Calling Macro

Called Macro

In the example above, damageDice is the argument being passed to the macro getDamage, which resides on the Lib:test library token. Within the getDamage macro, the variable macro.args is automatically generated and assigned the value of damageDice.

It's important to note that only a single parameter can be passed to a macro and that parameter appears in the macro.args variable. If more than a single parameter needs to be sent to a macro, you may use string property lists, a JSON array or object, or a user-defined function. The first two techniques are demonstrated below.

2A: Multiple parameters using String Property List

A string property list essentially bundles multiple values into a single string which would then be split back apart inside the macro body.

Calling Macro

Called Macro

2B: Multiple parameters using JSON Array

The second way to pass multiple parameters is to use a JSON Array or JSON Object.

Using a JSON data type passes multiple values as a single unit. When using JSON data types, there will be a single parameter coming into the macro but because it's either an array or an object you can retrieve individual fields quite easily.

As the json.append() is being passed "[]" as the first parameter in this next code block, it's creating an empty JSON Array and then appending two new values to it.

Calling Macro using JSON Array

Called Macro using JSON Array

2C: Multiple parameters using JSON Object

Notice that in this next example, the json.set() is being passed "{}" as the first parameter. This indicates to the function that we want a JSON Object.

Calling Macro using JSON Object

Called Macro using JSON Object

See Also

macro.return, [macro():]

Library Token: A special token designed to hold a library of macros (similar to a function library) that can be called by token macros, campaign macros, and global macros. Often called "Lib:tokens."Token: A visual marker representing a character, monster, or NPCCampaign Macro: A macro specific to a campaign file. These macros are available to players and the GM, and are displayed in the Campaign Macros window.Global Macro: Macros that are available regardless of the campaign file currently loaded in MapTool, and regardless of whether the instance of MapTool is a server or a client. Global macros are ''only'' available to the running instance.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.Roll Option: One of several "switches" that alter how the macro code following the switch is executedString Property List: A string containing key-value pairs in the format "key1=value1; key2=value2; key3=value3;..."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.Property: Generic term for a variable contained in a token; a more explicit term is token property