setMacroProps: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page SetMacroProps to setMacroProps: Converting page titles to lowercase) |
No edit summary |
||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setMacroProps(index, props) | setMacroProps(index, props) | ||
setMacroProps(index, props, delim) | setMacroProps(index, props, delim) | ||
setMacroProps(index, props, delim, id) | setMacroProps(index, props, delim, id) | ||
setMacroProps(index, props, delim, id, mapname) | setMacroProps(index, props, delim, id, mapname) | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setMacroProps(label, props) | setMacroProps(label, props) | ||
setMacroProps(label, props, delim) | setMacroProps(label, props, delim) | ||
setMacroProps(label, props, delim, id) | setMacroProps(label, props, delim, id) | ||
setMacroProps(label, props, delim, id, mapname) | setMacroProps(label, props, delim, id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|index|The index of the macro button.}} | {{param|index|The index of the macro button.}} | ||
| Line 31: | Line 31: | ||
|example= | |example= | ||
Changes the macro button to be red with white text. First by index and second by label(name). | Changes the macro button to be red with white text. First by index and second by label(name). | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setMacroProps(1, "color=red;fontColor=white")] | [h: setMacroProps(1, "color=red;fontColor=white")] | ||
[h: setMacroProps("Attack", "color=red;fontColor=white")] | [h: setMacroProps("Attack", "color=red;fontColor=white")] | ||
</ | </syntaxhighlight> | ||
Somewhat silly example that changes the label (e.g. name) of the currently executing macro to the current time and randomly changes the button color. | Somewhat silly example that changes the label (e.g. name) of the currently executing macro to the current time and randomly changes the button color. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: color = listget("Red, Blue, Green, White, Yellow, Orange",1d6-1)] | [h: color = listget("Red, Blue, Green, White, Yellow, Orange",1d6-1)] | ||
[h: index = getMacroIndexes(getMacroName())] | [h: index = getMacroIndexes(getMacroName())] | ||
| Line 45: | Line 45: | ||
[h: myProps = setStrProp(myProps,"color",color)] | [h: myProps = setStrProp(myProps,"color",color)] | ||
[h: setMacroProps(index,myprops)] | [h: setMacroProps(index,myprops)] | ||
</ | </syntaxhighlight> | ||
|changes= | |changes= | ||
Revision as of 20:52, 14 March 2023
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
This article needs: Examples using the new functionality.
{{MacroFunction |name=setMacroProps |version=1.3b48 |description= Sets the properties for the specified Macro Button on the Current Token . The properties are passed to this function as a String Property List. This function accepts either a Macro Button Index or the label of a Macro Button. If it is a label then all of Macro Buttons on the Current Token with a matching label are changed.
|usage=
setMacroProps(index, props)
setMacroProps(index, props, delim)
setMacroProps(index, props, delim, id)
setMacroProps(index, props, delim, id, mapname)setMacroProps(label, props)
setMacroProps(label, props, delim)
setMacroProps(label, props, delim, id)
setMacroProps(label, props, delim, id, mapname)Parameters
index- The index of the macro button.label- The label of the macro button.props- A String Property List or JSON Object containing the properties for the button.- See createMacro() for a complete list of properties.
delim- The delimiter used in the String Property List that is sent to thepropsparameter, defaults to";"and can be omitted if you are sending a JSON Object to thepropsparameter. If you are sending a JSON Object to thepropsparameter, and using theidparameter, you can set this to"json".id- The tokenidof the token that the macro button is located on.Note: This parameter can only be used in a Trusted Macro.
mapname- The name of the map to find the token. Defaults to the current map.