herolab.getStatBlock: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{MacroFunction |name=herolab.getStatBlock |trusted=true |version=1.5 |description= Returns associated statblock for the token as a string. Currently, Hero Lab stores three ty...") |
No edit summary |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 7: | Line 7: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
herolab.getStatBlock(type) | herolab.getStatBlock(type) | ||
herolab.getStatBlock(type,id) | herolab.getStatBlock(type,id) | ||
</ | </syntaxhighlight> | ||
Note: The different formats may or may not contain the same information but it does reflects what is stored in the portfolio. If you find missing information, in the XML statblock for instance, you will need to report that to [[http://www.wolflair.com/index.php?context=hero_lab&page=support Wolf Lair]]. | Note: The different formats may or may not contain the same information but it does reflects what is stored in the portfolio. If you find missing information, in the XML statblock for instance, you will need to report that to [[http://www.wolflair.com/index.php?context=hero_lab&page=support Wolf Lair]]. | ||
| Line 21: | Line 21: | ||
|example= | |example= | ||
Get the Hero Lab Master character name associated with the current token. | Get the Hero Lab Master character name associated with the current token. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[herolab.getStatBlock("text")] | [herolab.getStatBlock("text")] | ||
</ | </syntaxhighlight> | ||
Returns: | Returns: | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Revision as of 16:11, 15 March 2023
herolab.getStatBlock() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5
Returns associated statblock for the token as a string. Currently, Hero Lab stores three types of statblocks: Text, HTML, & XML.
Usage
herolab.getStatBlock(type)
herolab.getStatBlock(type,id)Note: The different formats may or may not contain the same information but it does reflects what is stored in the portfolio. If you find missing information, in the XML statblock for instance, you will need to report that to [Wolf Lair].
Parameters
type- A string containing either "text", "html", or "xml"id- The ID of the token. Defaults to the Current Token.
Returns HeroLab data does not exist for this token if no data exists for the token and aborts the macro.
Example
Get the Hero Lab Master character name associated with the current token.
[herolab.getStatBlock("text")]Returns:
See Also
Version Changes
- 1.5 - Added to main MapTool build.