removeToken

 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(tokenRef)
removeToken(tokenRef, mapname)

Parameter

• tokenRef - Either the token id or Token Name of the token to remove.
• mapname - The map where the token is.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

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.