Frame:UnregisterEvent
Jump to navigation
Jump to search
Frame:RegisterEvent |
||
Frame:RegisterUnitEvent |
||
Frame:RegisterAllEvents |
||
Frame:UnregisterEvent |
||
Frame:UnregisterAllEvents |
||
Frame:IsEventRegistered |
Unregisters an event from the frame.
registered = Frame:UnregisterEvent(eventName)
Arguments
- eventName
- string - Name of the frame event.
Returns
- registered
- boolean - Returns true if the event was successfully unregistered, false if already unregistered. Throws an error is the event is invalid.
Details
- It's generally a good practice to unregister from events when no longer needed.
- For example, a frame which monitors target health does not need to receive the UNIT_HEALTH event while the player has no target.
- An addon that sorts the contents of the player's bags can register for the BAG_UPDATE event to keep track of when items are picked up, but unregister from the event while it performs its sorting.