herolab.refresh: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{MacroFunction |name=herolab.refresh |trusted=true |version=1.5 |description= Refresh the Hero Lab data associated with this token. This will update the statblock and stored...") |
No edit summary |
||
| Line 6: | Line 6: | ||
Refresh the Hero Lab data associated with this token. This will update the statblock and stored images. | Refresh the Hero Lab data associated with this token. This will update the statblock and stored images. | ||
|usage= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
| Line 12: | Line 11: | ||
herolab.refresh(id) | herolab.refresh(id) | ||
</source> | </source> | ||
This function will also refresh the token's images (just like when the token is created). The token's base Image from the first image in Hero Lab, the token's Portrait from the second image in Hero Lab, and the tokens' Handout image from the 3rd image in Hero Lab. | |||
'''Parameters''' | '''Parameters''' | ||
Revision as of 18:37, 5 March 2019
herolab.refresh() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.5
Refresh the Hero Lab data associated with this token. This will update the statblock and stored images.
Usage
herolab.refresh()
herolab.refresh(id)This function will also refresh the token's images (just like when the token is created). The token's base Image from the first image in Hero Lab, the token's Portrait from the second image in Hero Lab, and the tokens' Handout image from the 3rd image in Hero Lab.
Parameters
id- The id of the token. Defaults to the Current Token.
It will return a 1 if successful, otherwise it will return a 0.
Example
Get the boolean value of the refresh flag in the Hero Lab data.
[r: success = herolab.refresh()]Returns:
0 or 1See Also
Version Changes
- 1.5 - Added to main MapTool build.