This hook is called whenever an entity effect is about to be added to an entity. The plugin may disallow the addition by returning true.

Note that this hook only fires for adding the effect, but not for the actual effect application. See also the HOOK_ENTITY_REMOVE_EFFECT for notification about effects expiring / removing, and HOOK_ENTITY_APPLY_EFFECT for the actual effect application to the entity.

Callback function

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

function MyOnEntityAddEffect(Entity, EffectType, EffectDuration, EffectIntensity, DistanceModifier)

Parameters:

If the plugin returns true, the effect will not be added and none of the remaining hook handlers will be called. If the plugin returns false, Cuberite calls all the remaining hook handlers and finally the effect is added to the entity.

Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_ENTITY_ADD_EFFECT, MyOnEntityAddEffect);