getTokenCoverVBL: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Added getTokenCoverVBL)
 
No edit summary
 
(One intermediate revision by one other user not shown)
Line 9: Line 9:
|usage=
|usage=
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getTokenCoverVBL(id)
getTokenCoverVBL(tokenRef)
</syntaxhighlight>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
{{param|id|Token ID to be accessed.}}
{{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=
{{func|getCoverVBL}}
{{func|getCoverVBL}}, {{func|setTokenCoverVBL}}
}}
}}
[[Category:VBL Function]]
[[Category:VBL Function]]

Latest revision as of 16:14, 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 token id or 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.


See Also