execLink

execLink() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.3b55

Executes a macro link that was created with macroLinkText(), output generated by the link is sent to players using the standard macroLinkText() logic. execLink() allows you to defer the running of the link until after the currently running macro has ended in which case the output will be displayed after any output generated by the current macro. If you defer a series of links, they will be queued in order and executed after the currently running macro. There is no software limit to the amount of links you can queue, but your hardware will impose its own limitations. If the execution of the link is not defered then any output generated will appear before any output generated by the current macro. You can use this function to update values in a token copied with copyToken() using the defered option. You can also use this function to send output selectivly to a list of players from the current macro, or to generate output that is not suppressed when the abort() function is called.

Usage

execLink(link)
execLink(link, defer)
execLink(link, defer, targets)
execLink(link, defer, targets, delim)

Parameters

• link - The link to "execute".
• defer - Executes the link after the current macro has completed if non zero, defaults to zero.
• targets - are the user names (so not token names) but the names of the users that are logged in. The options "gm", "gm-self", "self", "not-self", "not-gm", "not-gm-self", "none", and "all" are also valid parameters to give. E.g.: "tim, tom, tarra". Defaults to self (so if no parameter is given the link is executed locally only). Here is a summary of the valid values:

Player name: The named player.

self: Self only (default, link is only executed locally).

gm: GM only.

gm-self: Both the GM and self.

all: All connected players and GMs.

not-self: Anyone but self.

not-gm: All non-GMs.

not-gm-self: All players apart from the GM and self.

none: No players. No GMs.

• delim - The delimiter used to separate the values in the String List that is given, defaults to ",". If "json" is specified, a JSON array is expected instead of a String List.

Examples

Execute a macro link immediately (any output will appear before the current macros output).

[h: link = macroLinkText("Test@Lib:Test", "self")]
[h: execLink(link)]

Execute a macro link after the execution of the current macro (any output will appear after the current macros output).

[h: link = macroLinkText("Test@Lib:Test", "self")]
[h: execLink(link, 1)]

Copy a token and update its values.

[h: newToken = copyToken("Hero")]
[h: link = macroLinkText("update@Lib:GM", "none", "", newToken)]
[h: execLink(link)]

Execute a macro link on all clients.

[h: link = macroLinkText("Test@Lib:Test", "none")]
[h: execLink(link, 0, "all")]

Opening an overlay with arguments to the GM panel macro loadGMOverlay for all connected GMs.

• This is a very useful pattern to load an overlay with a library token using onCampaignLoad.
• In this example, the hypothetical overlay function can take text and background color arguments in a String Property List.

[h: link = macroLinkText("loadGMOverlay@GM", "none", "text=white;background=black")] 
[h: execLink(link, 0, "gm")]

See Also

macroLinkText() macroLink() copyToken()

Version Changes

• 1.5.5 - Added the targets and delim parameters.
• 1.5.7 - Added "not-self", "not-gm" and "not-gm-self" as valid targets.

Notes

Deferred functions/links which are queued within a deferred macro do not run directly after the queuing macro, but instead are added to the end of the stack of all the deferred functions and links. This means you cannot 'nest' deferrals or insert deferrals in the middle of the stack of deferred macros. For discussion of this functionality and possible workarounds you can read more on GitHub.