macroLinkText: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
No edit summary
 
(20 intermediate revisions by 11 users not shown)
Line 1: Line 1:
==Function macroLinkText==
{{MacroFunction
|name=macroLinkText
|version=1.3b48
|description=
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 {{roll|dialog}} or {{roll|frame}}. If you just want to send a click-able link to someone use {{func|macroLink}}.


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 [[Macros:Roll:dialog|[dialog(...): ...] ]] or [[Macros:Roll:frame|[frame(...): ...]]]. If you just want to send a click-able link to someone use the [[Macros:Functions:macroLink|macroLink]] function.
|usage=
<syntaxhighlight lang="mtmacro" line>
macroLinkText(macroName)
</syntaxhighlight>
<syntaxhighlight lang="mtmacro" line>
macroLinkText(macroName, output)
</syntaxhighlight>
<syntaxhighlight lang="mtmacro" line>
macroLinkText(macroName, output, args)
</syntaxhighlight>
<syntaxhighlight lang="mtmacro" line>
macroLinkText(macroName, output, args, target)
</syntaxhighlight>
'''Parameters'''
{{param|macroName|The name of the macro to run when the link is clicked. The {{code|macroName}} is in the standard macro reference format (e.g. {{code|Macro@Lib:Token}})}}
{{param|output|Who the output of the macro should go to, values are (defaults to {{code|none}}):}}
** {{code|self}} - Display only to person who clicked on the link.
** {{code|gm}} - Display to GM.
** {{code|all}} - Everyone (acts like a {{code|/say}})
** {{code|none}} - Discard any output.
** {{code|gm-self}} - Display to GM and the person executing the link.
** {{code|list}} - Displays to a list of players. When the {{code|output}} parameter is {{code|"list"}} then the macro link expects the {{code|args}} parameter to be a [[JSON Object]], that contains a field called {{code|mlOutputList}} which is a [[JSON Array]] containing the players to send the output to.
{{param|args|Any arguments to be passed to the macro when it is called.}}
{{param|target|Which tokens to run the macro on. Target can be one or more of the following separated by commas (defaults to {{code|impersonated}}):}}
** {{code|impersonated}} - The impersonated [[Token]].
** {{code|selected}} - The selected [[Token]]/s.
** [[Glossary#T|Token ID]] - The {{code|id}} of a [[Token]].


|examples=
To create the text that would go inside a form element as the {{code|action}} attribute, and that will call a macro named {{code|Test}} on the [[Library Token]] named {{code|Lib:Test}}:
<syntaxhighlight lang="mtmacro" line>
[r: macroLinkText("Test@Lib:Test","", "gm")]
</syntaxhighlight>
Returns: {{code|macro://Test@Lib:Test/gm/impersonated?}}


To create the text that would go inside a form element as the {{code|action}} attribute and call the {{code|AddWeapon}} on the [[Library Token]] named {{code|Lib:PC}} which will act upon the [[Current Token]]:
<syntaxhighlight lang="mtmacro" line>
[r:macroLinkText('AddWeapon@Lib:PC', 'none', '', currentToken())]
</syntaxhighlight>
Returns: {{code|macro://AddWeapon@Lib:PC/none/#ID#?}} where {{code|#ID#}} is the {{code|id}} of the [[Current Token]].


Sending to multiple players and the GM in 1.3b55
<syntaxhighlight lang="mtmacro" line>
[h: outputTo = '["Fred", "Barney", "gm"]']
[h: args = json.set("{}", "mlOutputList", outputTo)]
[r: macroLinkText("Test@Lib:Test", "list", args)]
</syntaxhighlight>


===Usage===
Correctly modifying the colour of the link, works both in the chat box and in forms:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r: = macroLinkText(macro)]
[r: strformat('<a style="color:red" href="%s">Click Me</a>', macroLinkText("Test@Lib:Test"))]  
[r: = macroLinkText(macro, output, args)]
</syntaxhighlight>
[r: = macroLinkText(macro, output, args)]
[r: = macroLinkText(macro, output, args, target)]
</source>


Opening an overlay with arguments to the GM panel macro {{code|loadGMOverlay}} for all connected GMs using {{func|execLink}}.


* ''text'' is the text to display for the link.
* This is a very useful pattern to load an overlay for all players or GMs with a library token using {{code|onCampaignLoad}}.  
* ''macro'' is the name of the macro to run when the link is clicked.
* In this example, the hypothetical overlay function can take text and background color arguments in a [[String_Property_List|String Property List]].
The macro is in the same format that is used for [[Macros:Branching_and_Looping#MACRO_Option |[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 [[SlashCommands:say|/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:Token|Token]]
** ''selected'' - the selected [[Token:Token|Token]]s
** ''[[Token:Token Id|Token Id]]'' - the ''[[Token:Token Id|id]] of a [[Token:Token|Token]].


===Examples===
<syntaxhighlight lang="mtmacro" line>
To create the text that would go inside a tag for 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.
[h: link = macroLinkText("loadGMOverlay@GM", "none", "text=white;background=black")]
<source lang="mtmacro" line>
[h: execLink(link, 0, "gm")]  
[r: macroLinkText("click on me", "Test@Lib:Test","", "gm")]
</syntaxhighlight>
</source>
 
Returns
 
    macro://click on me/Test@Lib:Test/gm?
|also=
{{func|macroLink}}
{{func|execLink}}
 
|changes=
{{change|1.3b55|Added {{code|gm-self}} and {{code|list}} output options.}}
{{change|1.3b56|Links created using this function will no longer show a tooltip when displayed in a dialog or frame.}}
 
}}
[[Category:Miscellaneous Function]]

Latest revision as of 20:51, 20 April 2023

macroLinkText() Function

• Introduced in version 1.3b48
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

macroLinkText(macroName)
macroLinkText(macroName, output)
macroLinkText(macroName, output, args)
macroLinkText(macroName, output, args, target)

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):

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: 
[r: macroLinkText("Test@Lib:Test","", "gm")]

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: 

[r:macroLinkText('AddWeapon@Lib:PC', 'none', '', currentToken())]

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 

[h: outputTo = '["Fred", "Barney", "gm"]']
[h: args = json.set("{}", "mlOutputList", outputTo)]
[r: macroLinkText("Test@Lib:Test", "list", args)]

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

[r: strformat('<a style="color:red" href="%s">Click Me</a>', macroLinkText("Test@Lib:Test"))]

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

  • This is a very useful pattern to load an overlay for all players or GMs 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

macroLink() execLink()

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.
Retrieved from "https://wiki.rptools.info/index.php?title=macroLinkText&oldid=16727"