setName: Difference between revisions

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.

• Introduced in version 1.3b40

Sets the name of a Token.

setName(name)
setName(name, id)
setName(name, id, mapRef)

Parameter

name - The name to set on the current token.
id - The token id 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.

@@ Line 1: / Line 1: @@
-==Function setName==
+{{stub}}
-Sets the name of the [[Token:Current Token|Current Token]].
+{{MacroFunction
+|name=setName
+|version=1.3b40
+|description=
+Sets the name of a [[Token]].
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+setName(name)
+setName(name, id)
+setName(name, id, mapRef)
+</syntaxhighlight>
+'''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.}}
-===Usage===
+|changes=
-<source lang="mtmacro" line>
+{{change|1.3b51|Added {{code|id}} parameter option.}}
-[h: setName(name)]
+{{change|1.5.4|Added {{code|mapname}} parameter option.}}
-</source>
+}}
+[[Category:Token Function]]