https://github.com/hfjooste/UT-Stats
A system that is used to easily manage different character stats
https://github.com/hfjooste/UT-Stats
health player-stats stamina stats ue5 ue5-plugin unreal-engine
Last synced: about 2 months ago
JSON representation
A system that is used to easily manage different character stats
- Host: GitHub
- URL: https://github.com/hfjooste/UT-Stats
- Owner: hfjooste
- License: unlicense
- Archived: true
- Created: 2022-05-02T14:23:41.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-05-04T07:20:57.000Z (almost 3 years ago)
- Last Synced: 2024-10-24T02:33:10.497Z (6 months ago)
- Topics: health, player-stats, stamina, stats, ue5, ue5-plugin, unreal-engine
- Language: C++
- Homepage:
- Size: 78.1 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Stats Plugin
A system that is used to easily manage different character stats
## Installation
1. Download the latest release from GitHub
2. Navigate to `C:\Program Files\Epic Games\UE_{VERSION}\Engine\Plugins\`
3. Create a `Marketplace` folder if needed
4. Extract the release and copy to the `Marketplace` folder
5. Open Unreal Engine
6. Click on `Edit > Plugins`
7. Enable the plugin under the `Installed > Unreal Toolbox` category
8. Restart Unreal Engine
## Stat Component
A `Stat Component` can be added to each actor that requires the use of stats. The following properties can be changed inside the editor:
1. `Max Value` - The maximum value of the stat
2. `Regenerate` - The amount of value regenerated in a second
## Interacting with the Stat Component
You can interact with a `Stat Component` by using the following functions:
1. `Get Value` - Return the current value of the stat
2. `Update Value` - Set the value of the stat (clamped between 0 and the max value)
3. `Get Max Value` - Return the maximum value of the stat
4. `Set Max Value` - Set the maximum value of the stat
5. `Get Regenerate Amount` - Return the amount of value regenerated in a second
6. `Set Regenerate Amount` - Set the amount of value regenerated in a second
## Stat Component Events
There is 2 different events in a `Stat Component`:
1. `On Value Updated` - Called every time the value of the stat is updated
2. `On Value Zero` - Called when the value of the stat reaches zero