FANDOM


UI API < events

This page is 'game event' reference, and list all of the events available in the core UI API, for Global events, the UI API, and for API types. See UI Event for details and howtos for WS event system. See also API types and UI API.

Reference Edit

Events are not found as references anywhere in the Lua namespace, unlike the UI APIs, and API types themselves, and are accessed by using last identifier in the name as sting, like "DragDropSysBegin" of Apollo.DragDropSysBegin event.

See Category:API events for a possibly more complete list. If missing here, please list it!

Common Edit

A select set of common events.

ChangeWorld() - fired when player transitions instance
ChatMessage(nFlagsRef,nChannelRef,sSender,sChatMessage)
CombatLogDamage()
TargetedByUnit()
UI_HealthChanged(newValue,maxCharacterHealth)
Unit.UnitEnteredCombat(unitInCombat,bInCombat) - fires when a unit enters or leaves combat

Global Edit

A Edit

AbilitiesWindowClose(bAtTrainer) - fires when the Limited Action Set Builder window closes
AbilityBookChange() - fires when a change is made to the Action Set Builder
AcceptProgressInput(bShouldAccept) - fires when CSIs turn player input on and off. This is only used for the "Memory" CSI
AccountEntitlementUpdate() - fires when a change is made to the current account's entitlements
AccountInventoryUpdate() - fires when the Account Inventory for the current account has changed
AccountOperationResults(eOperation,eResult)
AccountPendingItemsUpdate() - fires when items that are pending for the current player's account have changed states
AccountSupportTicketResult(channelGM,bSuccess)
AchievementGranted(achComplete) - fires when an achievement is completed
AchievementUpdated(achUpdated) - fires when an progress is made towards an achievement's objective
ActionBarDescriptionSpell(splDisplayed,tEffects,tReasons) - spell being displayed, spell info, list of flags
ActionBarNonSpellShortcutAddFailed() - fires when a non-spell fails to be placed on the action bar
ActionSetError()
ActivateCCStateStun(nTotalTaps,fTotalDuration) - fires when the player is stunned
AddSpellShortcut(splDisplayed,eReason,eData)
AlertMailInfo() - fires when the player gets new mail
AlternateTargetUnitChanged()
ApplyCCState()
AuctionWindowClose()
AvailableMail()
BankSlotPurchased()
Breath_FlashEvent(healthPercentRemaining)
BreathChanged(breath,maxCharacterBreath)
BuybackItemsUpdated()
CanVacuumChange(bCanVacuum)
CasterResurrectedPlayer(sCasterName)
ChallengeAreaRestriction()
ChallengeCompletedSound()
ChallengeCooldownActive()
ChallengeFailArea()
ChallengeFailGeneric()
ChallengeFailSound()
ChallengeFailTime()
ChallengeRewardListReady()
ChallengeRewardReady()
ChallengeShared()
ChallengeShareTimedOut()
ChallengeTierAchieved()
ChallengeUpdated()
ChangeWorld() - fired when player transitions instance
CharacterCreated()
CharacterEldanAugmentationsUpdated()
CharacterEntitlementUpdate()
CharacterFlagsUpdated()
CharacterUnlockedInlaidEldanAugmentation()
ChatAccountTellFailed()
ChatAction()
ChatBanList()
ChatFlag()
ChatJoin()
ChatJoinResult()
ChatLeave()
ChatList()
ChatMessage(nFlagsRef,nChannelRef,sSender,sChatMessage)
ChatReply()
ChatResult()
ChatReWhisper()
ChatTellFailed()
ChatZoneChange()
CinematicsCancel(nParam)
CinematicsNotify(sMessage,nParam)
CityDirectionClear()
CityDirectionMarked()
CityDirectionsClose()
CityDirectionsList()
ClearSpellThreshold()
CloseCraftingWindow()
CloseTradeskillTrainerWindow()
CloseVendorWindow()
ColorChanged()
CombatFloaters_Configure()
CombatLogAbsorption()
CombatLogBuildSwitch()
CombatLogCCState()
CombatLogCCStateBreak()
CombatLogCrafting()
CombatLogDamage()
CombatLogDatacube()
CombatLogDeath()
CombatLogDeflect()
CombatLogDelayDeath()
CombatLogDispel()
CombatLogDurabilityLoss()
CombatLogElderPointsLimitReached()
CombatLogEndGameCurrencies()
CombatLogExperience()
CombatLogExtracting()
CombatLogFallingDamage()
CombatLogHeal()
CombatLogImmunity()
CombatLogInterrupted()
CombatLogItemDestroy()
CombatLogKillPVP()
CombatLogKillStreak()
CombatLogLAS()
CombatLogLoot()
CombatLogModifying()
CombatLogModifyInterruptArmor()
CombatLogMount()
CombatLogPet()
CombatLogResurrect()
CombatLogStealth()
CombatLogString()
CombatLogTransference()
CombatLogVitalModifier()
CombatMomentum()
CommodityAuctionFilledPartial()
CommodityAuctionRemoved()
CommodityAuctionsDisabled()
CommodityInfoResults()
CraftingDiscoveryHotCold()
CraftingExtractItem()
CraftingInterrupted()
CraftingModItem()
CraftingSchematicComplete()
CraftingSchematicInfoReceived()
CraftingSchematicLearned()
CraftingSchematicList()
CraftingStationClose()
CraftingUpdateCurrent()
CREDDExchangeInfoResults()
CREDDExchangeOperationResults()
CREDDExchangeWindowClose()
CREDDOperationHistoryResults()
CSIKeyPressed(bKeyDown) - when the client side interaction input key is pressed or released

