removeToken: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page RemoveToken to removeToken: Converting page titles to lowercase)
No edit summary
Line 8: Line 8:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
removeToken(id)
removeToken(id)
removeToken(id, mapname)
removeToken(id, mapname)
</source>
</syntaxhighlight>
'''Parameter'''
'''Parameter'''
{{param|id|The id of the token to remove.}}
{{param|id|The id of the token to remove.}}

Revision as of 22:13, 14 March 2023

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

removeToken() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.3b51
Removes a token from the current map.

Usage

removeToken(id)
removeToken(id, mapname)

Parameter

  • id - The id of the token to remove.
  • mapname - The map where the token is.

One caveat, you can remove the impersonated token in a macro but if you do so you must make sure not to use any macro functions that refer to the deleted token or you will cause errors.

changes

  • 1.8.0 - Added mapname parameter option.