herolab.getMasterName: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page herolab.getMasterName to Herolab.getMasterName without leaving a redirect: Converting page title to first-letter uppercase)
m (Conversion script moved page Herolab.getMasterName to herolab.getMasterName: Converting page titles to lowercase)
(No difference)

Revision as of 23:34, 9 February 2023

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(id)

Parameters

  • id - The token id of the token to name, defaults to the Current Token.

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

Version Changes

  • 1.5 - Added to main MapTool build.