macroLinkText

Function macroLinkText

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 the macroLink function.

Usage

[r: = macroLinkText(macro)]
[r: = macroLinkText(macro, output, args)]
[r: = macroLinkText(macro, output, args)]
[r: = macroLinkText(macro, output, args, target)]

• text is the text to display for the link.
• macro is the name of the macro to run when the link is clicked.

The macro is in the same format that is used for [macro(...): ...] e.g. Test@Lib:test

• output contains 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.
• 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 ",")
  • impersonated - the impersonated Token
  • selected - the selected Tokens
  • Token Id - the id of a Token.

Examples

To create the text that would go inside a tag for link that will call a macro called Test on the Lib:Token named Lib:Test that says "click on me" and displays the output to the GM.

[r: macroLinkText("click on me", "Test@Lib:Test","", "gm")]

Returns

   macro://click on me/Test@Lib:Test/gm?