This hook is called when any cEntity descendant, such as a player or a mob, takes any kind of damage. The plugins may modify the amount of damage or effects with this hook by editting the TakeDamageInfo object passed.

This hook is called after the final damage is calculated, including all the possible weapon enchantments, armor protection and potion effects.

Callback function

The default name for the callback function is OnTakeDamage. It has the following signature:

function OnTakeDamage(Receiver, TDI)

Parameters:

If the function returns false or no value, other plugins' callbacks are called and then the server applies the final values from the TDI object to Receiver. If the function returns true, no other callbacks are called, and no damage nor effects are applied.

Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_TAKE_DAMAGE, MyOnTakeDamage);