macroLink: Difference between revisions
Jump to navigation
Jump to search
m (→Usage) |
m (→Examples) |
||
| Line 32: | Line 32: | ||
===Examples=== | ===Examples=== | ||
To create a link that will call a macro called Test on the [[Token:library_token|Library Token]] named Lib:Test that says "''Click on me!''" and displays the output to the GM. | To create a link that will call a macro called Test on the [[Token:library_token|Library Token]] named Lib:Test that says "''Click on me!''" and displays the output to the GM. | ||
<source lang="mtmacro" | <source lang="mtmacro"> | ||
[r: macroLink("Click on me!", "Test@Lib:Test", "gm", "")] | [r: macroLink("Click on me!", "Test@Lib:Test", "gm", "count=6", "impersonated")] | ||
</source> | |||
produces this output: | |||
<source lang="html4strict"> | |||
<a href="macro://Test@Lib:Test/gm/impersonated?count=6;">Click on me!</a> | |||
</source> | </source> | ||
Revision as of 07:14, 5 February 2009
Function macroLink
Creates the HTML for a link which will run the specified macro when clicked on.
Usage
[r: link = macroLink(text, macro)]
[r: link = macroLink(text, macro, output, args)]
[r: link = macroLink(text, macro, output, args)]
[r: link = macroLink(text, 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 ",")
Examples
To create a link that will call a macro called Test on the Library Token named Lib:Test that says "Click on me!" and displays the output to the GM.
[r: macroLink("Click on me!", "Test@Lib:Test", "gm", "count=6", "impersonated")]produces this output:
<a href="macro://Test@Lib:Test/gm/impersonated?count=6;">Click on me!</a>