Method Global:RegisterUniqueCreatureEvent [-] [+]

Registers a Creature event handler for a single Creature.

Event State Parameters Comment
events.creature.on_enter_combat MAP event, creature, target Can return true to stop normal action
events.creature.on_leave_combat MAP event, creature Can return true to stop normal action
events.creature.on_target_died MAP event, creature, victim Can return true to stop normal action
events.creature.on_died MAP event, creature, killer Can return true to stop normal action
events.creature.on_spawn MAP event, creature Can return true to stop normal action
events.creature.on_reach_wp MAP event, creature, type, id Can return true to stop normal action
events.creature.on_ai_update MAP event, creature, diff Can return true to stop normal action
events.creature.on_receive_emote MAP event, creature, player, emoteid Can return true to stop normal action
events.creature.on_damage_taken MAP event, creature, attacker, damage Can return true to stop normal action, can return new damage as second return value.
events.creature.on_pre_combat MAP event, creature, target Can return true to stop normal action
events.creature.on_owner_attacked MAP event, creature, target Can return true to stop normal action. Not on mangos
events.creature.on_owner_attacked_at MAP event, creature, attacker Can return true to stop normal action. Not on mangos
events.creature.on_hit_by_spell MAP event, creature, caster, spellid Can return true to stop normal action
events.creature.on_spell_hit_target MAP event, creature, target, spellid Can return true to stop normal action
events.creature.on_just_summoned_creature MAP event, creature, summon Can return true to stop normal action
events.creature.on_summoned_creature_despawn MAP event, creature, summon Can return true to stop normal action
events.creature.on_summoned_creature_died MAP event, creature, summon, killer Can return true to stop normal action. Not on mangos
events.creature.on_summoned MAP event, creature, summoner Can return true to stop normal action
events.creature.on_reset MAP event, creature
events.creature.on_reach_home MAP event, creature Can return true to stop normal action
events.creature.on_corpse_removed MAP event, creature, respawndelay Can return true to stop normal action, can return new respawndelay as second return value
events.creature.on_move_in_los MAP event, creature, who Can return true to stop normal action. Does not actually check LOS, just uses the sight range
events.creature.on_dummy_effect MAP event, caster, spellid, effindex, creature
events.creature.on_quest_accept MAP event, player, creature, quest Can return true
events.creature.on_quest_reward MAP event, player, creature, quest, opt Can return true
events.creature.on_dialog_status MAP event, player, creature
events.creature.on_add MAP event, creature
events.creature.on_remove MAP event, creature

Synopsis

cancel = RegisterUniqueCreatureEvent( guid, instance_id, event, function )

cancel = RegisterUniqueCreatureEvent( guid, instance_id, event, function, shots )

Arguments

number guid

The GUID of a single Creature.

Valid numbers: integers from 0 to 18,446,744,073,709,551,615.

number instance_id

The instance ID of a single Creature.

Valid numbers: integers from 0 to 4,294,967,295.

number event

Refer to table above.

Valid numbers: integers from 0 to 4,294,967,295.

function function

Function that will be called when the event occurs.

number shots (0)

The number of times the function will be called, 0 means "always call this function".

Valid numbers: integers from 0 to 4,294,967,295.

Returns

function cancel

A function that cancels the binding when called.

Generated on
© 2010 - 2024 Eluna Lua Engine