HOOK_ENTITY_ADD_EFFECT


Index:
Articles
Classes
Hooks

Quick navigation:
BLOCK_SPREAD
BLOCK_TO_PICKUPS
BREWING_COMPLETED
BREWING_COMPLETING
CHAT
CHUNK_AVAILABLE
CHUNK_GENERATED
CHUNK_GENERATING
CHUNK_UNLOADED
CHUNK_UNLOADING
COLLECTING_PICKUP
CRAFTING_NO_RECIPE
DISCONNECT
ENTITY_ADD_EFFECT
ENTITY_CHANGED_WORLD
ENTITY_CHANGING_WORLD
ENTITY_TELEPORT
EXECUTE_COMMAND
EXPLODED
EXPLODING
HANDSHAKE
HOPPER_PULLING_ITEM
HOPPER_PUSHING_ITEM
KILLED
KILLING
LOGIN
PLAYER_ANIMATION
PLAYER_BREAKING_BLOCK
PLAYER_BROKEN_BLOCK
PLAYER_DESTROYED
PLAYER_EATING
PLAYER_FISHED
PLAYER_FISHING
PLAYER_FOOD_LEVEL_CHANGE
PLAYER_JOINED
PLAYER_LEFT_CLICK
PLAYER_MOVING
PLAYER_OPENING_WINDOW
PLAYER_PLACED_BLOCK
PLAYER_PLACING_BLOCK
PLAYER_RIGHT_CLICK
PLAYER_RIGHT_CLICKING_ENTITY
PLAYER_SHOOTING
PLAYER_SPAWNED
PLAYER_TOSSING_ITEM
PLAYER_USED_BLOCK
PLAYER_USED_ITEM
PLAYER_USING_BLOCK
PLAYER_USING_ITEM
PLUGINS_LOADED
PLUGIN_MESSAGE
POST_CRAFTING
PRE_CRAFTING
PROJECTILE_HIT_BLOCK
PROJECTILE_HIT_ENTITY
SERVER_PING
SPAWNED_ENTITY
SPAWNED_MONSTER
SPAWNING_ENTITY
SPAWNING_MONSTER
TAKE_DAMAGE
TICK
UPDATED_SIGN
UPDATING_SIGN
WEATHER_CHANGED
WEATHER_CHANGING
WORLD_STARTED
WORLD_TICK

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:

NameTypeNotes
EntitycEntityThe entity to which the effect is about to be added
EffectTypenumberThe type of the effect to be added. One of the effXXX constants.
EffectDurationnumberThe duration of the effect to be added, in ticks.
EffectIntensitynumberThe intensity (level) of the effect to be added.
DistanceModifiernumberThe modifier for the effect intensity, based on distance. Used mainly for splash potions.

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);
Generated by APIDump on 2017-08-21 21:02:35, Build ID Unknown, Commit approx: e44a0adfcf623b37ee26f79e607f81dc16fac75e