setName: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 10: | Line 10: | ||
setName(name) | setName(name) | ||
setName(name, id) | setName(name, id) | ||
setName(name, id, | setName(name, id, mapRef) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Parameter''' | '''Parameter''' | ||
{{param|name|The name to set on the current token.}} | {{param|name|The name to set on the current token.}} | ||
{{param|id|The token {{code|id}} of the token which has its name set. {{TrustedParameter}} }} | {{param|id|The token {{code|id}} of the token which has its name set. {{TrustedParameter}} }} | ||
{{param| | {{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | ||
|changes= | |changes= |
Latest revision as of 23:59, 14 March 2023
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
setName() Function
• Introduced in version 1.3b40
Sets the name of a Token.
Usage
setName(name)
setName(name, id)
setName(name, id, mapRef)
Parameter
name
- The name to set on the current token.id
- The tokenid
of the token which has its name set.Note: This parameter can only be used in a Trusted Macro.
mapRef
- The Name or ID of the map to find the token. Defaults to the current map.
Version Changes
- 1.3b51 - Added
id
parameter option. - 1.5.4 - Added
mapname
parameter option.