abort

Contents 1 abort() Function 1.1 Usage 1.2 Examples 1.3 Usage Notes 1.3.1 Calling Macro 1.3.2 Called Macro 1.3.3 Results 1.4 See Also 1.5 Version Changes

abort() Function

The abort() function is used to conditionally abort the execution of a macro. If the argument to abort() is 0 then the execution of the macro stops and all macro output is discarded. If the argument to abort() is non zero then the macro continues.

Note that only the output of the macro is discarded when the macro is aborted any changes made to macros will not be undone.

Common uses for this function are

• Ending a macro if the cancel button is clicked on an input dialog created using the input() function.
• Discarding all output generated by the macro, in effect making a "silent" macro.
• Silently bailing out of a macro if a certain condition is not met.

If you prefer to display an error message when exiting the macro see the assert() function.

Usage

Parameters

• abrt - 0 if the abort function should abort the macro, nonzero if it should not.

Examples

The following example will create a dialog box for the user to enter a value for the variable named blah, if the user clicks on cancel then res will be 0 so the abort() function will cause the macro to terminate, otherwise res will not be 0 so the macro will continue.

The following example discards any output in the macro.

The following line can be used to protect macros that only the GM should run

The following line can be used to silently end a macro that can only be run from a Trusted Macro

Usage Notes

When aborting a macro called from another macro (for example, a library token), all macros are aborted, not just the one executing.

Calling Macro

Called Macro

Results

assuming ammunition = { "arrows" : 30 }

TokenName: You have 30 arrows.

assuming ammunition = { "bolts" : 20 }

(nothing)

See Also

assert()

Version Changes

• 1.3b49 - No message is displayed if called from a macroLink.

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.Dialog: A modeless (''i.e.'', does not require user interaction) popup generated by the dialog roll option.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.