herolab.isMinion

From RPTools Wiki
Jump to navigationJump to search

herolab.isMinion() Function

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

Introduced in version 1.5
Returns true if token is a Hero Lab minion character, such as an Eidolon or Familiar. Otherwise it returns false.

Usage

herolab.isMinion()
herolab.isMinion(id)

Parameters

  • id - The id of the token. Defaults to the Current Token.

Example

Get the boolean value of the isMinion flag in the Hero Lab data.
[r: isMinion = herolab.isMinion()]

Returns:

0 or 1

This is the same as using the getInfo() function and reading the isMinion field.

[h: info = herolab.getInfo()]
[r: isMinion = json.get(info,"isMinion")]

Returns:

0 or 1

See Also

Version Changes

  • 1.5 - Added to main MapTool build.