-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge PR #23 by e-aakash - Add Readme
- Loading branch information
Showing
1 changed file
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
Health | ||
======= | ||
|
||
This module handles regeneration, restoration and damage of entities. | ||
|
||
## Regeneration | ||
Handles the natural healing of entities (and blocks). | ||
To activate regeneration send `ActivateRegenEvent(String id, float value, float endTime)`. Health is regenerated every | ||
second. Empty event `ActivateRegenEvent()` activates base regeneration of entity. | ||
|
||
To deactivate particular type of regeneration, send `DeactivateRegenEvent(String id)`. Empty event | ||
`DeactivateRegenEvent()` deactivates base regeneration fo entity. | ||
|
||
## Restoration | ||
Handles magical healing of entities. | ||
To heal an entity, send `DoRestoreEvent(amount, instigatorRef)`. | ||
|
||
The event chain of restoration: | ||
* DoRestoreEvent | ||
* BeforeRestoreEvent | ||
* Entity restored, health component saved | ||
* OnRestoreEvent | ||
* OnFullyHealedEvent (if healed to full health) | ||
|
||
## Damage System | ||
Handles damage dealt to entities with health. Send `DoDamageEvent` | ||
to deal damage to entity. | ||
|
||
Event chain: | ||
* DoDamageEvent | ||
* BeforeDamageEvent | ||
* Entity damaged, health component saved | ||
* OnDamagedEvent | ||
|
||
## Block Damage System | ||
Enables block to sustain some damage before getting destroyed, and produces block particle effect on damage. |