> For the complete documentation index, see [llms.txt](https://roogame.gitbook.io/roogame/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://roogame.gitbook.io/roogame/ultimate-stats-framework/creating-your-attribute-system/api-reference/attribute-api.md).

# Attribute API

An Attribute is a runtime resource value such as Health, Mana, Stamina, Energy, or Shield.

Use these functions through the `Ultimate Stats Framework Component`.

| Function                         | Description                                                       |
| -------------------------------- | ----------------------------------------------------------------- |
| `Has Attribute By Tag`           | Returns whether an Attribute exists.                              |
| `Get Attribute Value By Tag`     | Returns the current value of an Attribute.                        |
| `Get Attribute Min Value By Tag` | Returns the minimum value of an Attribute.                        |
| `Get Attribute Max Value By Tag` | Returns the current calculated maximum value of an Attribute.     |
| `Get Attribute Ratio By Tag`     | Returns the current value divided by the maximum value.           |
| `Set Attribute Value By Tag`     | Sets the current Attribute value.                                 |
| `Change Attribute Value By Tag`  | Adds a positive or negative value to the current Attribute value. |
| `Set Attribute To Max By Tag`    | Sets one Attribute to its current maximum value.                  |
| `Set All Attributes To Max`      | Sets every configured Attribute to its current maximum value.     |

Each function also has a `By Name` version.

> **Recommendation**\
> Use `By Tag` functions for gameplay code, especially when a project contains multiple namespaces.\
> `By Name` functions are safe only when you provide the full Gameplay Tag, or when the short name is guaranteed to be unique within the component.

<figure><img src="https://2218703886-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F4YPyrdOyfjDGtlxlvjSd%2Fuploads%2F0Gp4hGjW4eGKpwXW3GfO%2Fimage.png?alt=media&amp;token=3d76d9cf-b459-4607-ac3f-4008b8c9d34b" alt=""><figcaption></figcaption></figure>

> **RGFC** is short for `Ultimate Stats Framework Component`.\
> In Blueprints, the Stat and Attribute module is displayed as **Roo Stat Component**. It is a module provided by the `Ultimate Stats Framework Component`, not a separate framework component that requires additional setup.