removeTokenFacing: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page RemoveTokenFacing to removeTokenFacing: Converting page titles to lowercase) |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 8: | Line 8: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
removeTokenFacing() | removeTokenFacing() | ||
removeTokenFacing( | removeTokenFacing(tokenRef) | ||
removeTokenFacing( | removeTokenFacing(tokenRef, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameter''' | '''Parameter''' | ||
{{param|id| | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to remove the facing from, defaults to the current token. If a token is specified, this function requires a trusted macro.}} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | {{param|mapname|The name of the map to find the token. Defaults to the current map.}} | ||
{{Note|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.}} | |||
|changes= | |changes= | ||
Latest revision as of 21:24, 17 May 2024
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
removeTokenFacing() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b51
Removes the facing from a token.
Usage
removeTokenFacing()
removeTokenFacing(tokenRef)
removeTokenFacing(tokenRef, mapname)Parameter
tokenRef- Either the tokenidor Token Name of the token to remove the facing from, defaults to the current token. If a token is specified, this function requires a trusted macro.mapname- The name of the map to find the token. Defaults to the current map.
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.
Version Changes
- 1.5.4 - Added
mapnameparameter option.