herolab.hasChanged

From RPTools Wiki
Jump to navigation Jump to search

herolab.hasChanged() Function

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

Introduced in version 1.5
Returns a boolean value of true if the portfolio file has been modified compared to the current stored data on the token, otherwise returns false.

Usage

herolab.hasChanged()
herolab.hasChanged(tokenRef)

See herolab.refresh() to update the token's portfolio information.

Parameters

  • tokenRef - Either the token id or Token Name of the token. 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

Determine if the associated Hero Lab portfolio has changed.
[r: isDirty = herolab.hasChanged()]

Returns:

0 or 1

See Also

Version Changes

  • 1.5 - Added to main MapTool build.