herolab.getImage

herolab.getImage() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.5

Returns the asset id of the image retrieved from a Hero Lab file for a Token.

Usage

herolab.getImage(index)
herolab.getImage(index, tokenRef)

Parameters

• index - The index of the image you wish to retrieve.
• tokenRef - Either the token id or Token Name of the token to name, 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.

Hero Lab can store 0 to n images for a given character. The index is the order Hero Lab stores the images (not the display order in Hero lab). Index always starts at 0.

Example

Get an image asset ID from an image in a Hero Lab file and use that to set a token portrait image.

[portraitImage = herolab.getImage(0)]
[setTokenImage(portraitImage)]

Returns:

Asset ID of requested image.

See Also

Hero Lab Integration

Version Changes

• 1.5 - Added to main MapTool build.