getTokenHillVBL: Difference between revisions
Jump to navigation
Jump to search
m (Added description; fleshed out the page a bit more) |
No edit summary |
||
| (2 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
{{MacroFunction | {{MacroFunction | ||
|name=getTokenHillVBL | |name=getTokenHillVBL | ||
|proposed=false | |||
|trusted=true | |||
|version=1.12 | |version=1.12 | ||
|description=Retrieves Hill VBL stored on a token as a JSON object or JSON array. (If true, where is the {{code|type}} parameter in the call?) | |description=Retrieves Hill VBL stored on a token as a JSON object or JSON array. (If true, where is the {{code|type}} parameter in the call?) | ||
| Line 7: | Line 9: | ||
|usage= | |usage= | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
getTokenHillVBL( | getTokenHillVBL(tokenRef) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param| | {{param|tokenRef|Token ID to be accessed.}}Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token's Hill VBL to retrieve. | ||
{{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.
getTokenHillVBL() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.12
Retrieves Hill VBL stored on a token as a JSON object or JSON array. (If true, where is the
type parameter in the call?)Usage
getTokenHillVBL(tokenRef)Parameters
tokenRef- Token ID to be accessed.Either the tokenidor Token Name of the token's Hill VBL to retrieve.
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
getHillVBL(),
Original GitHub feature request: https://github.com/RPTools/maptool/issues/3052