setName: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Unifying Current Token red link.) |
No edit summary |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 4: | Line 4: | ||
|version=1.3b40 | |version=1.3b40 | ||
|description= | |description= | ||
Sets the name of | Sets the name of a [[Token]]. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setName(name) | setName(name) | ||
</ | setName(name, id) | ||
setName(name, id, mapRef) | |||
</syntaxhighlight> | |||
'''Parameter''' | '''Parameter''' | ||
{{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|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
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 tokenidof 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
idparameter option. - 1.5.4 - Added
mapnameparameter option.