FFU Get Attribute - ironmonk108/monks-module-wiki GitHub Wiki

Get Attribute

Retrieves the value of a specific attribute or property path from an entity and saves it into a tile variable.

Select Entity*

Select the entity to read the attribute from.

  • Supports standard entity selections (e.g., Tokens, Tokens within Tile, Player Tokens, Tile, Current Collection, Tagger).
  • If multiple entities match, the first entity found is used.

Collection (Conditional)

Specifies the type of collection to inspect when Select Entity is set to Current Collection.

  • Options include: Actors, Drawings, Items, Journal Entries, Lights, Macros, Scene, Sounds, Tiles, Tokens (default), Users, and Walls.

Attribute*

The property path on the entity to retrieve (e.g., elevation, hidden, system.attributes.hp.value, name).

  • Dynamic Autocomplete: Provides an interactive autocomplete dropdown showing valid schema properties and tracked system attributes when targeting Tokens or Tiles.

Variable Name (Optional)

The name of the variable to store the retrieved attribute value under.

  • Defaults to SavedAttribute if left blank.
  • Accepts dynamic MATT replacement variables.

Target Tile

Select the tile where the variable should be stored.

  • Select from available entity options (e.g., This Tile, Current Collection, Tagger).
  • Defaults to This Tile.

Notes

  • If the retrieved attribute does not exist or evaluates to null/undefined, any existing variable with the specified name will be unset on the target tile.
  • When targeting a token, the action automatically inspects system.<attribute> and the underlying actor if the property does not exist directly on the Token Document.
  • If the retrieved property is an object containing a .value property (such as D&D 5e ability scores or resource pools), the primitive .value is automatically extracted.
  • Makes the variable immediately accessible to downstream actions in MATT's execution scope ({{variables.<VariableName>}}).
  • Requires FoundryFan Utilities to be installed and active.
  • Any issues with this action should be logged with FoundryFan Utilities.

Page Last Updated

  • Foundry 13.360
  • MATT 13.06
  • FoundryFan Utilities 1.5.0
⚠️ **GitHub.com Fallback** ⚠️