herolab.getMasterName

herolab.getMasterName() 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.getMasterName()
herolab.getMasterName(tokenRef)

Parameters

• 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.

Example

Get the Hero Lab Master character name associated with the character represented by the current token.

[h: myMaster = herolab.getMasterName()]
[r: out = "My master's name is: " + myMaster]

Returns:

My master's name is: Fred

See Also

Hero Lab Integration

Version Changes

• 1.5 - Added to main MapTool build.