josh/TCPlayerbotCore
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #9299 from Ascathor/master

Browse Source 
Few documentation changes
This commit is contained in:
QAston
2013-02-28 02:24:19 -08:00
parent 58ac8207ec d6d066f014
commit e097994b23
7 changed files with 48 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/server/game/Battlefield/Zones/BattlefieldWG.h
+18 -18
View File
@@ -102,21 +102,21 @@ enum WintergraspData
enum WintergraspAchievements
{
ACHIEVEMENTS_WIN_WG = 1717,
ACHIEVEMENTS_WIN_WG_100 = 1718, // todo
ACHIEVEMENTS_WG_GNOMESLAUGHTER = 1723, // todo
ACHIEVEMENTS_WIN_WG_100 = 1718, /// @todo: Has to be implemented
ACHIEVEMENTS_WG_GNOMESLAUGHTER = 1723, /// @todo: Has to be implemented
ACHIEVEMENTS_WG_TOWER_DESTROY = 1727,
ACHIEVEMENTS_DESTRUCTION_DERBY_A = 1737, // todo
ACHIEVEMENTS_WG_TOWER_CANNON_KILL = 1751, // todo
ACHIEVEMENTS_WG_MASTER_A = 1752, // todo
ACHIEVEMENTS_DESTRUCTION_DERBY_A = 1737, /// @todo: Has to be implemented
ACHIEVEMENTS_WG_TOWER_CANNON_KILL = 1751, /// @todo: Has to be implemented
ACHIEVEMENTS_WG_MASTER_A = 1752, /// @todo: Has to be implemented
ACHIEVEMENTS_WIN_WG_TIMER_10 = 1755,
ACHIEVEMENTS_STONE_KEEPER_50 = 2085, // todo
ACHIEVEMENTS_STONE_KEEPER_100 = 2086, // todo
ACHIEVEMENTS_STONE_KEEPER_250 = 2087, // todo
ACHIEVEMENTS_STONE_KEEPER_500 = 2088, // todo
ACHIEVEMENTS_STONE_KEEPER_1000 = 2089, // todo
ACHIEVEMENTS_WG_RANGER = 2199, // todo
ACHIEVEMENTS_DESTRUCTION_DERBY_H = 2476, // todo
ACHIEVEMENTS_WG_MASTER_H = 2776 // todo
ACHIEVEMENTS_STONE_KEEPER_50 = 2085, /// @todo: Has to be implemented
ACHIEVEMENTS_STONE_KEEPER_100 = 2086, /// @todo: Has to be implemented
ACHIEVEMENTS_STONE_KEEPER_250 = 2087, /// @todo: Has to be implemented
ACHIEVEMENTS_STONE_KEEPER_500 = 2088, /// @todo: Has to be implemented
ACHIEVEMENTS_STONE_KEEPER_1000 = 2089, /// @todo: Has to be implemented
ACHIEVEMENTS_WG_RANGER = 2199, /// @todo: Has to be implemented
ACHIEVEMENTS_DESTRUCTION_DERBY_H = 2476, /// @todo: Has to be implemented
ACHIEVEMENTS_WG_MASTER_H = 2776 /// @todo: Has to be implemented
};
enum WintergraspWorldStates
@@ -499,7 +499,7 @@ enum WintergraspTeamControl
BATTLEFIELD_WG_TEAM_NEUTRAL
};
// TODO: Handle this with creature_text ?
/// @todo: Can this be handled with creature_text or SmartAI ?
enum WintergraspText
{
BATTLEFIELD_WG_TEXT_WORKSHOP_NAME_NE = 12055,
@@ -562,7 +562,7 @@ struct WintergraspObjectPositionData
};
// *****************************************************
// ************ Destructible (Wall, Tower..) ************
// ************ Destructible (Wall, Tower..) ***********
// *****************************************************
struct WintergraspBuildingSpawnData
@@ -755,7 +755,7 @@ const WintergraspTeleporterData WGPortalDefenderData[WG_MAX_TELEPORTER] =
};
// *********************************************************
// **********Tower Element(GameObject, Creature)*************
// **********Tower Element(GameObject, Creature)************
// *********************************************************
struct WintergraspTowerData
@@ -764,7 +764,7 @@ struct WintergraspTowerData
uint8 nbObject; // Number of gameobjects spawned on this point
WintergraspObjectPositionData GameObject[6]; // Gameobject position and entry (Horde/Alliance)
// Creature : Turrets and Guard, TODO: check if killed on tower destruction? tower damage?
// Creature: Turrets and Guard /// @todo: Killed on Tower destruction ? Tower damage ? Requires confirming
uint8 nbCreatureBottom;
WintergraspObjectPositionData CreatureBottom[9];
uint8 nbCreatureTop;
@@ -1055,7 +1055,7 @@ const WGWorkshopData WorkshopsData[WG_MAX_WORKSHOP] =
};
// ********************************************************************
// * Structs using for Building, Graveyard, Workshop *
// * Structs using for Building, Graveyard, Workshop *
// ********************************************************************
// Structure for different buildings that can be destroyed during battle
struct BfWGGameObjectBuilding
src/server/game/Battlegrounds/Zones/BattlegroundAV.h
+14 -14
View File
@@ -53,7 +53,7 @@
#define AV_EVENT_START_BATTLE 9166 // Achievement: The Alterac Blitz
enum BG_AV_Sounds
{ //TODO: get out if there comes a sound when neutral team captures mine
{ /// @todo: get out if there comes a sound when neutral team captures mine
/*
8212:
@@ -86,7 +86,7 @@ horde:
horde wins
*/
AV_SOUND_NEAR_VICTORY = 8456, //not confirmed yet
AV_SOUND_NEAR_VICTORY = 8456, /// @todo: Not confirmed yet
AV_SOUND_ALLIANCE_ASSAULTS = 8212, //tower, grave + enemy boss if someone tries to attack him
AV_SOUND_HORDE_ASSAULTS = 8174,
@@ -104,7 +104,7 @@ enum BG_AV_OTHER_VALUES
AV_NORTH_MINE = 0,
AV_SOUTH_MINE = 1,
AV_MINE_TICK_TIMER = 45000,
AV_MINE_RECLAIM_TIMER = 1200000, //TODO: get the right value.. this is currently 20 minutes
AV_MINE_RECLAIM_TIMER = 1200000, /// @todo: get the right value.. this is currently 20 minutes
AV_NEUTRAL_TEAM = 0 //this is the neutral owner of snowfall
};
enum BG_AV_ObjectIds
@@ -547,7 +547,7 @@ enum BG_AV_CreaturePlace
AV_CPLACE_SPIRIT_FROST_HUT = 6,
AV_CPLACE_SPIRIT_MAIN_ALLIANCE = 7,
AV_CPLACE_SPIRIT_MAIN_HORDE = 8,
//i don't will add for all 4 positions a variable.. i think one is enough to compute the rest
//I don't add a variable for all 4 positions... I think one is enough to compute the rest
AV_CPLACE_DEFENSE_STORM_AID = 9,
AV_CPLACE_DEFEMSE_STORM_GRAVE = 13,
AV_CPLACE_DEFENSE_STONE_GRAVE = 17,
@@ -680,7 +680,7 @@ const float BG_AV_CreaturePos[AV_CPLACE_MAX][4] =
{575.411f, -83.597f, 52.3626f, 6.26573f},
{571.352f, -75.6582f, 52.479f, 0.523599f},
//dun north - OK
{668.60f, -122.53f, 64.12f, 2.34f}, //not 100% ok
{668.60f, -122.53f, 64.12f, 2.34f}, /// @todo: To be confirm - Not completely okay
{662.253f, -129.105f, 64.1794f, 2.77507f},
{661.209f, -138.877f, 64.2251f, 3.38594f},
{665.481f, -146.857f, 64.1271f, 3.75246f},
@@ -720,7 +720,7 @@ const float BG_AV_CreaturePos[AV_CPLACE_MAX][4] =
{723.058f, -14.1548f, 50.7046f, 3.40339f}, // north
{715.691f, -4.72233f, 50.2187f, 3.47321f}, // icewing
{720.046f, -19.9413f, 50.2187f, 3.36849f}, // stone
//horde (coords not 100% ok)
/// horde @todo: Confirm positions
{-1363.99f, -221.99f, 98.4053f, 4.93012f},
{-1370.96f, -223.532f, 98.4266f, 4.93012f},
{-1378.37f, -228.614f, 99.3546f, 5.38565f},
@@ -1039,14 +1039,14 @@ enum BG_AV_CreatureIds
};
//entry, team, minlevel, maxlevel
//TODO this array should be removed, the only needed things are the entrys (for spawning(?) and handlekillunit)
/// @todo: this array should be removed, the only needed things are the entrys (for spawning(?) and handlekillunit)
const uint32 BG_AV_CreatureInfo[AV_NPC_INFO_MAX][4] =
{
{ 12050, 1216, 58, 58 }, //Stormpike Defender
{ 13326, 1216, 59, 59 }, //Seasoned Defender
{ 13331, 1216, 60, 60 }, //Veteran Defender
{ 13422, 1216, 61, 61 }, //Champion Defender
{ 13358, 1216, 59, 60 }, //Stormpike Bowman //i think its 60, 61 and 69, 70.. but this is until now not possible TODO look if this is ok
{ 13358, 1216, 59, 60 }, //Stormpike Bowman /// @todo: Confirm if this is correct. Author assumpted 60,61 & 69,70, but wouldn't work here
{ 11949, 469, 0, 0}, //not spawned with this data, but used for handlekillunit
{ 11948, 469, 0, 0}, //not spawned with this data, but used for handlekillunit
{ 12053, 1214, 58, 58 }, //Frostwolf Guardian
@@ -1071,7 +1071,7 @@ const uint32 BG_AV_CreatureInfo[AV_NPC_INFO_MAX][4] =
{ 11602, 59, 54, 55 }, //Irondeep Skullthumper
{ 11657, 59, 58, 58 }, //Morloch
{13396, 469, 52, 53}, //irondeep alliance TODO: get the right ids
{13396, 469, 52, 53}, // irondeep alliance /// @todo: Correct and give correct ids
{13080, 469, 53, 54},
{13098, 469, 54, 55},
{13078, 469, 58, 58},
@@ -1246,7 +1246,7 @@ const uint32 BG_AV_StaticCreatureInfo[51][4] =
{ 11675, 514, 53, 53 }, //Snowblind Windcaller
{ 11678, 14, 52, 53 }, //Snowblind Ambusher
{ 11839, 39, 56, 56 }, //Wildpaw Brute
{ 11947, 1214, 61, 61 }, //Captain Galvangar --TODO: doubled
{ 11947, 1214, 61, 61 }, // Captain Galvangar /// @todo: Duplicate ? Check and confirm
{ 11948, 1216, 63, 63 }, //Vanndar Stormpike
{ 11949, 1216, 61, 61 }, //Captain Balinda Stonehearth
{ 11997, 1334, 60, 60 }, //Stormpike Herald
@@ -1277,7 +1277,7 @@ const uint32 BG_AV_StaticCreatureInfo[51][4] =
{ 14282, 1214, 53, 54 }, //Frostwolf Bloodhound
{ 14283, 1216, 53, 54 }, //Stormpike Owl
{ 14284, 1216, 61, 61 }, //Stormpike Battleguard
{ 11946, 1214, 63, 63 }, //Drek'Thar //TODO: make the levels right (boss=0 maybe)
{ 11946, 1214, 63, 63 }, //Drek'Thar /// @todo: Correct the level (Level 80 for boss ?)
{ 11948, 1216, 63, 63 }, //Vanndar Stormpike
{ 11947, 1214, 61, 61 }, //Captain Galvangar
{ 11949, 1216, 61, 61 } //Captain Balinda Stonehearth
@@ -1310,7 +1310,7 @@ const uint32 BG_AV_GraveyardIds[9]=
};
enum BG_AV_BUFF
{ //TODO add all other buffs here
{ /// @todo: Add all other buffs here
AV_BUFF_ARMOR = 21163,
AV_BUFF_A_CAPTAIN = 23693, //the buff which the alliance captain does
AV_BUFF_H_CAPTAIN = 22751 //the buff which the horde captain does
@@ -1607,7 +1607,7 @@ class BattlegroundAV : public Battleground
/*general */
Creature* AddAVCreature(uint16 cinfoid, uint16 type);
uint16 GetBonusHonor(uint8 kills); //TODO remove this when the core handles this right
uint16 GetBonusHonor(uint8 kills); /// @todo: Remove this when the core handles this properly
/*variables */
int32 m_Team_Scores[2];
@@ -1622,7 +1622,7 @@ class BattlegroundAV : public Battleground
uint32 m_CaptainBuffTimer[2];
bool m_CaptainAlive[2];
uint8 m_MaxLevel; //TODO remove this when battleground-getmaxlevel() returns something usefull
uint8 m_MaxLevel; /// @todo: Remove this once battleground->getmaxlevel() returns something usefull/is reworked (?)
bool m_IsInformedNearVictory[2];
};
src/server/game/Entities/Creature/Creature.h
+6 -8
View File
@@ -169,7 +169,7 @@ struct CreatureTemplate
typedef UNORDERED_MAP<uint32, CreatureTemplate> CreatureTemplateContainer;
// Represents max amount of expansions.
// TODO: Add MAX_EXPANSION constant.
/// @todo: Add MAX_EXPANSION constant.
#define MAX_CREATURE_BASE_HP 3
// GCC have alternative #pragma pack(N) syntax and old gcc version not support pack(push, N), also any gcc version not support it at some platform
@@ -484,15 +484,13 @@ class Creature : public Unit, public GridObject<Creature>, public MapCreature
SetReactState(REACT_DEFENSIVE);*/;
}
///// TODO RENAME THIS!!!!!
/// @todo Rename these properly
bool isCanTrainingOf(Player* player, bool msg) const;
bool isCanInteractWithBattleMaster(Player* player, bool msg) const;
bool isCanTrainingAndResetTalentsOf(Player* player) const;
bool canCreatureAttack(Unit const* victim, bool force = true) const;
bool IsImmunedToSpell(SpellInfo const* spellInfo);
// redefine Unit::IsImmunedToSpell
bool IsImmunedToSpellEffect(SpellInfo const* spellInfo, uint32 index) const;
// redefine Unit::IsImmunedToSpellEffect
bool IsImmunedToSpell(SpellInfo const* spellInfo); //override Unit::IsImmunedToSpell
bool IsImmunedToSpellEffect(SpellInfo const* spellInfo, uint32 index) const; //override Unit::IsImmunedToSpellEffect
bool isElite() const
{
if (isPet())
@@ -772,10 +770,10 @@ class Creature : public Unit, public GridObject<Creature>, public MapCreature
bool DisableReputationGain;
CreatureTemplate const* m_creatureInfo; // in difficulty mode > 0 can different from sObjectMgr->GetCreatureTemplate(GetEntry())
CreatureTemplate const* m_creatureInfo; // Can differ from sObjectMgr->GetCreatureTemplate(GetEntry()) in difficulty mode > 0
CreatureData const* m_creatureData;
uint16 m_LootMode; // bitmask, default LOOT_MODE_DEFAULT, determines what loot will be lootable
uint16 m_LootMode; // Bitmask (default: LOOT_MODE_DEFAULT) that determines what loot will be lootable
uint32 guid_transport;
bool IsInvisibleDueToDespawn() const;
src/server/game/Entities/Item/ItemPrototype.h
+2 -7
View File
@@ -102,10 +102,8 @@ enum ItemBondingType
#define MAX_BIND_TYPE 6
/* TODO
// need to know cases when using item is not allowed in shapeshift
ITEM_PROTO_FLAG_USABLE_WHEN_SHAPESHIFTED = 0x00800000, // Item can be used in shapeshift forms
*/
/* /// @todo: Requiring actual cases in which using (an) item isn't allowed while shapeshifted. Else, this flag would need an implementation.
ITEM_PROTO_FLAG_USABLE_WHEN_SHAPESHIFTED = 0x00800000, // Item can be used in shapeshift forms */
enum ItemProtoFlags
{
@@ -143,9 +141,6 @@ enum ItemProtoFlags
ITEM_PROTO_FLAG_UNK12 = 0x80000000 // ?
};
/* TODO
*/
enum ItemFieldFlags
{
ITEM_FLAG_SOULBOUND = 0x00000001, // Item is soulbound and cannot be traded <<--
src/server/game/Entities/Player/Player.h
+5
View File
@@ -1189,10 +1189,15 @@ class Player : public Unit, public GridObject<Player>
void RemovePet(Pet* pet, PetSaveMode mode, bool returnreagent = false);
uint32 GetPhaseMaskForSpawn() const; // used for proper set phase for DB at GM-mode creature/GO spawn
/// Handles said message in regular chat based on declared language and in config pre-defined Range.
void Say(std::string const& text, const uint32 language);
/// Handles yelled message in regular chat based on declared language and in config pre-defined Range.
void Yell(std::string const& text, const uint32 language);
/// Outputs an universal text which is supposed to be an action.
void TextEmote(std::string const& text);
/// Handles whispers from Addons and players based on sender, receiver's guid and language.
void Whisper(std::string const& text, const uint32 language, uint64 receiver);
/// Constructs the player Chat data for the specific functions to use
void BuildPlayerChat(WorldPacket* data, uint8 msgtype, std::string const& text, uint32 language) const;
/*********************************************************/
src/server/game/Globals/ObjectAccessor.h
+1 -1
View File
@@ -90,7 +90,7 @@ class ObjectAccessor
ObjectAccessor& operator=(const ObjectAccessor&);
public:
// TODO: override these template functions for each holder type and add assertions
/// @todo: Override these template functions for each holder type and add assertions
template<class T> static T* GetObjectInOrOutOfWorld(uint64 guid, T* /*typeSpecifier*/)
{
src/server/game/Instances/InstanceSaveMgr.h
+2 -2
View File
@@ -101,8 +101,8 @@ class InstanceSave
private:
bool UnloadIfEmpty();
/* the only reason the instSave-object links are kept is because
the object-instSave links need to be broken at reset time
TODO: maybe it's enough to just store the number of players/groups */
the object-instSave links need to be broken at reset time */
/// @todo: Check if maybe it's enough to just store the number of players/groups
PlayerListType m_playerList;
GroupListType m_groupList;
time_t m_resetTime;