D Edit

DashCastFail()
DashCastSuccess()
DatacubePlaybackEnded()
DatacubeUpdated()
DebugPrerequisite(outputStr)
DecorPreviewClose()
DecorPreviewOpen()
Dialog_Close()
Dialog_QuestShare()
Dialog_ResponseText(sText)
Dialog_ShowState(nStateId,nQuestId) - updates and displays the Dialog's contents and responses based on the provided Ids
Dialog_ViewIntro()
DialogClosing()
DuelAccepted()
DuelCancelWarning()
DuelLeftArea()
DuelStateChanged(unitId)
DyeLearned()
ElderPointsGained()
ElderPointsLimitReached()
EnteredCombat()
EpisodeStateChanged(nEpisodeId,nOldState,nNewState)
ErrorDialogSetSelection(index)
FactionFloater()
FlightPathUpdate()
ForceResurrect()
FriendshipAccountCharacterLevelUpdate()
FriendshipAccountDataUpdate()
FriendshipAccountFriendRemoved()
FriendshipAccountFriendsRecieved()
FriendshipAccountInviteRemoved()
FriendshipAccountInvitesRecieved()
FriendshipAccountPersonalStatusUpdate()
FriendshipAdd()
FriendshipInviteRemoved()
FriendshipInvitesRecieved()
FriendshipLoaded()
FriendshipLocation()
FriendshipRemove()
FriendshipRequest()
FriendshipRequestWithdrawn()
FriendshipResult()
FriendshipSuggestedAdd()
FriendshipSuggestedRemove()
FriendshipSuggestedUpdate()
FriendshipUpdate()
FriendshipUpdateOnline()
GalacticArchiveArticleAdded()
GalacticArchiveEntryAdded()
GalacticArchiveLinkClick()
GalacticArchiveRefresh()
GameClickProp()
GameClickSky()
GameClickUnit()
GameClickWorld()
GenericError(eError,sMessage)
GenericEvent_PlayerCampStart()
GenericEvent_PlayerExitCancel()
GenericMapNodeDisabled()
GenericMapNodeEnabled()
GenericMapShow()
GMChatTellFailed()
Group_Add()
Group_Join()
Group_JoinRequest()
Group_Left()
Group_MemberFlagsChanged()
Group_MemberOrderChanged()
Group_MemberPromoted()
Group_Mentor()
Group_MentorLeftAOI()
Group_MentorRelationship()
Group_Operation_Result()
Group_ReadyCheck()
Group_Referral()
Group_Remove()
Group_Request_Result()
Group_SetMark()
Group_Updated()
Group_UpdatePosition()
GroupBag_Changed()
GroupBag_ItemDistributed(idItem,idWinner)
GroupLeaderPhaseChanged(bJoinAllowed,nReferenceType,nReferenceId)
GuildBankerClose()
GuildBankerOpen()
GuildBankItem()
GuildBankLog()
GuildBankTab()
GuildBankTabCount()
GuildBankTabRename()
GuildBankWithdraw()
GuildChange()
GuildEmblem()
GuildEventLogChange()
GuildFlags()
GuildInfluenceAndMoney()
GuildInfoMessage()
GuildInvite()
GuildMemberChange()
GuildMessageOfTheDay()
GuildName()
GuildNameplateChange()
GuildPerkActivated()
GuildPerkDeactivated()
GuildPerkUnlocked()
GuildPvp()
GuildQueueStateChanged()
GuildRankChange()
GuildRegistrarClose()
GuildRegistrarOpen()
GuildResult()
GuildRoster()
GuildStandard()
GuildWarCoinsChanged()

