Method Global:RegisterPlayerEvent [-] [+]
Registers a Player event handler.
In Multistate mode (default), events are either registered to the WORLD state (-1) or the MAP states (map ID). These events will only ever trigger on their respective state.
In Compatibility mode, all events are registered to the WORLD state (-1).
ID | Event | State | Parameters | Comment |
---|---|---|---|---|
1 | ON_CHARACTER_CREATE | WORLD | event, player | |
2 | ON_CHARACTER_DELETE | WORLD | event, guidLow | |
3 | ON_LOGIN | WORLD | event, player | |
4 | ON_LOGOUT | WORLD | event, player | |
5 | ON_SPELL_CAST | MAP | event, player, spell, skipCheck | |
6 | ON_KILL_PLAYER | MAP | event, killer, killed | |
7 | ON_KILL_CREATURE | MAP | event, killer, killed | |
8 | ON_KILLED_BY_CREATURE | MAP | event, killer, killed | |
9 | ON_DUEL_REQUEST | MAP | event, target, challenger | |
10 | ON_DUEL_START | MAP | event, player1, player2 | |
11 | ON_DUEL_END | MAP | event, winner, loser, type | |
12 | ON_GIVE_XP | MAP | event, player, amount, victim | Can return new XP amount |
13 | ON_LEVEL_CHANGE | MAP | event, player, oldLevel | |
14 | ON_MONEY_CHANGE | MAP | event, player, amount | Can return new money amount |
15 | ON_REPUTATION_CHANGE | MAP | event, player, factionId, standing, incremental | Can return new standing |
16 | ON_TALENTS_CHANGE | MAP | event, player, points | |
17 | ON_TALENTS_RESET | MAP | event, player, noCost | |
18 | ON_CHAT | WORLD | event, player, msg, Type, lang | Can return false, newMessage |
19 | ON_WHISPER | WORLD | event, player, msg, Type, lang, receiver | Can return false, newMessage |
20 | ON_GROUP_CHAT | WORLD | event, player, msg, Type, lang, group | Can return false, newMessage |
21 | ON_GUILD_CHAT | WORLD | event, player, msg, Type, lang, guild | Can return false, newMessage |
22 | ON_CHANNEL_CHAT | WORLD | event, player, msg, Type, lang, channel | Can return false, newMessage |
23 | ON_EMOTE | MAP | event, player, emote | Not triggered on any known emote |
24 | ON_TEXT_EMOTE | MAP | event, player, textEmote, emoteNum, guid | |
25 | ON_SAVE | MAP | event, player | |
26 | ON_BIND_TO_INSTANCE | MAP | event, player, difficulty, mapid, permanent | |
27 | ON_UPDATE_ZONE | MAP | event, player, newZone, newArea | |
28 | ON_MAP_CHANGE | MAP | event, player | |
29 | ON_EQUIP | MAP | event, player, item, bag, slot | |
30 | ON_FIRST_LOGIN | WORLD | event, player | |
31 | ON_CAN_USE_ITEM | MAP | event, player, itemEntry | Can return InventoryResult enum value |
32 | ON_LOOT_ITEM | MAP | event, player, item, count | |
33 | ON_ENTER_COMBAT | MAP | event, player, enemy | |
34 | ON_LEAVE_COMBAT | MAP | event, player | |
35 | ON_REPOP | MAP | event, player | |
36 | ON_RESURRECT | MAP | event, player | |
37 | ON_LOOT_MONEY | MAP | event, player, amount | |
38 | ON_QUEST_ABANDON | MAP | event, player, questId | |
39 | ON_LEARN_TALENTS | MAP | event, player, talentId, talentRank, spellid | |
40 | ON_ENVIRONMENTAL_DEATH | MAP | event, player, environmentalDamageType | |
41 | ON_TRADE_ACCEPT | MAP | event, player, target | Can return false to interrupt trade |
42 | ON_COMMAND | WORLD | event, player, command | Player is nil if command used from console. Can return false |
43 | ON_SKILL_CHANGE | MAP | event, player, skillId, skillValue | Returns new skill level value |
44 | ON_LEARN_SPELL | MAP | event, player, spellId | |
45 | ON_ACHIEVEMENT_COMPLETE | MAP | event, player, achievementId | |
46 | ON_DISCOVER_AREA | MAP | event, player, area | |
47 | ON_UPDATE_AREA | MAP | event, player, oldArea, newArea | |
48 | ON_TRADE_INIT | MAP | event, player, target | Can return false to interrupt trade |
49 | ON_SEND_MAIL | MAP | event, player, recipientGuid | Can return false to interrupt sending |
54 | ON_QUEST_STATUS_CHANGED | MAP | event, player, questId, status |
Synopsis
cancel = RegisterPlayerEvent( event, function )
cancel = RegisterPlayerEvent( event, function, shots )
Arguments
number event
Player event Id, refer to table above.
Valid numbers: integers from 0 to 4,294,967,295.
function function
Function 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 cancel
A function that cancels the binding when called.