macroLinkText

Contents 1 macroLinkText() Function 1.1 Usage 1.2 Examples 1.3 See Also 1.4 Version Changes

macroLinkText() Function

Creates the text that would appear in a HTML tag for a link which will run the specified macro when clicked on. This is useful for callbacks in [dialog():] or [frame():]. If you just want to send a click-able link to someone use macroLink().

Usage

Parameters

• macroName - The name of the macro to run when the link is clicked. The macroName is in the standard macro reference format (e.g. Macro@Lib:Token)
• output - Who the output of the macro should go to, values are (defaults to none):
  • self - Display only to person who clicked on the link.
  • gm - Display to GM.
  • all - Everyone (acts like a /say)
  • none - Discard any output.
  • gm-self - Display to GM and the person executing the link.
  • list - Displays to a list of players. When the output parameter is "list" then the macro link expects the args parameter to be a JSON Object, that contains a field called mlOutputList which is a JSON Array containing the players to send the output to.
• args - Any arguments to be passed to the macro when it is called.
• target - Which tokens to run the macro on. Target can be one or more of the following separated by commas (defaults to impersonated):
  • impersonated - The impersonated Token.
  • selected - The selected Token/s.
  • Token ID - The id of a Token.

Examples

To create the text that would go inside a form element as the action attribute, and that will call a macro named Test on the Library Token named Lib:Test:

Returns: macro://Test@Lib:Test/gm/impersonated?

To create the text that would go inside a form element as the action attribute and call the AddWeapon on the Library Token named Lib:PC which will act upon the Current Token:

Returns: macro://AddWeapon@Lib:PC/none/#ID#? where #ID# is the id of the Current Token.

Sending to multiple players and the GM in 1.3b55

Correctly modifying the colour of the link, works both in the chat box and in forms:

See Also

macroLink()

Version Changes

• 1.3b55 - Added gm-self and list output options.
• 1.3b56 - Links created using this function will no longer show a tooltip when displayed in a dialog or frame.

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.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.Frame: A dockable MapTool window that can be generated via the frame 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.