setMacroProps: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Updated with recent version changes.) |
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
||
Line 4: | Line 4: | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description= | ||
Sets the properties for the specified [[Token:Macro Button|Macro Button]] on the [[Current Token]] . The properties are passed to this function as a [[String Property List]]. This function accepts either a [[Token:Macro Button Index|Macro Button Index]] or the label of a [[Token:Macro Button|Macro Button]]. If it is a label then all of [[Token:Macro Button|Macro Button]]s on the [[ | Sets the properties for the specified [[Token:Macro Button|Macro Button]] on the [[Current Token]] . The properties are passed to this function as a [[String Property List]]. This function accepts either a [[Token:Macro Button Index|Macro Button Index]] or the label of a [[Token:Macro Button|Macro Button]]. If it is a label then all of [[Token:Macro Button|Macro Button]]s on the [[Current Token]] with a matching label are changed. | ||
|usage= | |usage= |
Revision as of 21:33, 4 April 2009
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.
setMacroProps() Function
• Introduced in version 1.3b48
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(label, props)
setMacroProps(label, props, delim)
setMacroProps(label, props, delim, id)
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.applyToSelected
- Should the macro be applied to the selected tokens.autoExec
- If the macro will be automatically executed when the button is clicked, acceptstrue
(1
) orfalse
(0
).color
- The name of the color for the button.command
- The command for the macro (only when using JSON version of function).fontColor
- The name of the font color for the button.fontSize
- The size of the font for the button.includeLabel
- If the label will be output when the button is clicked. Acceptstrue
(1
) orfalse
(0
).group
- The name of the group that the button belongs to.sortBy
- The sort by value of the macro button.label
- The label for the button.maxWidth
- The maximum width of the button.minWidth
- The minimum width of the button.playerEditable
- Is the button player editable, acceptstrue
(1
) orfalse
(0
).tooltip
- The tool tip for the macro button.compare
- Takes a JSON array which can contain one or more of the following keywords (only usable with JSON version of the function).applyToSelected
- Use the macro applyToSelected for common macro comparisons.autoExec
- Use the macro autoExec for common macro comparisons.command
- Use the macro command for common macro comparisons.group
- Use the macro group for common macro comparisons.includeLabel
- Use the macro includeLabel for common macro comparisons.sortPrefix
- Use the macro sortPrefix for common macro comparisons.
delim
- The delimiter used in the String Property List that is sent to theprops
parameter, defaults to";"
and can be omitted if you are sending a JSON Object to theprops
parameter. If you are sending a JSON Object to theprops
parameter, and using theid
parameter, you can set this to"json"
.id
- The tokenid
of the token that the macro button is located on.Note: This parameter can only be used in a Trusted Macro.
Example
[h: setMacroProps(1, "color=red;fontColor=white")]
[h: setMacroProps("Attack", "color=red;fontColor=white")]
Version Changes
- 1.3b49 - Added ability for
props
to accept a JSON object. - 1.3b51 - Added
id
parameter option. - 1.3b53 - Added ability for
command
,compare
,playerEditable
,applyToSelected
,autoExec
,group
, andtooltip
parameters.