removeToken: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Corrected version.)
mNo edit summary
Line 10: Line 10:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
removeToken(id)
removeToken(id)
removeToken(id, mapname)
</source>
</source>
'''Parameter'''
'''Parameter'''
{{param|id|The id of the token to remove.}}
{{param|id|The id of the token to remove.}}
{{param|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.
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.

Revision as of 12:56, 20 May 2020

 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.