H Edit

HarvestItemsSentToOwner()
HazardEnabled()
HazardRemoved()
HazardRemoveMinimapUnit()
HazardShowMinimapUnit()
HazardUpdated()
HideBank()
HideDye()
HideInstanceGameModeDialog()
HideQuestLog()
HighlightProgressOption()
HintArrowDistanceUpdate()
HousingBasicsUpdated()
HousingBuildComplete()
HousingBuildStarted()
HousingMannequinClose()
HousingMannequinOpen()
HousingNamePropertyOpen()
HousingNeighborInviteAccepted()
HousingNeighborInviteDeclined()
HousingNeighborInviteRecieved()
HousingNeighborsLoaded()
HousingNeighborUpdate()
HousingPrivacyUpdated()
HousingRandomResidenceListRecieved()
HousingRealtorOpen()
HousingResult()
Inspect()
InstanceSetBusy()
Interaction(title,type,speed,sweetspot,width1,width2)
InterfaceMenu_ToggleLoreWindow()
InvokeCraftingWindow()
InvokeEscapeMenu()
InvokeFriendsList()
InvokeOptionsDialog()
InvokeScientistExperimentation()
InvokeSettlerBuild()
InvokeShuttlePrompt()
InvokeSoldierBuild()
InvokeTaxiWindow()
InvokeTradeskillTrainerWindow()
InvokeVendorWindow(uVendorUnitId) - displays the corresponding Vendor window. Also updates repairable/rechargable/identifiable/buy back items and plays a sound
ItemAdded()
ItemAuctionBidPosted()
ItemAuctionBidResult()
ItemAuctionExpired()
ItemAuctionOutbid()
ItemAuctionsDisabled()
ItemAuctionSearchResults()
ItemAuctionWon()
ItemCancelResult()
ItemDurabilityUpdate()
ItemLink()
ItemModified()
ItemRemoved()
ItemSentToCrate()

K Edit

KeyBindingKeyChanged()
LoginError()
LogOut()
LootAssigned()
LootRoll()
LootRollAllPassed()
LootRollPassed()
LootRollSelected()
LootRollUpdate()
LootRollWon()
MailAddAttachment()
MailBoxActivate()
MailBoxDeactivate()
MailRead()
MailResult()
MannequinWindowClose()
MannequinWindowOpen()
MapHexesRevealed()
MapTrackedUnitDisable()
MapTrackedUnitUpdate()
MarketplaceWindowClose()
MasterLootUpdate()
MatchEntered()
MatchExited()
MatchFinished()
MatchingAverageWaitTimeUpdated()
MatchingCancelPendingGame()
MatchingEligibilityChanged()
MatchingGamePendingUpdate()
MatchingGameReady()
MatchingJoinQueue()
MatchingLeaveQueue()
MatchingPvpInactivityAlert()
MatchingRoleCheckCanceled()
MatchingRoleCheckHidden()
MatchingRoleCheckStarted()
MatchJoined()
MatchLeft()
MatchLookingForReplacements()
MatchStoppedLookingForReplacements()
MatchVoteKickBegin()
MatchVoteKickEnd()
MatchVoteSurrenderBegin()
MatchVoteSurrenderEnd()
MessageFinished(ptrMessage)
MountUnlocked()
MouseOverUnitChanged()
NewCustomerSurveyRequest()
NewMail(newMail)
NextActionBar()
NextFrame()

