setMacroProps

 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 the props parameter, defaults to ";" and can be omitted if you are sending a JSON Object to the props parameter. If you are sending a JSON Object to the props parameter, and using the id parameter, you can set this to "json".
• id - The token id of 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.