setName: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page SetName to setName: Converting page titles to lowercase)
No edit summary
 
Line 7: Line 7:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
setName(name)
setName(name)
setName(name, id)
setName(name, id)
setName(name, id, mapname)
setName(name, id, mapname)
</source>
</syntaxhighlight>
'''Parameter'''
'''Parameter'''
{{param|name|The name to set on the current token.}}
{{param|name|The name to set on the current token.}}

Latest revision as of 20:49, 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, mapname)

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

  • mapname - The name 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.