ulduar.h

Go to the documentation of this file.

/*
 * This file is part of the TrinityCore Project. See AUTHORS file for Copyright information
 *
 * This program is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by the
 * Free Software Foundation; either version 2 of the License, or (at your
 * option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
 * more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef DEF_ULDUAR_H
#define DEF_ULDUAR_H
 
#include "CreatureAIImpl.h"
#include "EventProcessor.h"
 
struct Position;
 
#define UlduarScriptName "instance_ulduar"
#define DataHeader "UU"
 
extern Position const ObservationRingKeepersPos[4];
extern Position const YSKeepersPos[4];
extern Position const AlgalonLandPos;
 
static constexpr uint8 const MAX_ENCOUNTER = 17;
 
enum UlduarBosses
{
 DATA_FLAME_LEVIATHAN = 0,
 DATA_IGNIS = 1,
 DATA_RAZORSCALE = 2,
 DATA_XT002 = 3,
 DATA_ASSEMBLY_OF_IRON = 4,
 DATA_KOLOGARN = 5,
 DATA_AURIAYA = 6,
 DATA_HODIR = 7,
 DATA_THORIM = 8,
 DATA_FREYA = 9,
 DATA_MIMIRON = 10,
 DATA_VEZAX = 11,
 DATA_YOGG_SARON = 12,
 DATA_ALGALON = 13,
 DATA_BRIGHTLEAF = 14,
 DATA_IRONBRANCH = 15,
 DATA_STONEBARK = 16,
};
 
enum UlduarNPCs
{
 // General
 NPC_LEVIATHAN = 33113,
 NPC_SALVAGED_DEMOLISHER = 33109,
 NPC_SALVAGED_SIEGE_ENGINE = 33060,
 NPC_SALVAGED_CHOPPER = 33062,
 NPC_IGNIS = 33118,
 NPC_RAZORSCALE = 33186,
 NPC_STEELFORGED_DEFFENDER = 33236,
 NPC_XT002 = 33293,
 NPC_XT_TOY_PILE = 33337,
 NPC_STEELBREAKER = 32867,
 NPC_MOLGEIM = 32927,
 NPC_BRUNDIR = 32857,
 NPC_KOLOGARN = 32930,
 NPC_FOCUSED_EYEBEAM = 33632,
 NPC_FOCUSED_EYEBEAM_RIGHT = 33802,
 NPC_LEFT_ARM = 32933,
 NPC_RIGHT_ARM = 32934,
 NPC_RUBBLE = 33768,
 NPC_AURIAYA = 33515,
 NPC_MIMIRON = 33350,
 NPC_HODIR = 32845,
 NPC_THORIM = 32865,
 NPC_FREYA = 32906,
 NPC_VEZAX = 33271,
 NPC_YOGG_SARON = 33288,
 NPC_ALGALON = 32871,
 
 // Razorscale
 NPC_DARK_RUNE_GUARDIAN = 33388,
 NPC_DARK_RUNE_SENTINEL = 33846,
 NPC_DARK_RUNE_WATCHER = 33453,
 NPC_RAZORSCALE_SPAWNER = 33245,
 NPC_EXPEDITION_COMMANDER = 33210,
 NPC_EXPEDITION_ENGINEER = 33287,
 NPC_EXPEDITION_DEFENDER = 33816,
 NPC_EXPEDITION_TRAPPER = 33259,
 NPC_RAZORSCALE_CONTROLLER = 33233,
 NPC_RAZORSCALE_HARPOON_FIRE_STATE = 33282,
 
 //XT002
 NPC_XS013_SCRAPBOT = 33343,
 NPC_HEART_OF_DECONSTRUCTOR = 33329,
 
 // Flame Leviathan
 NPC_ULDUAR_COLOSSUS = 33237,
 NPC_BRANN_BRONZEBEARD_INTRO = 33579,
 NPC_BRANN_BRONZEBEARD_FLYING_MACHINE = 34119,
 NPC_BRANN_S_FLYING_MACHINE = 34120,
 NPC_ARCHMAGE_PENTARUS = 33624,
 NPC_ARCHMAGE_RHYDIAN = 33696,
 NPC_LORE_KEEPER_OF_NORGANNON = 33686,
 NPC_HIGH_EXPLORER_DELLORAH = 33701,
 NPC_BRONZEBEARD_RADIO = 34054,
 NPC_FLAME_LEVIATHAN = 33113,
 NPC_FLAME_LEVIATHAN_SEAT = 33114,
 NPC_FLAME_LEVIATHAN_TURRET = 33139,
 NPC_LEVIATHAN_DEFENSE_TURRET = 33142,
 NPC_OVERLOAD_CONTROL_DEVICE = 33143,
 NPC_ORBITAL_SUPPORT = 34286,
 
 // Mimiron
 NPC_LEVIATHAN_MKII = 33432,
 NPC_VX_001 = 33651,
 NPC_AERIAL_COMMAND_UNIT = 33670,
 NPC_ASSAULT_BOT = 34057,
 NPC_BOMB_BOT = 33836,
 NPC_JUNK_BOT = 33855,
 NPC_EMERGENCY_FIRE_BOT = 34147,
 NPC_FROST_BOMB = 34149,
 NPC_BURST_TARGET = 34211,
 NPC_FLAME = 34363,
 NPC_FLAME_SPREAD = 34121,
 NPC_DB_TARGET = 33576,
 NPC_ROCKET_MIMIRON_VISUAL = 34050,
 NPC_WORLD_TRIGGER_MIMIRON = 21252,
 NPC_COMPUTER = 34143,
 
 // Freya's Keepers
 NPC_IRONBRANCH = 32913,
 NPC_BRIGHTLEAF = 32915,
 NPC_STONEBARK = 32914,
 
 // Hodir's Helper NPCs
 NPC_TOR_GREYCLOUD = 32941,
 NPC_KAR_GREYCLOUD = 33333,
 NPC_EIVI_NIGHTFEATHER = 33325,
 NPC_ELLIE_NIGHTFEATHER = 32901,
 NPC_SPIRITWALKER_TARA = 33332,
 NPC_SPIRITWALKER_YONA = 32950,
 NPC_ELEMENTALIST_MAHFUUN = 33328,
 NPC_ELEMENTALIST_AVUUN = 32900,
 NPC_AMIRA_BLAZEWEAVER = 33331,
 NPC_VEESHA_BLAZEWEAVER = 32946,
 NPC_MISSY_FLAMECUFFS = 32893,
 NPC_SISSY_FLAMECUFFS = 33327,
 NPC_BATTLE_PRIEST_ELIZA = 32948,
 NPC_BATTLE_PRIEST_GINA = 33330,
 NPC_FIELD_MEDIC_PENNY = 32897,
 NPC_FIELD_MEDIC_JESSI = 33326,
 
 // Freya's trash NPCs
 NPC_CORRUPTED_SERVITOR = 33354,
 NPC_MISGUIDED_NYMPH = 33355,
 NPC_GUARDIAN_LASHER = 33430,
 NPC_FOREST_SWARMER = 33431,
 NPC_MANGROVE_ENT = 33525,
 NPC_IRONROOT_LASHER = 33526,
 NPC_NATURES_BLADE = 33527,
 NPC_GUARDIAN_OF_LIFE = 33528,
 
 // Freya Achievement Trigger
 NPC_FREYA_ACHIEVE_TRIGGER = 33406,
 
 // Thorim
 NPC_THORIM_INVISIBLE_STALKER = 32780,
 NPC_JORMUNGAR_BEHEMOTH = 32882,
 NPC_MERCENARY_CAPTAIN_A = 32908,
 NPC_MERCENARY_CAPTAIN_H = 32907,
 NPC_MERCENARY_SOLDIER_A = 32885,
 NPC_MERCENARY_SOLDIER_H = 32883,
 NPC_DARK_RUNE_ACOLYTE_PRE = 32886,
 NPC_RUNIC_COLOSSUS = 32872,
 NPC_RUNE_GIANT = 32873,
 NPC_IRON_RING_GUARD = 32874,
 NPC_IRON_HONOR_GUARD = 32875,
 NPC_DARK_RUNE_CHAMPION = 32876,
 NPC_DARK_RUNE_WARBRINGER = 32877,
 NPC_DARK_RUNE_EVOKER = 32878,
 NPC_DARK_RUNE_COMMONER = 32904,
 NPC_DARK_RUNE_ACOLYTE = 33110,
 NPC_THORIM_EVENT_BUNNY = 32892,
 NPC_LIGHTNING_ORB = 33138,
 NPC_GOLEM_RIGHT_HAND_BUNNY = 33140,
 NPC_GOLEM_LEFT_HAND_BUNNY = 33141,
 NPC_SIF = 33196,
 NPC_THUNDER_ORB = 33378,
 NPC_THORIM_CONTROLLER = 32879,
 
 // Yogg-Saron
 NPC_SARA = 33134,
 NPC_GUARDIAN_OF_YOGG_SARON = 33136,
 NPC_HODIR_OBSERVATION_RING = 33213,
 NPC_FREYA_OBSERVATION_RING = 33241,
 NPC_THORIM_OBSERVATION_RING = 33242,
 NPC_MIMIRON_OBSERVATION_RING = 33244,
 NPC_VOICE_OF_YOGG_SARON = 33280,
 NPC_OMINOUS_CLOUD = 33292,
 NPC_FREYA_YS = 33410,
 NPC_HODIR_YS = 33411,
 NPC_MIMIRON_YS = 33412,
 NPC_THORIM_YS = 33413,
 NPC_SUIT_OF_ARMOR = 33433,
 NPC_KING_LLANE = 33437,
 NPC_THE_LICH_KING = 33441,
 NPC_IMMOLATED_CHAMPION = 33442,
 NPC_YSERA = 33495,
 NPC_NELTHARION = 33523,
 NPC_MALYGOS = 33535,
 NPC_DEATH_RAY = 33881,
 NPC_DEATH_ORB = 33882,
 NPC_BRAIN_OF_YOGG_SARON = 33890,
 NPC_INFLUENCE_TENTACLE = 33943,
 NPC_TURNED_CHAMPION = 33962,
 NPC_CRUSHER_TENTACLE = 33966,
 NPC_CONSTRICTOR_TENTACLE = 33983,
 NPC_CORRUPTOR_TENTACLE = 33985,
 NPC_IMMORTAL_GUARDIAN = 33988,
 NPC_SANITY_WELL = 33991,
 NPC_DESCEND_INTO_MADNESS = 34072,
 NPC_MARKED_IMMORTAL_GUARDIAN = 36064,
 
 // Algalon the Observer
 NPC_BRANN_BRONZBEARD_ALG = 34064,
 NPC_AZEROTH = 34246,
 NPC_LIVING_CONSTELLATION = 33052,
 NPC_ALGALON_STALKER = 33086,
 NPC_COLLAPSING_STAR = 32955,
 NPC_BLACK_HOLE = 32953,
 NPC_WORM_HOLE = 34099,
 NPC_ALGALON_VOID_ZONE_VISUAL_STALKER = 34100,
 NPC_ALGALON_STALKER_ASTEROID_TARGET_01 = 33104,
 NPC_ALGALON_STALKER_ASTEROID_TARGET_02 = 33105,
 NPC_UNLEASHED_DARK_MATTER = 34097,
};
 
enum UlduarGameObjects
{
 // Leviathan
 GO_LEVIATHAN_DOOR = 194905,
 GO_LEVIATHAN_GATE = 194630,
 
 // Razorscale
 GO_MOLE_MACHINE = 194316,
 GO_RAZOR_HARPOON_1 = 194542,
 GO_RAZOR_HARPOON_2 = 194541,
 GO_RAZOR_HARPOON_3 = 194543,
 GO_RAZOR_HARPOON_4 = 194519,
 GO_RAZOR_BROKEN_HARPOON = 194565,
 
 // XT-002
 GO_XT_002_DOOR = 194631,
 
 // Assembly of Iron
 GO_IRON_COUNCIL_DOOR = 194554,
 GO_ARCHIVUM_DOOR = 194556,
 
 // Kologarn
 GO_KOLOGARN_CHEST_HERO = 195047,
 GO_KOLOGARN_CHEST = 195046,
 GO_KOLOGARN_BRIDGE = 194232,
 GO_KOLOGARN_DOOR = 194553,
 
 GO_ANCIENT_GATE_OF_THE_KEEPERS = 194255,
 
 // Hodir
 GO_HODIR_ENTRANCE = 194442,
 GO_HODIR_DOOR = 194634,
 GO_HODIR_ICE_DOOR = 194441,
 GO_HODIR_RARE_CACHE_OF_WINTER = 194200,
 GO_HODIR_RARE_CACHE_OF_WINTER_HERO = 194201,
 GO_HODIR_CHEST_HERO = 194308,
 GO_HODIR_CHEST = 194307,
 
 // Thorim
 GO_CACHE_OF_STORMS_10 = 194312,
 GO_CACHE_OF_STORMS_HARDMODE_10 = 194313,
 GO_CACHE_OF_STORMS_25 = 194315,
 GO_CACHE_OF_STORMS_HARDMODE_25 = 194314,
 GO_THORIM_RUNIC_DOOR = 194557,
 GO_THORIM_STONE_DOOR = 194558,
 GO_THORIM_ENCOUNTER_DOOR = 194559,
 GO_THORIM_LEVER = 194264,
 GO_THORIM_DARK_IRON_PORTCULLIS = 194560,
 
 // Mimiron
 GO_MIMIRON_TRAM = 194675,
 GO_MIMIRON_ELEVATOR = 194749,
 GO_MIMIRON_BUTTON = 194739,
 GO_MIMIRON_DOOR_1 = 194774,
 GO_MIMIRON_DOOR_2 = 194775,
 GO_MIMIRON_DOOR_3 = 194776,
 GO_CACHE_OF_INNOVATION = 194789,
 GO_CACHE_OF_INNOVATION_FIREFIGHTER = 194957,
 GO_CACHE_OF_INNOVATION_HERO = 194956,
 GO_CACHE_OF_INNOVATION_FIREFIGHTER_HERO = 194958,
 
 // Vezax
 GO_VEZAX_DOOR = 194750,
 
 // Yogg-Saron
 GO_YOGG_SARON_DOOR = 194773,
 GO_BRAIN_ROOM_DOOR_1 = 194635,
 GO_BRAIN_ROOM_DOOR_2 = 194636,
 GO_BRAIN_ROOM_DOOR_3 = 194637,
 
 // Algalon the Observer
 GO_CELESTIAL_PLANETARIUM_ACCESS_10 = 194628,
 GO_CELESTIAL_PLANETARIUM_ACCESS_25 = 194752,
 GO_DOODAD_UL_SIGILDOOR_01 = 194767,
 GO_DOODAD_UL_SIGILDOOR_02 = 194911,
 GO_DOODAD_UL_SIGILDOOR_03 = 194910,
 GO_DOODAD_UL_UNIVERSEFLOOR_01 = 194715,
 GO_DOODAD_UL_UNIVERSEFLOOR_02 = 194716,
 GO_DOODAD_UL_UNIVERSEGLOBE01 = 194148,
 GO_DOODAD_UL_ULDUAR_TRAPDOOR_03 = 194253,
 GO_GIFT_OF_THE_OBSERVER_10 = 194821,
 GO_GIFT_OF_THE_OBSERVER_25 = 194822,
};
 
enum UUEventIds
{
 EVENT_TOWER_OF_STORM_DESTROYED = 21031,
 EVENT_TOWER_OF_FROST_DESTROYED = 21032,
 EVENT_TOWER_OF_FLAMES_DESTROYED = 21033,
 EVENT_TOWER_OF_LIFE_DESTROYED = 21030,
 EVENT_ACTIVATE_SANITY_WELL = 21432,
 EVENT_HODIRS_PROTECTIVE_GAZE_PROC = 21437,
};
 
enum LeviathanActions
{
 ACTION_TOWER_OF_STORM_DESTROYED = 1,
 ACTION_TOWER_OF_FROST_DESTROYED = 2,
 ACTION_TOWER_OF_FLAMES_DESTROYED = 3,
 ACTION_TOWER_OF_LIFE_DESTROYED = 4,
 ACTION_MOVE_TO_CENTER_POSITION = 10,
};
 
enum UlduarAchievementCriteriaIds
{
 CRITERIA_CON_SPEED_ATORY = 21597,
 CRITERIA_LUMBERJACKED = 21686,
 CRITERIA_DISARMED = 21687,
 CRITERIA_WAITS_DREAMING_STORMWIND_25 = 10321,
 CRITERIA_WAITS_DREAMING_CHAMBER_25 = 10322,
 CRITERIA_WAITS_DREAMING_ICECROWN_25 = 10323,
 CRITERIA_WAITS_DREAMING_STORMWIND_10 = 10324,
 CRITERIA_WAITS_DREAMING_CHAMBER_10 = 10325,
 CRITERIA_WAITS_DREAMING_ICECROWN_10 = 10326,
 CRITERIA_DRIVE_ME_CRAZY_10 = 10185,
 CRITERIA_DRIVE_ME_CRAZY_25 = 10296,
 CRITERIA_HERALD_OF_TITANS = 10678,
 
 // Champion of Ulduar
 CRITERIA_C_O_U_LEVIATHAN_10 = 10042,
 CRITERIA_C_O_U_IGNIS_10 = 10342,
 CRITERIA_C_O_U_RAZORSCALE_10 = 10340,
 CRITERIA_C_O_U_XT002_10 = 10341,
 CRITERIA_C_O_U_IRON_COUNCIL_10 = 10598,
 CRITERIA_C_O_U_KOLOGARN_10 = 10348,
 CRITERIA_C_O_U_AURIAYA_10 = 10351,
 CRITERIA_C_O_U_HODIR_10 = 10439,
 CRITERIA_C_O_U_THORIM_10 = 10403,
 CRITERIA_C_O_U_FREYA_10 = 10582,
 CRITERIA_C_O_U_MIMIRON_10 = 10347,
 CRITERIA_C_O_U_VEZAX_10 = 10349,
 CRITERIA_C_O_U_YOGG_SARON_10 = 10350,
 // Conqueror of Ulduar
 CRITERIA_C_O_U_LEVIATHAN_25 = 10352,
 CRITERIA_C_O_U_IGNIS_25 = 10355,
 CRITERIA_C_O_U_RAZORSCALE_25 = 10353,
 CRITERIA_C_O_U_XT002_25 = 10354,
 CRITERIA_C_O_U_IRON_COUNCIL_25 = 10599,
 CRITERIA_C_O_U_KOLOGARN_25 = 10357,
 CRITERIA_C_O_U_AURIAYA_25 = 10363,
 CRITERIA_C_O_U_HODIR_25 = 10719,
 CRITERIA_C_O_U_THORIM_25 = 10404,
 CRITERIA_C_O_U_FREYA_25 = 10583,
 CRITERIA_C_O_U_MIMIRON_25 = 10361,
 CRITERIA_C_O_U_VEZAX_25 = 10362,
 CRITERIA_C_O_U_YOGG_SARON_25 = 10364
};
 
enum UlduarData
{
 // Colossus (Leviathan)
 DATA_COLOSSUS = 20,
 
 // Razorscale
 DATA_EXPEDITION_COMMANDER,
 DATA_RAZORSCALE_CONTROL,
 
 // XT-002
 DATA_TOY_PILE_0,
 DATA_TOY_PILE_1,
 DATA_TOY_PILE_2,
 DATA_TOY_PILE_3,
 DATA_XT002_HEART,
 
 // Assembly of Iron
 DATA_STEELBREAKER,
 DATA_MOLGEIM,
 DATA_BRUNDIR,
 
 // Hodir
 DATA_HODIR_RARE_CACHE,
 
 // Mimiron
 DATA_LEVIATHAN_MK_II,
 DATA_VX_001,
 DATA_AERIAL_COMMAND_UNIT,
 DATA_COMPUTER,
 DATA_MIMIRON_WORLD_TRIGGER,
 DATA_MIMIRON_ELEVATOR,
 DATA_MIMIRON_TRAM,
 DATA_MIMIRON_BUTTON,
 
 // Yogg-Saron
 DATA_VOICE_OF_YOGG_SARON,
 DATA_SARA,
 DATA_BRAIN_OF_YOGG_SARON,
 DATA_FREYA_YS,
 DATA_HODIR_YS,
 DATA_THORIM_YS,
 DATA_MIMIRON_YS,
 DATA_ILLUSION,
 DATA_DRIVE_ME_CRAZY,
 DATA_KEEPERS_COUNT,
 
 // Algalon the Observer
 DATA_ALGALON_SUMMON_STATE,
 DATA_SIGILDOOR_01,
 DATA_SIGILDOOR_02,
 DATA_SIGILDOOR_03,
 DATA_UNIVERSE_FLOOR_01,
 DATA_UNIVERSE_FLOOR_02,
 DATA_UNIVERSE_GLOBE,
 DATA_ALGALON_TRAPDOOR,
 DATA_BRANN_BRONZEBEARD_ALG,
 DATA_GIFT_OF_THE_OBSERVER,
 DATA_AZEROTH,
 
 // Thorim
 DATA_SIF,
 DATA_THORIM_LEVER,
 DATA_RUNIC_COLOSSUS,
 DATA_RUNE_GIANT,
 DATA_RUNIC_DOOR,
 DATA_STONE_DOOR,
 DATA_THORIM_HARDMODE,
 DATA_THORIM_CONTROLLER,
 
 // Misc
 DATA_BRANN_BRONZEBEARD_INTRO,
 DATA_LORE_KEEPER_OF_NORGANNON,
 DATA_DELLORAH,
 DATA_BRONZEBEARD_RADIO
};
 
enum UlduarWorldStates
{
 WORLD_STATE_FLAME_LEVIATHAN_DESTROYED_TOWERS = 4129,
 WORLD_STATE_YOGG_SARON_KEEPERS = 4116,
 WORLD_STATE_ALGALON_DESPAWN_TIMER = 4131,
 WORLD_STATE_ALGALON_TIMER_ENABLED = 5636,
};
 
enum UlduarAchievementData
{
 // FL Achievement boolean
 DATA_UNBROKEN = 29052906, // 2905, 2906 are achievement IDs,
 MAX_HERALD_ARMOR_ITEMLEVEL = 35,
 MAX_HERALD_WEAPON_ITEMLEVEL = 35
};
 
enum UlduarSharedSpells
{
 SPELL_LUMBERJACKED_CREDIT = 65296,
 SPELL_TELEPORT_KEEPER_VISUAL = 62940 // used by keepers
};
 
enum UlduarEvents
{
 ACTION_INIT_ALGALON = 6,
 EVENT_DESPAWN_LEVIATHAN_VEHICLES = 7,
 EVENT_LEVIATHAN_BREAK_DOOR = 8
};
 
enum YoggSaronIllusions
{
 CHAMBER_ILLUSION = 0,
 ICECROWN_ILLUSION = 1,
 STORMWIND_ILLUSION = 2,
};
 
class Creature;
 
class UlduarKeeperDespawnEvent : public BasicEvent
{
 public:
 UlduarKeeperDespawnEvent(Creature* owner, Milliseconds despawnTimerOffset = 500ms);
 
 bool Execute(uint64 /*eventTime*/, uint32 /*updateTime*/) override;
 
 private:
 Creature* _owner;
 Milliseconds _despawnTimer;
};
 
template <class AI, class T>
inline AI* GetUlduarAI(T* obj)
{
 return GetInstanceAI<AI, T>(obj, UlduarScriptName);
}
 
#define RegisterUlduarCreatureAI(ai_name) RegisterCreatureAIWithFactory(ai_name, GetUlduarAI)
 
#endif