herolab.getStatBlock

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,tokenRef)

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"
• tokenRef - Either the token id or Token Name of the token Defaults to the Current Token.

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.

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

Hero Lab Integration

Version Changes

• 1.5 - Added to main MapTool build.