herolab.isMinion: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page Herolab.isMinion to herolab.isMinion: Converting page titles to lowercase)
No edit summary
Line 7: Line 7:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
herolab.isMinion()
herolab.isMinion()
herolab.isMinion(id)
herolab.isMinion(id)
</source>
</syntaxhighlight>


'''Parameters'''
'''Parameters'''
Line 17: Line 17:
|example=
|example=
Get the boolean value of the isMinion flag in the Hero Lab data.
Get the boolean value of the isMinion flag in the Hero Lab data.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r: isMinion = herolab.isMinion()]
[r: isMinion = herolab.isMinion()]
</source>
</syntaxhighlight>
Returns:
Returns:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
0 or 1
0 or 1
</source>
</syntaxhighlight>
This is the same as using the {{func|getInfo}} function and reading the {{code|isMinion}} field.
This is the same as using the {{func|getInfo}} function and reading the {{code|isMinion}} field.
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: info = herolab.getInfo()]
[h: info = herolab.getInfo()]
[r: isMinion = json.get(info,"isMinion")]
[r: isMinion = json.get(info,"isMinion")]
</source>
</syntaxhighlight>
Returns:
Returns:
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
0 or 1
0 or 1
</source>
</syntaxhighlight>
|also=
|also=
[[Hero Lab Integration|Hero Lab Integration]]
[[Hero Lab Integration|Hero Lab Integration]]

Revision as of 16:13, 15 March 2023

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.