getTokenCoverVBL: Difference between revisions
Jump to navigation
Jump to search
Cold Ankles (talk | contribs) m (Cross reference) |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 9: | Line 9: | ||
|usage= | |usage= | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
getTokenCoverVBL( | getTokenCoverVBL(tokenRef) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|id|Token | {{param|id|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to be accessed.}} | ||
{{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.}} | |||
|also= | |also= | ||
Latest revision as of 23:59, 14 May 2024
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
getTokenCoverVBL() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.15
Retrieves Cover VBL stored on a token as a JSON array of shape objects.
Usage
getTokenCoverVBL(tokenRef)Parameters
id- Either the tokenidor Token Name of the token to be accessed.
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.