ENTITY:OnTakeDamage
Description
Called when the entity is taking damage.
Calling Entity:TakeDamage, Entity:TakeDamageInfo, Entity:DispatchTraceAttack, or Player:TraceHullAttack (if the entity is hit) in this hook on the victim entity can cause infinite loops since the hook will be called again. Make sure to setup recursion safeguards like the example below.
This hook is only called for
ai
, nextbot
and anim
type entities.Arguments
Returns
1 number
How much damage the entity took. Basically
> 0
means took damage, 0
means did not take damage.Example
All damage taken by this entity is applied twice. This will count the damage taken as two distinctive hits as opposed to just scaling it in GM:EntityTakeDamage.