https://github.com/Mateo-Jimenez76/Unity-Simple-Health-Package
A simple health script for unity game projects. If you find any issues or have any suggestions feel free to tell me :D
https://github.com/Mateo-Jimenez76/Unity-Simple-Health-Package
gametools unity-scripts
Last synced: about 1 month ago
JSON representation
A simple health script for unity game projects. If you find any issues or have any suggestions feel free to tell me :D
- Host: GitHub
- URL: https://github.com/Mateo-Jimenez76/Unity-Simple-Health-Package
- Owner: MaxGreenhill8529
- License: mit
- Created: 2025-01-15T01:55:11.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-01-16T23:14:09.000Z (over 1 year ago)
- Last Synced: 2025-03-08T22:36:16.525Z (about 1 year ago)
- Topics: gametools, unity-scripts
- Language: C#
- Homepage:
- Size: 7.81 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Simple Health Package
## How To Use
### Dealing Damage
To deal damage call the `Damage(int amount)` function. When damage is taken all events in the `OnDamage` UnityEvent will be invoked and if health is <= 0 then `OnDeath` will be invoked aswell.
>[!IMPORTANT]
>OnDeath is invoked AFTER OnDamage and not instead of.
There is also an option to negate all damage via `bool BeInvulnerable(bool value)`.
Implimentation in [Health.cs/Damage(int amount)](https://github.com/Mateo-Jimenez76/Unity-Health-Script/blob/a4a69911970ceddeb410e8de71320b76d3fd5b3a/Runtime/Health.cs#L39-L60)
### Healing
To heal call the `Heal(int amount)` function. This function will also invoke all events in the `OnHealth` UnityEvent.
Implimentation in [Health.cs/Heal(int amount)](https://github.com/Mateo-Jimenez76/Unity-Health-Script/blob/a4a69911970ceddeb410e8de71320b76d3fd5b3a/Runtime/Health.cs#L61-L85)
### Subscribing / Unsubscribing From Events
If you would like to subscribe to the events through scripts you can call `SubscribeTo...(UnityAction action)` followed by the name of the corresponding Unity Event. Ex: `SubscribeToOnDeath(UnityAction action)`. To unsubscribe is the same process but instead you call `UnsubscribeFrom...(UnityAction action)` with the UnityAction you wish to remove from the Event.
# Health Displayer
### Prerequisites
A Health script is required to be on the same object as the HealthDisplayer.
If one is not already on it then one will be created for you due to the effect of `[RequireComponent(typeof(Health))]`
### Displaying As A Bar
### Prerequisites
A reference to a `Slider` is required
### Displaying As A Number
### Prerequisites
A `TextMeshProUGUI` is required. While displaying as a number there are several formats to chose from which go as follows.
### Number Display Options
| Type | Result |
| ------------- | ------------- |
| Out Of | 50/100 |
| Percentage | 50% |
| Raw Number | 50 |
| Custom | This splits the max and current health values into two separate TextMeshProUGUI objects allowing for the user to manipulate placement and text styles however they please. |
# Additional Reading
https://docs.unity3d.com/Packages/com.unity.textmeshpro@4.0/api/TMPro.TextMeshProUGUI.html \
https://docs.unity3d.com/6000.2/Documentation/ScriptReference/UIElements.Slider.html \
https://docs.unity3d.com/6000.2/Documentation/ScriptReference/Events.UnityAction.html \
https://docs.unity3d.com/6000.2/Documentation/ScriptReference/RequireComponent.html