This hook is called whenever a pawn's (a player's or a mob's) health reaches zero. This
means that the pawn is about to be killed, unless a plugin "revives" them by setting their health
back to a positive value.
Callback function
The default name for the callback function is OnKilling. It has the following signature:
function MyOnKilling(Victim, Killer, TDI)
Parameters:
| Name | Type | Notes |
|---|
| Victim | cPawn | The player or mob that is about to be killed |
| Killer | cEntity | The entity that has caused the victim to lose the last point of health. May be nil for environment damage |
| TDI | TakeDamageInfo | The damage type, cause and effects. |
If the function returns false or no value, Cuberite calls other plugins with this event. If the
function returns true, no other plugin is called for this event.
In either case, the victim's health is then re-checked and if it is greater than zero, the victim is
"revived" with that health amount. If the health is less or equal to zero, the victim is killed.
Code examplesRegistering the callback
cPluginManager:AddHook(cPluginManager.HOOK_KILLING, MyOnKilling);
|