> 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.md).

# API Reference

This section documents the API available through the Ultimate Stats Framework **Component**.

Use these pages to configure the component, read and modify runtime values, and react to Stat or Attribute changes.

<table data-view="cards"><thead><tr><th></th><th data-hidden data-card-cover data-type="image">Cover image</th></tr></thead><tbody><tr><td><p><a href="/roogame/ultimate-stats-framework/creating-your-attribute-system/api-reference/stat-api.md">Stat API</a></p><p>Read, set, and change calculated Stats such as Attack, Defense, HealthMax, and Experience.</p></td><td></td></tr><tr><td><p><a href="/roogame/ultimate-stats-framework/creating-your-attribute-system/api-reference/attribute-api.md">Attribute API</a></p><p>Read and modify runtime resources such as Health, Mana, Stamina, and Shield.</p></td><td></td></tr><tr><td><p><a href="/roogame/ultimate-stats-framework/creating-your-attribute-system/api-reference/events.md">Events</a></p><p>React to Stat and Attribute changes to update UI and trigger gameplay logic.</p></td><td></td></tr><tr><td><p><a href="/roogame/ultimate-stats-framework/creating-your-attribute-system/api-reference/component-api.md">Component API</a></p><p>Configure and initialize the Roo Gameplay Framework Component for an Actor.</p></td><td></td></tr></tbody></table>

### API Categories

| Page          | Primary Purpose                                                |
| ------------- | -------------------------------------------------------------- |
| Component API | Configure the component and initialize runtime data.           |
| Stat API      | Work with calculated values and base Stat values.              |
| Attribute API | Work with current resource values, maximum values, and ratios. |
| Events        | Respond when a Stat or Attribute value changes.                |