WoW:Events/Instance: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
m (Convert to use Template:Co)
m (Move page script moved page Events/Instance to Events/Instance without leaving a redirect)
 
(3 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC____NOEDITSECTION__{{eventlistheader}}
<!-- DO NOT EDIT. THIS IS AN AUTOMATICALLY GENERATED PAGE. -->
<!-- DO NOT EDIT. THIS IS AN AUTOMATICALLY GENERATED PAGE. -->
<!-- DO NOT EDIT. THIS IS AN AUTOMATICALLY GENERATED PAGE. -->


:{{icon-information}}Note that this page is automatically generated; editing it is pointless. To edit event descriptions, edit the entries in the alphabetical pages, e.g. [[Events/A]], [[Events/B]], etc. Changes there will be copied over to here within a few hours.
== Instance related events ==
{{evt|INSTANCE_BOOT_START|Instance}}
Fired when the countdown to boot a player from an instance starts.
{{evt|INSTANCE_BOOT_STOP|Instance}}
Fired when the countdown to boot a player from an instance stops.
{{evt|INSTANCE_ENCOUNTER_ENGAGE_UNIT|Instance}}
?
{{evt|INSTANCE_LOCK_START|Instance}}
?
{{evt|INSTANCE_LOCK_STOP|Instance}}
Fired when quitting the game.
{{evt|LFG_COMPLETION_REWARD|Instance}}
Fired when a random dungeon (picked by the Dungeon Finder) is completed. This event causes a window similar to the achievement alert to appear, with the details of your Dungeon Finder rewards.
{{evt|LFG_UPDATE|Instance}}
When fired prompts the LFG UI to update the list of available LFG categories and objectives (i.e. new quests, zones, instances available to LFG). See [[API GetLFGTypes]]
{{evt|LFG_BOOT_PROPOSAL_UPDATE|Instance}}
?
{{evt|LFG_LOCK_INFO_RECEIVED|Instance}}
?
{{evt|LFG_OFFER_CONTINUE|Instance}}
?
{{evt|LFG_OPEN_FROM_GOSSIP|Instance}}
Fired when a gossip option is used to initiate a Looking-for-Dungeon interaction.
; arg1 : Number - index of the dungeon the NPC wants us to queue for (index to {{api|GetLFGDungeonInfo}}(id)).
{{evt|LFG_PROPOSAL_FAILED|Instance}}
Fired when someone decline or don't make a choice within time in the dungeon queue invite
{{evt|LFG_PROPOSAL_SHOW|Instance}}
Fired when a dungeon group was found and the dialog to accept or decline it appears
{{evt|LFG_PROPOSAL_SUCCEEDED|Instance}}
Fired when everyone in the dungeon queue accepted the invite
{{evt|LFG_PROPOSAL_UPDATE|Instance}}
Fired when someone either accept or decline the dungeon queue invite
{{evt|LFG_QUEUE_STATUS_UPDATE|Instance}}
?
{{evt|LFG_ROLE_CHECK_HIDE|Instance}}
?
{{evt|LFG_ROLE_CHECK_ROLE_CHOSEN|Instance}}
?
{{evt|LFG_ROLE_CHECK_SHOW|Instance}}
?
{{evt|LFG_ROLE_CHECK_UPDATE|Instance}}
?
{{evt|LFG_ROLE_UPDATE|Instance}}
?
{{evt|LFG_UPDATE_RANDOM_INFO|Instance}}
?
{{evt|PARTY_LFG_RESTRICTED|Party, Instance}}
?
{{evt|PLAYER_ENTERING_WORLD|System,Player,Instance}}
Fired when the player enters the world, enters/leaves an instance, or respawns at a graveyard.  Also fires any other time the player sees a loading screen.
To check if the player is entering an instance, check [[API_GetPlayerMapPosition|GetPlayerMapPosition]] to see if both X and Y are zero.
Correction on the above comment: When PLAYER_ENTERING_WORLD fires, you'll notice that WORLD_MAP_UPDATE fires just before it. My instincts tell that leaving an instance puts the player in void space momentarily. So for the case that you are entering AND leaving an instance, [[API_GetPlayerMapPosition|GetPlayerMapPosition]] always returns the coordinates <nowiki>[0,0]</nowiki> and hence there is no way to determine using the event PLAYER_ENTERING_WORLD if the player is entering an instance or not. When leaving an instance the following events fire (ignoring party/raid events).
:WORLD_MAP_UPDATE
:PLAYER_ENTERING_WORLD
:WORLD_MAP_UPDATE <--- Player coordinates are non-zero here
Instances do have coordinates for units once the second WORLD_MAP_UPDATE event has fired. For the case of entering a battleground such as WSG, WORLD_MAP_UPDATE won't fire until you leave Silverwing Hold or Warsong Lumber Mill and you are outside. --[[User:Salanex|Salanex]]
{{evt|PLAYER_ROLES_ASSIGNED|Instance}}
?
{{evt|UPDATE_INSTANCE_INFO|Instance}}
Fired when data from RequestRaidInfo() is available

Latest revision as of 04:48, 15 August 2023

Event API


"I" iconNote that this page is automatically generated; editing it is pointless. To edit event descriptions, edit the entries in the alphabetical pages, e.g. Events/A, Events/B, etc. Changes there will be copied over to here within a few hours.


Instance related events

"INSTANCE_BOOT_START"
Category: Instance
 

Fired when the countdown to boot a player from an instance starts.


"INSTANCE_BOOT_STOP"
Category: Instance
 

Fired when the countdown to boot a player from an instance stops.


"INSTANCE_ENCOUNTER_ENGAGE_UNIT"
Category: Instance
 

?


"INSTANCE_LOCK_START"
Category: Instance
 

?


"INSTANCE_LOCK_STOP"
Category: Instance
 

Fired when quitting the game.


"LFG_COMPLETION_REWARD"
Category: Instance
 

Fired when a random dungeon (picked by the Dungeon Finder) is completed. This event causes a window similar to the achievement alert to appear, with the details of your Dungeon Finder rewards.


"LFG_UPDATE"
Category: Instance
 

When fired prompts the LFG UI to update the list of available LFG categories and objectives (i.e. new quests, zones, instances available to LFG). See API GetLFGTypes


"LFG_BOOT_PROPOSAL_UPDATE"
Category: Instance
 

?


"LFG_LOCK_INFO_RECEIVED"
Category: Instance
 

?


"LFG_OFFER_CONTINUE"
Category: Instance
 

?


"LFG_OPEN_FROM_GOSSIP"
Category: Instance
 

Fired when a gossip option is used to initiate a Looking-for-Dungeon interaction.

arg1
Number - index of the dungeon the NPC wants us to queue for (index to GetLFGDungeonInfo(id)).


"LFG_PROPOSAL_FAILED"
Category: Instance
 

Fired when someone decline or don't make a choice within time in the dungeon queue invite


"LFG_PROPOSAL_SHOW"
Category: Instance
 

Fired when a dungeon group was found and the dialog to accept or decline it appears


"LFG_PROPOSAL_SUCCEEDED"
Category: Instance
 

Fired when everyone in the dungeon queue accepted the invite


"LFG_PROPOSAL_UPDATE"
Category: Instance
 

Fired when someone either accept or decline the dungeon queue invite


"LFG_QUEUE_STATUS_UPDATE"
Category: Instance
 

?


"LFG_ROLE_CHECK_HIDE"
Category: Instance
 

?


"LFG_ROLE_CHECK_ROLE_CHOSEN"
Category: Instance
 

?


"LFG_ROLE_CHECK_SHOW"
Category: Instance
 

?


"LFG_ROLE_CHECK_UPDATE"
Category: Instance
 

?


"LFG_ROLE_UPDATE"
Category: Instance
 

?


"LFG_UPDATE_RANDOM_INFO"
Category: Instance
 

?


"PARTY_LFG_RESTRICTED"
Category: Party, Instance
 

?


"PLAYER_ENTERING_WORLD"
Category: System,Player,Instance
 

Fired when the player enters the world, enters/leaves an instance, or respawns at a graveyard. Also fires any other time the player sees a loading screen.

To check if the player is entering an instance, check GetPlayerMapPosition to see if both X and Y are zero.

Correction on the above comment: When PLAYER_ENTERING_WORLD fires, you'll notice that WORLD_MAP_UPDATE fires just before it. My instincts tell that leaving an instance puts the player in void space momentarily. So for the case that you are entering AND leaving an instance, GetPlayerMapPosition always returns the coordinates [0,0] and hence there is no way to determine using the event PLAYER_ENTERING_WORLD if the player is entering an instance or not. When leaving an instance the following events fire (ignoring party/raid events).

WORLD_MAP_UPDATE
PLAYER_ENTERING_WORLD
WORLD_MAP_UPDATE <--- Player coordinates are non-zero here

Instances do have coordinates for units once the second WORLD_MAP_UPDATE event has fired. For the case of entering a battleground such as WSG, WORLD_MAP_UPDATE won't fire until you leave Silverwing Hold or Warsong Lumber Mill and you are outside. --Salanex


"PLAYER_ROLES_ASSIGNED"
Category: Instance
 

?


"UPDATE_INSTANCE_INFO"
Category: Instance
 

Fired when data from RequestRaidInfo() is available