Method Global:RegisterPlayerEvent [-] [+]
Registers a Player event handler.
| Event | State | Parameters | Comment |
|---|---|---|---|
| events.player.on_character_create | WORLD | event, player | |
| events.player.on_character_delete | WORLD | event, guidLow | |
| events.player.on_login | WORLD | event, player | |
| events.player.on_logout | WORLD | event, player | |
| events.player.on_spell_cast | MAP | event, player, spell, skipCheck | |
| events.player.on_kill_player | MAP | event, killer, killed | |
| events.player.on_kill_creature | MAP | event, killer, killed | |
| events.player.on_killed_by_creature | MAP | event, killer, killed | |
| events.player.on_duel_request | MAP | event, target, challenger | |
| events.player.on_duel_start | MAP | event, player1, player2 | |
| events.player.on_duel_end | MAP | event, winner, loser, type | |
| events.player.on_give_xp | MAP | event, player, amount, victim | Can return new XP amount |
| events.player.on_level_change | MAP | event, player, oldLevel | |
| events.player.on_money_change | MAP | event, player, amount | Can return new money amount |
| events.player.on_reputation_change | MAP | event, player, factionId, standing, incremental | Can return new standing |
| events.player.on_talents_change | MAP | event, player, points | |
| events.player.on_talents_reset | MAP | event, player, noCost | |
| events.player.on_chat | WORLD | event, player, msg, Type, lang | Can return false, newMessage |
| events.player.on_whisper | WORLD | event, player, msg, Type, lang, receiver | Can return false, newMessage |
| events.player.on_group_chat | WORLD | event, player, msg, Type, lang, group | Can return false, newMessage |
| events.player.on_guild_chat | WORLD | event, player, msg, Type, lang, guild | Can return false, newMessage |
| events.player.on_channel_chat | WORLD | event, player, msg, Type, lang, channel | Can return false, newMessage |
| events.player.on_emote | MAP | event, player, emote | Not triggered on any known emote |
| events.player.on_text_emote | MAP | event, player, textEmote, emoteNum, guid | |
| events.player.on_save | MAP | event, player | |
| events.player.on_bind_to_instance | MAP | event, player, difficulty, mapid, permanent | |
| events.player.on_update_zone | MAP | event, player, newZone, newArea | |
| events.player.on_map_change | MAP | event, player | |
| events.player.on_equip | MAP | event, player, item, bag, slot | |
| events.player.on_first_login | WORLD | event, player | |
| events.player.on_can_use_item | MAP | event, player, itemEntry | Can return InventoryResult enum value |
| events.player.on_loot_item | MAP | event, player, item, count | |
| events.player.on_enter_combat | MAP | event, player, enemy | |
| events.player.on_leave_combat | MAP | event, player | |
| events.player.on_repop | MAP | event, player | |
| events.player.on_resurrect | MAP | event, player | |
| events.player.on_loot_money | MAP | event, player, amount | |
| events.player.on_quest_abandon | MAP | event, player, questId | |
| events.player.on_learn_talents | MAP | event, player, talentId, talentRank, spellid | |
| events.player.on_environmental_death | MAP | event, player, environmentalDamageType | |
| events.player.on_trade_accept | MAP | event, player, target | Can return false to interrupt trade |
| events.player.on_command | WORLD | event, player, command | Player is nil if command used from console. Can return false |
| events.player.on_skill_change | MAP | event, player, skillId, skillValue | Returns new skill level value |
| events.player.on_learn_spell | MAP | event, player, spellId | |
| events.player.on_achievement_complete | MAP | event, player, achievementId | |
| events.player.on_discover_area | MAP | event, player, area | |
| events.player.on_update_area | MAP | event, player, oldArea, newArea | |
| events.player.on_trade_init | MAP | event, player, target | Can return false to interrupt trade |
| events.player.on_send_mail | MAP | event, player, recipientGuid | Can return false to interrupt sending |
| events.player.on_quest_status_changed | MAP | event, player, questId, status |
Synopsis
cancel = RegisterPlayerEvent( event, function )
cancel = RegisterPlayerEvent( event, function, shots )
Arguments
number eventPlayer event Id, refer to table above.
Valid numbers: integers from 0 to 4,294,967,295.
function functionFunction to register.
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 cancelA function that cancels the binding when called.