First step of comment style refactoring to doxygen-style.

This commit is contained in:
Nefarion committed 2013-03-08 21:55:37 +01:00
1 parent 2dbe3d6cfe
commit 49fd11ab5a
164 files changed
+363 -362

No files matched your search

@@ -780,7 +780,7 @@ class npc_halion_controller : public CreatureScript
}
private:
/// TODO: Find out a better scaling, if any.
//// @todo Find out a better scaling, if any.
// [0 , 0.98[: Corporeality goes down
// [0.98, 0.99]: Do nothing
// ]0.99, 1.01[: Twilight Mending
@@ -16,7 +16,7 @@
*/
/*
* Comment: TODO: spawn troll waves
* Comment: @todo spawn troll waves
*/
#include "ScriptMgr.h"
@@ -22,7 +22,7 @@
#include "SpellInfo.h"
/*
* TODO:
* @todo
* - Fix model id during unleash soul -> seems DB issue 36503 is missing (likewise 36504 is also missing).
* - Fix outro npc movement
*/
@@ -34,7 +34,7 @@ enum Spells
SPELL_IMPENDING_DESPAIR = 72426,
SPELL_DEFILING_HORROR = 72435,
SPELL_HOPELESSNESS = 72395,
H_SPELL_HOPELESSNESS = 72390, // TODO: not in dbc. Add in DB.
H_SPELL_HOPELESSNESS = 72390, /// @todo not in dbc. Add in DB.
};
enum Events
@@ -79,7 +79,7 @@ public:
events.ScheduleEvent(EVENT_QUIVERING_STRIKE, 23000);
events.ScheduleEvent(EVENT_IMPENDING_DESPAIR, 9000);
events.ScheduleEvent(EVENT_DEFILING_HORROR, urand(25000, 45000)); // TODO adjust timer.
events.ScheduleEvent(EVENT_DEFILING_HORROR, urand(25000, 45000)); /// @todo adjust timer.
}
void JustDied(Unit* /*killer*/)
@@ -122,7 +122,7 @@ public:
break;
case EVENT_DEFILING_HORROR:
DoCast(SPELL_DEFILING_HORROR);
events.ScheduleEvent(EVENT_DEFILING_HORROR, urand(25000, 45000)); // TODO adjust timer.
events.ScheduleEvent(EVENT_DEFILING_HORROR, urand(25000, 45000)); /// @todo adjust timer.
break;
}
@@ -72,10 +72,10 @@ public:
if (instance)
instance->SetData(DATA_MARWYN_EVENT, IN_PROGRESS);
events.ScheduleEvent(EVENT_OBLITERATE, 30000); // TODO Check timer
events.ScheduleEvent(EVENT_OBLITERATE, 30000); /// @todo Check timer
events.ScheduleEvent(EVENT_WELL_OF_CORRUPTION, 13000);
events.ScheduleEvent(EVENT_CORRUPTED_FLESH, 20000);
events.ScheduleEvent(EVENT_SHARED_SUFFERING, 20000); // TODO Check timer
events.ScheduleEvent(EVENT_SHARED_SUFFERING, 20000); /// @todo Check timer
}
void JustDied(Unit* /*killer*/)
@@ -270,7 +270,7 @@ public:
events.ScheduleEvent(EVENT_INTRO_A2_3, 10000);
break;
case EVENT_INTRO_A2_3:
// TODO: she's doing some kind of spell casting emote
/// @todo she's doing some kind of spell casting emote
instance->HandleGameObject(instance->GetData64(DATA_FROSTMOURNE), true);
events.ScheduleEvent(EVENT_INTRO_A2_4, 10000);
break;
@@ -367,7 +367,7 @@ public:
break;
case EVENT_INTRO_H2_3:
Talk(SAY_SYLVANAS_INTRO_3);
// TODO: she's doing some kind of spell casting emote
/// @todo she's doing some kind of spell casting emote
events.ScheduleEvent(EVENT_INTRO_H2_4, 6000);
break;
case EVENT_INTRO_H2_4:
@@ -524,7 +524,7 @@ public:
Talk(SAY_SYLVANAS_INTRO_END);
me->GetMotionMaster()->MovePoint(0, LichKingSpawnPos);
// TODO: Loralen/Koreln shall run also
/// @todo Loralen/Koreln shall run also
events.ScheduleEvent(EVENT_INTRO_END, 10000);
break;
@@ -537,7 +537,7 @@ public:
break;
case EVENT_SKIP_INTRO:
// TODO: implement
/// @todo implement
if (Creature* pFalric = me->GetCreature(*me, instance->GetData64(DATA_FALRIC)))
pFalric->SetVisible(true);
@@ -545,7 +545,7 @@ public:
pMarwyn->SetVisible(true);
me->GetMotionMaster()->MovePoint(0, LichKingSpawnPos);
// TODO: Loralen/Koreln shall run also
/// @todo Loralen/Koreln shall run also
events.ScheduleEvent(EVENT_INTRO_END, 15000);
break;
@@ -651,7 +651,7 @@ public:
void EnterCombat(Unit* /*who*/)
{
events.ScheduleEvent(EVENT_SHADOW_WORD_PAIN, 8000); // TODO: adjust timers
events.ScheduleEvent(EVENT_SHADOW_WORD_PAIN, 8000); /// @todo adjust timers
events.ScheduleEvent(EVENT_CIRCLE_OF_DESTRUCTION, 12000);
events.ScheduleEvent(EVENT_COWER_IN_FEAR, 10000);
events.ScheduleEvent(EVENT_DARK_MENDING, 20000);
@@ -733,7 +733,7 @@ public:
void EnterCombat(Unit* /*who*/)
{
events.ScheduleEvent(EVENT_FIREBALL, 3000); // TODO: adjust timers
events.ScheduleEvent(EVENT_FIREBALL, 3000); /// @todo adjust timers
events.ScheduleEvent(EVENT_FLAMESTRIKE, 6000);
events.ScheduleEvent(EVENT_FROSTBOLT, 9000);
events.ScheduleEvent(EVENT_CHAINS_OF_ICE, 12000);
@@ -834,7 +834,7 @@ public:
void EnterCombat(Unit* /*who*/)
{
events.ScheduleEvent(EVENT_SHADOW_STEP, 8000); // TODO: adjust timers
events.ScheduleEvent(EVENT_SHADOW_STEP, 8000); /// @todo adjust timers
events.ScheduleEvent(EVENT_DEADLY_POISON, 5000);
events.ScheduleEvent(EVENT_ENVENOMED_DAGGER_THROW, 10000);
events.ScheduleEvent(EVENT_KIDNEY_SHOT, 12000);
@@ -905,7 +905,7 @@ public:
void EnterCombat(Unit* /*who*/)
{
events.ScheduleEvent(EVENT_SPECTRAL_STRIKE, 5000); // TODO: adjust timers
events.ScheduleEvent(EVENT_SPECTRAL_STRIKE, 5000); /// @todo adjust timers
events.ScheduleEvent(EVENT_SHIELD_BASH, 10000);
events.ScheduleEvent(EVENT_TORTURED_ENRAGE, 15000);
}
@@ -970,7 +970,7 @@ public:
void EnterCombat(Unit* /*who*/)
{
events.ScheduleEvent(EVENT_SHOOT, 2000); // TODO: adjust timers
events.ScheduleEvent(EVENT_SHOOT, 2000); /// @todo adjust timers
events.ScheduleEvent(EVENT_CURSED_ARROW, 10000);
events.ScheduleEvent(EVENT_FROST_TRAP, 1000);
events.ScheduleEvent(EVENT_ICE_SHOT, 15000);
@@ -182,7 +182,7 @@ public:
void OnGameObjectCreate(GameObject* go)
{
// TODO: init state depending on encounters
/// @todo init state depending on encounters
switch (go->GetEntry())
{
case GO_FROSTMOURNE:
@@ -364,7 +364,7 @@ public:
DoUpdateWorldState(WORLD_STATE_HOR_WAVE_COUNT, uiWaveCount);
HandleGameObject(uiFrontDoor, true);
// TODO
/// @todo
// in case of wipe, the event is normally restarted by jumping into the center of the room.
// As I can't find a trigger area there, just respawn Jaina/Sylvanas so the event may be restarted.
if (Creature* pJaina = instance->GetCreature(uiJainaPart1))
@@ -385,7 +385,7 @@ public:
summoner->SetVisible(true);
// TODO: do composition at random. # of spawn also depends on uiWaveCount
/// @todo do composition at random. # of spawn also depends on uiWaveCount
// As of now, it is just one of each.
index = urand(0, ENCOUNTER_WAVE_MERCENARY-1);
summoner->SummonCreature(NPC_WAVE_MERCENARY, MercenarySpawnPos[index], TEMPSUMMON_TIMED_DESPAWN_OUT_OF_COMBAT, 0);
@@ -417,7 +417,7 @@ public:
AddWave();
break;
case EVENT_START_LICH_KING:
// TODO
/// @todo
break;
}
}
@@ -448,7 +448,7 @@ class boss_krick : public CreatureScript
break;
case EVENT_OUTRO_9:
Talk(SAY_KRICK_OUTRO_8);
// TODO: Tyrannus starts killing Krick.
/// @todo Tyrannus starts killing Krick.
// there shall be some visual spell effect
if (Creature* tyrannus = ObjectAccessor::GetCreature(*me, _tyrannusGUID))
tyrannus->CastSpell(me, SPELL_NECROMANTIC_POWER, true); //not sure if it's the right spell :/
@@ -63,7 +63,7 @@ enum ScriptTexts
SAY_INTRO_ALLIANCE_1 = 0,
SAY_INTRO_ALLIANCE_4 = 1,
SAY_INTRO_ALLIANCE_5 = 2,
SAY_OUTRO_ALLIANCE_1 = 3, // TODO ALLIANCE OUTRO
SAY_OUTRO_ALLIANCE_1 = 3, /// @todo ALLIANCE OUTRO
SAY_OUTRO_ALLIANCE_2 = 4,
SAY_OUTRO_ALLIANCE_3 = 5,
SAY_OUTRO_ALLIANCE_4 = 6,
@@ -138,7 +138,7 @@ enum Spells
SPELL_IN_FROSTMOURNE_ROOM = 74276,
SPELL_KILL_FROSTMOURNE_PLAYERS = 75127,
SPELL_HARVESTED_SOUL = 72679,
SPELL_TRIGGER_VILE_SPIRIT_HEROIC = 73582, // TODO: Cast every 3 seconds during Frostmourne phase, targets a Wicked Spirit amd activates it
SPELL_TRIGGER_VILE_SPIRIT_HEROIC = 73582, /// @todo Cast every 3 seconds during Frostmourne phase, targets a Wicked Spirit amd activates it
// Frostmourne
SPELL_LIGHTS_FAVOR = 69382,
@@ -42,7 +42,7 @@ class icecrown_citadel_teleport : public GameObjectScript
player->ADD_GOSSIP_ITEM(GOSSIP_ICON_CHAT, "Teleport to the Deathbringer's Rise.", GOSSIP_SENDER_ICC_PORT, DEATHBRINGER_S_RISE_TELEPORT);
if (instance->GetData(DATA_COLDFLAME_JETS) == DONE)
player->ADD_GOSSIP_ITEM(GOSSIP_ICON_CHAT, "Teleport to the Upper Spire.", GOSSIP_SENDER_ICC_PORT, UPPER_SPIRE_TELEPORT);
// TODO: Gauntlet event before Sindragosa
/// @todo Gauntlet event before Sindragosa
if (instance->GetBossState(DATA_VALITHRIA_DREAMWALKER) == DONE)
player->ADD_GOSSIP_ITEM(GOSSIP_ICON_CHAT, "Teleport to Sindragosa's Lair", GOSSIP_SENDER_ICC_PORT, SINDRAGOSA_S_LAIR_TELEPORT);
}
@@ -95,7 +95,7 @@ public:
void KilledUnit(Unit* victim)
{
//Force the player to spawn corpse scarabs via spell, TODO: Check percent chance for scarabs, 20% at the moment
/// Force the player to spawn corpse scarabs via spell, @todo Check percent chance for scarabs, 20% at the moment
if (!(rand()%5))
if (victim->GetTypeId() == TYPEID_PLAYER)
victim->CastSpell(victim, SPELL_SUMMON_CORPSE_SCARABS_PLR, true, NULL, NULL, me->GetGUID());
@@ -164,13 +164,13 @@ public:
events.ScheduleEvent(EVENT_IMPALE, urand(10000, 20000));
break;
case EVENT_LOCUST:
// TODO : Add Text
/// @todo Add Text
DoCast(me, RAID_MODE(SPELL_LOCUST_SWARM_10, SPELL_LOCUST_SWARM_25));
DoSummon(MOB_CRYPT_GUARD, GuardSummonPos, 0, TEMPSUMMON_CORPSE_DESPAWN);
events.ScheduleEvent(EVENT_LOCUST, 90000);
break;
case EVENT_SPAWN_GUARDIAN_NORMAL:
// TODO : Add Text
/// @todo Add Text
DoSummon(MOB_CRYPT_GUARD, GuardSummonPos, 0, TEMPSUMMON_CORPSE_DESPAWN);
break;
case EVENT_BERSERK:
@@ -107,7 +107,7 @@ class boss_faerlina : public CreatureScript
{
if (spell->Id == SPELL_WIDOWS_EMBRACE || spell->Id == H_SPELL_WIDOWS_EMBRACE)
{
// TODO : Add Text
/// @todo Add Text
++_frenzyDispels;
_delayFrenzy = true;
me->Kill(caster);
@@ -153,7 +153,7 @@ class boss_faerlina : public CreatureScript
events.ScheduleEvent(EVENT_FIRE, urand(6000, 18000));
break;
case EVENT_FRENZY:
// TODO : Add Text
/// @todo Add Text
if (!me->HasAura(SPELL_WIDOWS_EMBRACE_HELPER))
DoCast(me, RAID_MODE(SPELL_FRENZY, H_SPELL_FRENZY));
else
@@ -69,7 +69,7 @@ public:
if (who->GetEntry() == MOB_ZOMBIE && me->IsWithinDistInMap(who, 7))
{
SetGazeOn(who);
// TODO: use a script text
/// @todo use a script text
me->MonsterTextEmote(EMOTE_NEARBY, 0, true);
}
else
@@ -109,12 +109,12 @@ public:
events.ScheduleEvent(EVENT_WOUND, 10000);
break;
case EVENT_ENRAGE:
// TODO : Add missing text
/// @todo Add missing text
DoCast(me, SPELL_ENRAGE);
events.ScheduleEvent(EVENT_ENRAGE, 15000);
break;
case EVENT_DECIMATE:
// TODO : Add missing text
/// @todo Add missing text
DoCastAOE(SPELL_DECIMATE);
events.ScheduleEvent(EVENT_DECIMATE, 105000);
break;
@@ -153,7 +153,7 @@ public:
events.ScheduleEvent(EVENT_FEVER, urand(20000, 25000));
break;
case EVENT_PHASE:
// TODO : Add missing texts for both phase switches
/// @todo Add missing texts for both phase switches
EnterPhase(phase == PHASE_FIGHT ? PHASE_DANCE : PHASE_FIGHT);
break;
case EVENT_ERUPT:
@@ -474,7 +474,7 @@ public:
{
if (uiGuardiansOfIcecrownTimer <= diff)
{
// TODO : Add missing text
/// @todo Add missing text
if (Creature* pGuardian = DoSummon(NPC_ICECROWN, Pos[RAND(2, 5, 8, 11)]))
pGuardian->SetFloatValue(UNIT_FIELD_COMBATREACH, 2);
++nGuardiansOfIcecrownCount;
@@ -103,7 +103,7 @@ public:
switch (eventId)
{
case EVENT_WRAP:
// TODO : Add missing text
/// @todo Add missing text
for (uint8 i = 0; i < RAID_MODE(1, 2); ++i)
{
if (Unit* target = SelectTarget(SELECT_TARGET_RANDOM, 1, 0, true, -SPELL_WEB_WRAP))
@@ -134,7 +134,7 @@ public:
events.ScheduleEvent(EVENT_FRENZY, 600000);
break;
case EVENT_SUMMON:
// TODO : Add missing text
/// @todo Add missing text
uint8 amount = urand(8, 10);
for (uint8 i = 0; i < amount; ++i)
DoSummon(MOB_SPIDERLING, me, 0, TEMPSUMMON_CORPSE_DESPAWN);
@@ -86,7 +86,7 @@ public:
{
_JustDied();
DoPlaySoundToSet(me, SOUND_DEATH);
me->CastSpell(me, SPELL_HOPELESS, true); // TODO: this may affect other creatures
me->CastSpell(me, SPELL_HOPELESS, true); /// @todo this may affect other creatures
}
void EnterCombat(Unit* /*who*/)
@@ -78,7 +78,7 @@ public:
return true;
}
// TO DO: this should be handled in map, maybe add a summon function in map
/// @todo this should be handled in map, maybe add a summon function in map
// There is no other way afaik...
void SpawnGameObject(uint32 entry, Position& pos)
{
@@ -244,7 +244,7 @@ class spell_intense_cold : public SpellScriptLoader
if (aurEff->GetBase()->GetStackAmount() < 2)
return;
Unit* caster = GetCaster();
//TODO: the caster should be boss but not the player
/// @todo the caster should be boss but not the player
if (!caster || !caster->GetAI())
return;
caster->GetAI()->SetGUID(GetTarget()->GetGUID(), DATA_INTENSE_COLD);
@@ -206,7 +206,7 @@ public:
instance->SetData(TYPE_BJARNGRIM, DONE);
}
//TODO: remove when removal is done by the core
/// @todo remove when removal is done by the core
void DoRemoveStanceAura(uint8 uiStance)
{
switch (uiStance)
@@ -164,7 +164,7 @@ public:
//this part should be in the core
if (pSpell->Id == SPELL_SHATTER || pSpell->Id == H_SPELL_SHATTER)
{
// todo: we need eventmap to kill this stuff
/// @todo we need eventmap to kill this stuff
//clear this, if we are still performing
if (bIsSlam)
{
@@ -1176,7 +1176,7 @@ class npc_lorekeeper : public CreatureScript
if (Creature* Branz = creature->FindNearestCreature(NPC_BRANZ_BRONZBEARD, 1000, true))
{
Delorah->GetMotionMaster()->MovePoint(0, Branz->GetPositionX()-4, Branz->GetPositionY(), Branz->GetPositionZ());
//TODO Delorah->AI()->Talk(xxxx, Branz->GetGUID()); when reached at branz
/// @todo Delorah->AI()->Talk(xxxx, Branz->GetGUID()); when reached at branz
}
}
}
@@ -1608,7 +1608,7 @@ class FlameLeviathanPursuedTargetSelector
bool operator()(WorldObject* target) const
{
//! No players, only vehicles (todo: check if blizzlike)
//! No players, only vehicles (@todo check if blizzlike)
Creature* creatureTarget = target->ToCreature();
if (!creatureTarget)
return true;
@@ -25,7 +25,7 @@
#include "GridNotifiersImpl.h"
#include "ulduar.h"
/* #TODO: Achievements
/* @todo Achievements
Storm Cloud (Shaman ability)
Destroying of Toasty Fires
*/
@@ -26,7 +26,7 @@
/* ScriptData
SDName: boss_kologarn
SD%Complete: 90
SDComment: TODO: Achievements
SDComment: @todo Achievements
SDCategory: Ulduar
EndScriptData */
@@ -15,7 +15,7 @@
* with this program. If not, see <http://www.gnu.org/licenses/>.
*/
//TODO: Harpoon chain from 62505 should not get removed when other chain is applied
/// @todo Harpoon chain from 62505 should not get removed when other chain is applied
#include "ScriptMgr.h"
#include "ScriptedCreature.h"
@@ -82,7 +82,7 @@ class boss_thorim : public CreatureScript
{
if (!UpdateVictim())
return;
//SPELLS TODO:
//SPELLS @todo
//
DoMeleeAttackIfReady();
@@ -16,7 +16,7 @@
*/
/*
TODO:
@todo
Fix void zone damage
If the boss is to close to a scrap pile -> no summon -- Needs retail confirmation
make the life sparks visible... /? Need test
@@ -674,7 +674,7 @@ class mob_boombot : public CreatureScript
me->SetFloatValue(UNIT_FIELD_MINDAMAGE, 15000.0f);
me->SetFloatValue(UNIT_FIELD_MAXDAMAGE, 18000.0f);
// Todo: proper waypoints?
/// @todo proper waypoints?
if (Creature* pXT002 = me->GetCreature(*me, _instance->GetData64(BOSS_XT002)))
me->GetMotionMaster()->MoveFollow(pXT002, 0.0f, 0.0f);
}
@@ -65,10 +65,10 @@ class boss_koralon : public CreatureScript
{
DoCast(me, SPELL_BURNING_FURY);
events.ScheduleEvent(EVENT_BURNING_FURY, 20000); // TODO check timer
events.ScheduleEvent(EVENT_BURNING_FURY, 20000); /// @todo check timer
events.ScheduleEvent(EVENT_BURNING_BREATH, 15000); // 1st after 15sec, then every 45sec
events.ScheduleEvent(EVENT_METEOR_FISTS_A, 75000); // 1st after 75sec, then every 45sec
events.ScheduleEvent(EVENT_FLAME_CINDER_A, 30000); // TODO check timer
events.ScheduleEvent(EVENT_FLAME_CINDER_A, 30000); /// @todo check timer
_EnterCombat();
}
@@ -55,7 +55,7 @@ enum Actions
ACTION_WATER_ELEMENT_KILLED = 2,
};
// TODO get those positions from spawn of creature 29326
/// @todo get those positions from spawn of creature 29326
#define MAX_SPAWN_LOC 5
static Position SpawnLoc[MAX_SPAWN_LOC]=
{
@@ -792,7 +792,7 @@ public:
void ActivateCrystal()
{
// Kill all mobs registered with SetData64(ADD_TRASH_MOB)
// TODO: All visual, spells etc
/// @todo All visual, spells etc
for (std::set<uint64>::const_iterator itr = trashMobs.begin(); itr != trashMobs.end(); ++itr)
{
Creature* creature = instance->GetCreature(*itr);
@@ -362,7 +362,7 @@ public:
return true;
}
// TODO: make prisoners help (unclear if summoned or using npc's from surrounding cages (summon inside small cages?))
/// @todo make prisoners help (unclear if summoned or using npc's from surrounding cages (summon inside small cages?))
struct npc_daegarnAI : public ScriptedAI
{
npc_daegarnAI(Creature* creature) : ScriptedAI(creature) { }
@@ -948,7 +948,7 @@ public:
bird->Kill(bird);
crunchy->GetMotionMaster()->MovePoint(0, bird->GetPositionX(), bird->GetPositionY(),
bird->GetMap()->GetWaterOrGroundLevel(bird->GetPositionX(), bird->GetPositionY(), bird->GetPositionZ()));
// TODO: Make crunchy perform emote eat when he reaches the bird
/// @todo Make crunchy perform emote eat when he reaches the bird
break;
}