O Edit

OnChange_World()
OnForceResurrect()
OnInstanceResetResult()
OnLogOut()
OnSettlerHubUpdated()
OnSoldierHoldoutEnd(reason)
OnSoldierHoldoutNextWave(boss)
OnSoldierHoldoutStartDefault(timer,newcomer,isBoss,waveElapsed,waves)
OnSoldierHoldoutStartDefend(timer,newcomer,isBoss,waveElapsed,waves)
OnSoldierHoldoutStartTimed(timer,newcomer,isBoss,waveElapsed)
OnSoldierHoldoutStartTimedDefend(timer,newcomer,isBoss,waveElapsed)
OwnedCommodityOrders()
OwnedItemAuctions()
P2PTradeCommit()
PartyBagItemAdded(guid)
PartyBagItemAwarded(guid)
PartyBagItemRemoved(guid)
PartyBagItemTimerStarted(guid)
PartyBagItemTimerStopped(guid)
PartyBagItemTimerTick(msTimeRemaining)
PartyBagItemUpdated(guid)
PartyBagSharedItemsChanged()
PathLevelUp(level,str)
PendingLootInteract()
PendingWorldRemovalCancel()
PendingWorldRemovalWarning()
PersonaUpdateCharacterStats()
PetCustomizationFailed()
PetCustomizationUpdated()
PetFlairCleared()
PetFlairUnlocked()
PlayedTime()
PlayerChanged()
PlayerCurrencyChanged()
PlayerEquippedItemChanged()
PlayerLevelChange(uLevel)
PlayerPathAdd()
PlayerPathExplorerPowerMapEntered()
PlayerPathExplorerPowerMapExited()
PlayerPathExplorerPowerMapFailed()
PlayerPathExplorerPowerMapStarted()
PlayerPathExplorerPowerMapWaiting()
PlayerPathExplorerScavengerHuntStarted()
PlayerPathMissionAdvanced()
PlayerPathMissionComplete()
PlayerPathMissionCompleteSound()
PlayerPathMissionUnlocked()
PlayerPathMissionUnlockedSound()
PlayerPathMissionUpdate()
PlayerPathRefresh()
PlayerPathRewardAvailable()
PlayerPathScientistScanBotCooldown()
PlayerPathScientistScanBotDeployed()
PlayerPathScientistScanBotDespawned()
PlayerPathSoldierNewWhackAMoleBurrows()
PlayerPortraitMessage(text,crText)
PlayerTitleChange(uId,title)
PlayerTitleUpdate()
PostCommodityOrderResult()
PostItemAuctionResult()
PrereqFailureMessage()
PreviousActionBar()
ProfessionAchievementUpdated()
ProfessionsLoaded()
ProfessionUpdated()
ProgressClickHighlightTime(index,percentageHighlight)
ProgressClickSetInstructions(instructions)
ProgressClickSetTapButtonText(text)
ProgressClickShowYesNoWindow(text)
ProgressClickWindowCompletionLevel(percentage)
ProgressClickWindowDisplay(boolean)
PublicEventCleared()
PublicEventEnd()
PublicEventInitiateVote()
PublicEventLeave()
PublicEventLiveStatsUpdate()
PublicEventLocationAdded()
PublicEventLocationRemoved()
PublicEventObjectiveLocationAdded()
PublicEventObjectiveLocationRemoved()
PublicEventObjectiveUpdate()
PublicEventStart()
PublicEventStatsUpdate()
PublicEventUpdate()
PublicEventVoteEnded()
PublicEventVoteTallied()
PVPDeathmatchPoolUpdated()
PvpKillNotification()
PVPMatchFinished()
PVPMatchStateUpdated()
PVPMatchTeamInfoUpdated()
PvpObjectivesUpdated()
PvpRatingUpdated()
QuestCalloutToggle()
QuestDailyReset()
QuestFloater()
QuestGetCurrentQuestId()
QuestInit()
QuestObjectiveUpdated()
QuestStateChanged()
QuestTrackedChanged()

R Edit

