herolab.getInfo: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page herolab.getInfo to Herolab.getInfo without leaving a redirect: Converting page title to first-letter uppercase) |
No edit summary |
||
| (One intermediate revision by one other user not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
herolab.getInfo(id) | herolab.getInfo(id) | ||
herolab.getInfo(id,field) | herolab.getInfo(id,field) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 18: | Line 18: | ||
|example= | |example= | ||
Get the Hero Lab data associated with the current token. | Get the Hero Lab data associated with the current token. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[herolab.getInfo()] | [herolab.getInfo()] | ||
</ | </syntaxhighlight> | ||
Returns: | Returns: | ||
< | <syntaxhighlight lang="javascript" line> | ||
{ | { | ||
"summary": "Young red dragon - CE Large dragon", | "summary": "Young red dragon - CE Large dragon", | ||
| Line 38: | Line 38: | ||
"lastModified": "Fri Nov 02 16:28:33 CDT 2018", | "lastModified": "Fri Nov 02 16:28:33 CDT 2018", | ||
"masterName": "" | "masterName": "" | ||
}</ | }</syntaxhighlight> | ||
Get the status of the {{code|isMinion}} field from the Hero Lab data for the token named ''Orc 23''. | Get the status of the {{code|isMinion}} field from the Hero Lab data for the token named ''Orc 23''. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r: isMinion = herolab.getInfo("Orc 23","isMinion")] | [r: isMinion = herolab.getInfo("Orc 23","isMinion")] | ||
</ | </syntaxhighlight> | ||
Returns: | Returns: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
1 | 1 | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Revision as of 16:10, 15 March 2023
herolab.getInfo() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5
Get basic information about the Hero Lab data associated with this token. Returns a JSON object containing various metadata about the character.
Usage
herolab.getInfo(id)
herolab.getInfo(id,field)Parameters
id- The token id of the token to name, defaults to the Current Token.field- A particular field from the metadata.
Example
Get the Hero Lab data associated with the current token.
[herolab.getInfo()]Returns:
{
"summary": "Young red dragon - CE Large dragon",
"masterIndex": null,
"isAlly": false,
"images": ["asset://8799bd3b26bc614cf0a0f33675f5e77d", "asset://80b3ea5b47f5f1c7aec06a28219cde47"],
"portfolioPath": "C:\\Users\\John\\Documents\\Pathfinder\\Giantslayer\\Episode 5 tokens\\",
"playerName": "Joe",
"isMinion": false,
"portfolioFile": "C:\\Users\\John\\Documents\\Pathfinder\\Giantslayer\\Episode 5 tokens\\Part 3 GS 5.por",
"gameSystem": "Pathfinder Roleplaying Game",
"heroLabIndex": "11",
"isDirty": true,
"name": "Young Red Dragon #3",
"lastModified": "Fri Nov 02 16:28:33 CDT 2018",
"masterName": ""
}
Get the status of the isMinion field from the Hero Lab data for the token named Orc 23.
[r: isMinion = herolab.getInfo("Orc 23","isMinion")]Returns:
1See Also
Version Changes
- 1.5 - Added to main MapTool build.