RaidInfoResponse()
ReadyToEnter()
RealmBroadcastTierHigh()
RealmBroadcastTierMedium()
RealmFirstAchievementAnnounce()
RealmListChanged()
RecallShardChanged()
RefreshHealthShieldBar()
RefreshInventoryBags()
RefreshMail()
RemoveCCState()
RemoveCCStateStun()
RemoveSpellShortcut(spellData,reason,data00)
RepairItemCompleted()
ReputationBoundryWarning()
ReputationChanged()
ReputationLevel()
ResolutionChanged(nWidth,nHeight)
ResourceConversionClose()
ResourceConversionOpen()
ScientistExperimentationResult()
ScriptResurrect()
SealMechanicUpdate(index,show,percent)
ServerBroadcastMessage(sMessage)
SetPlayerPath()
SetProgressClickTimes(width,location1,location2)
SettlerBuildResult()
SettlerBuildStatusUpdate()
SettlerHubClose()
SettlerHubReward()
SettlerHubUpdated()
SettlerInfrastructureAdvanced()
SettlerInfrastructureComplete()
SettlerInfrastructureStarted()
SettlerInfrastructureUpdated()
SettlerNotifyUse()
ShieldsOverloaded()
ShowActionBarShortcut(which,bShow)
ShowBank()
ShowCredits()
ShowDye()
ShowHello()
ShowInstanceGameModeDialog()
ShowInstanceRestrictedDialog()
ShowInstanceWaitingDialog()
ShowInventory(bShow) - show or Hide the Backpack window based on bShow
ShowItemInDressingRoom()
ShowLocOnWorldMap()
ShowQuestLog(nQuestId)
ShowQuestSynopsis(sOutput,nDuration)
ShowResurrectDialog(bPlayerIsDead,bIsInstancedPvp,bEnableRezHere,nRezCost,nTimeBeforeRezableInSeconds) - displays the dialog encountered after a player death and populates the information accordingly
ShowTutorial()
ShuttlePromptClose()
SoldierHoldoutDeath()
SoldierHoldoutEnd()
SoldierHoldoutNextWave()
SoldierHoldoutStatus()
SpecChanged()
SplineHintObjectEnd()
SplitItemStack()
StalkerWoundsUpdate(percent,numWounds)
StanceChanged()
StartSpellThreshold()
StoryPanelDialog_Hide()
StoryPanelDialog_Show(windowType,nTableRef,displayTime)
StunVGPressed()
SubMissionRequest(quest,target,str)
SubZoneChanged(idZone,sZoneName)
TalentRespecPointsChanged()
TalentsChanged()
TargetedByUnit()
TargetThreatListUpdated()
TaxiWindowClose()
ToggleAbilitiesWindow()
ToggleAchievementWindow()
ToggleAuctionList()
ToggleAuctionWindow()
ToggleChallengesWindow()
ToggleCharacterWindow()
ToggleCodex()
ToggleCREDDExchangeWindow()
ToggleErrorDialog()
ToggleFramerate()
ToggleGhostModeMap()
ToggleGroupFinder()
ToggleGroupSharedBag()
ToggleGroupsWindow()
ToggleGuild()
ToggleInventory()
ToggleMailWindow()
ToggleMarketplaceWindow()
TogglePlayerTicketWindow()
ToggleQuestLog()
ToggleReputationInterface()
ToggleSocialWindow()
ToggleStuckWindow()
ToggleTradeskills()
ToggleTradeSkillsInventory()
ToggleZoneMap()
TradeskillAchievementComplete()
TradeskillAchievementUpdate()
TradeskillEngravingStationClose()
TradeskillEngravingStationOpen()
TradeSkills_Crafting(text,percentComplete)
TradeSkills_Learned()
TradeSkills_Show(schematicId)
TradeSkills_UpdateQuantities()
TradeSkillsBreakdown_Show(bShow)
TradeSkillSigilResult()
TradeSkillsItemBreakdown_BreakCompleted(success)
TriggerDemoOptions()
TurnOnClickableTab(onOff)
TutorialPlaybackEnded()

U Edit

UI_EffectiveLevelChanged()
UI_EnergyChanged(newValue,maxCharacterResource0)
UI_HealthChanged(newValue,maxCharacterHealth)
UI_LevelChanged(newValue)
UI_XPBonusAwarded(awardType,newValue) - queues an XP award bonus to various RewardQueues and updates the RewardBar's progress
UI_XPBonusUpdated(who,preview,earnsXP)
UI_XPChanged(nNewXP,prevLevelXP,nextLevelXP,nNewRestBonusXP)
UnavailableMail()
UnitEvaded()
UnitGroupChanged()
UnitGuildNameplateChanged()
UnitLevelChanged()
UnitMemberOfGuildChange()
UnitPvpFlagsChanged()
UnitTextBubbleCreate()
UnitTextBubblesDestroyed()
UnitTitleChanged()
UnTargetedByUnit()
UpdateCCStateStun()
UpdateGearScore()
UpdateInventory()
UpdatePathXp(xp,str)
UpdateSoldierBuild()
UpdateSpellThreshold()
Vacuum()
VendorItemsUpdated()
WalletUpdate()
WarPartyBankerClose()
WarPartyBankerOpen()
WarPartyBattleClose()
WarPartyBattleOpen()
WarPartyBossTokensUpdated()
WarPartyMatchResults()
WarPartyRegistrarClose()
WarPartyRegistrarOpen()
WarplotBattleStateChanged()
WhoResponse()
WindowGainedFocus()
WindowLostFocus()
WorkOrderLocate()
WrangleCreature(uTarget,fMeter,fSuccessThreshold,fFailureThreshold,nRangeBand,fRate) - determines if a creature wrangle is successful or not based on the provided minimum, maximum, and current rate
ZoneCompletionUpdated()
ZoneMapPing()
ZoneMapPlayerIndicatorUpdated()
ZoneMapUpdateHexGroup()

UI API Edit

Apollo Edit

DragDropSysBegin(wndSource,sType,iData)
DragDropSysEnd(sType,iData)
LuaError(tAddon,sError,bCanIgnore)
ModuleLoaded()
ModuleRestore()
SaveModules()
SystemKeyDown(iKey)
TextMessage(iType,sMessage)

GroupLib Edit

Group_AcceptInvite()
Group_Changed()
Group_DeclineInvite()
Group_Disbanded(nReason,nGroupMemberId,nGroupActorIndex) - Output of a group leave or if group empties and disbands
Group_Invite_Declined(tTableRef) - Outputs the refused invitation to a group invite
Group_Invite_Result(nTableRef)
Group_Invited(nTableRef)
Group_Other_Joined(nTableRef)
Group_Other_Left(nTableRef)
Group_Other_Promoted(tTableRef) - Outputs the promotion of a group member
Group_Player_Joined()
Group_Player_Left()
Group_Player_Promoted()
Group_QuestList(unitId,nTableRef)

API types Edit

Unit Edit

AttackMissed(unitCaster,unitTarget,eMissType)
DamageOrHealingDone(unitCaster,unitTarget,eDamageType,nHealth,nShields,nAbsorb,bIsCritical,splUsed) - fires whenever a unit takes damage or gets healed
ExperienceGained(unitTarget,sText,nDelay)
InteractiveUnitChanged(unitNewTarget,strContext)
LootedItem(itemLoot,nCount)
LootedMoney(monLoot)
Mount(bMounted)
SpellCastFailed(eMessageType,eCastResult,unitTarget,unitSource,strMessage,sSpellName) - fires whenever a spell is canceled, by any means
SpellEffectCast(effectDesc,displayValue)
StartLooting(lootUnit)
StopLooting()
TargetUnitChanged(unitTarget)
UnitActivationTypeChanged(unitChanged)
UnitCCStateChanged(unitId,nState,nValue,bInState) - used to update target frame to display vulnerability indicators
UnitCreated(unitSpawned)
UnitDestroyed(unitDestroyed)
UnitEnteredCombat(unitInCombat,bInCombat) - fires when a unit enters or leaves combat
UnitMiniMapMarkerChanged(unitMoving)
UnitNameChanged(unitChanged,sNewName)

See also Edit

Ad blocker interference detected!


Wikia is a free-to-use site that makes money from advertising. We have a modified experience for viewers using ad blockers

Wikia is not accessible if you’ve made further modifications. Remove the custom ad blocker rule(s) and the page will load as expected.