diff options
| author | Nefarion <nefarion123@gmail.com> | 2013-03-08 21:41:30 +0100 |
|---|---|---|
| committer | Nefarion <nefarion123@gmail.com> | 2013-03-08 21:55:37 +0100 |
| commit | 49fd11ab5aebcbce86ca2ee48711287cf020d798 (patch) | |
| tree | 8086b6f797c80dbf09edd8f41c1c79912838e3b6 /src/server/game/Entities/Player | |
| parent | 2dbe3d6cfe2d174b5edf9fdb6720fee21c7009d2 (diff) | |
First step of comment style refactoring to doxygen-style.
Diffstat (limited to 'src/server/game/Entities/Player')
| -rw-r--r-- | src/server/game/Entities/Player/Player.cpp | 42 |
1 files changed, 21 insertions, 21 deletions
diff --git a/src/server/game/Entities/Player/Player.cpp b/src/server/game/Entities/Player/Player.cpp index 7447868d763..e9f1af5595a 100644 --- a/src/server/game/Entities/Player/Player.cpp +++ b/src/server/game/Entities/Player/Player.cpp @@ -932,7 +932,7 @@ void Player::CleanupsBeforeDelete(bool finalCleanup) bool Player::Create(uint32 guidlow, CharacterCreateInfo* createInfo) { //FIXME: outfitId not used in player creating - // TODO: need more checks against packet modifications + /// @todo need more checks against packet modifications // should check that skin, face, hair* are valid via DBC per race/class // also do it in Player::BuildEnumData, Player::LoadFromDB @@ -1040,7 +1040,7 @@ bool Player::Create(uint32 guidlow, CharacterCreateInfo* createInfo) SetFlag(PLAYER_EXPLORED_ZONES_1+i, 0xFFFFFFFF); } - //Reputations if "StartAllReputation" is enabled, -- TODO: Fix this in a better way + //Reputations if "StartAllReputation" is enabled, -- @todo Fix this in a better way if (sWorld->getBoolConfig(CONFIG_START_ALL_REP)) { GetReputationMgr().SetReputation(sFactionStore.LookupEntry(942), 42999); @@ -1376,7 +1376,7 @@ void Player::HandleDrowning(uint32 time_diff) { m_MirrorTimer[BREATH_TIMER]+= 1*IN_MILLISECONDS; // Calculate and deal damage - // TODO: Check this formula + /// @todo Check this formula uint32 damage = GetMaxHealth() / 5 + urand(0, getLevel()-1); EnvironmentalDamage(DAMAGE_DROWNING, damage); } @@ -1445,7 +1445,7 @@ void Player::HandleDrowning(uint32 time_diff) { m_MirrorTimer[FIRE_TIMER]+= 1*IN_MILLISECONDS; // Calculate and deal damage - // TODO: Check this formula + /// @todo Check this formula uint32 damage = urand(600, 700); if (m_MirrorTimerFlags & UNDERWATER_INLAVA) EnvironmentalDamage(DAMAGE_LAVA, damage); @@ -1621,7 +1621,7 @@ void Player::Update(uint32 p_time) if (Unit* victim = getVictim()) { // default combat reach 10 - // TODO add weapon, skill check + /// @todo add weapon, skill check if (isAttackReady(BASE_ATTACK)) { @@ -2506,7 +2506,7 @@ void Player::Regenerate(Powers power) uint32 curValue = GetPower(power); - // TODO: possible use of miscvalueb instead of amount + /// @todo possible use of miscvalueb instead of amount if (HasAuraTypeWithValue(SPELL_AURA_PREVENT_REGENERATE_POWER, power)) return; @@ -2762,7 +2762,7 @@ GameObject* Player::GetGameObjectIfCanInteractWith(uint64 guid, GameobjectTypes float maxdist; switch (type) { - // TODO: find out how the client calculates the maximal usage distance to spellless working + /// @todo find out how the client calculates the maximal usage distance to spellless working // gameobjects like guildbanks and mailboxes - 10.0 is a just an abitrary choosen number case GAMEOBJECT_TYPE_GUILD_BANK: case GAMEOBJECT_TYPE_MAILBOX: @@ -2801,7 +2801,7 @@ void Player::SetInWater(bool apply) //move player's guid into HateOfflineList of those mobs //which can't swim and move guid back into ThreatList when //on surface. - //TODO: exist also swimming mobs, and function must be symmetric to enter/leave water + /// @todo exist also swimming mobs, and function must be symmetric to enter/leave water m_isInWater = apply; // remove auras that need water/land @@ -2914,7 +2914,7 @@ bool Player::IsInSameRaidWith(Player const* p) const } ///- If the player is invited, remove him. If the group if then only 1 person, disband the group. -/// \todo Shouldn't we also check if there is no other invitees before disbanding the group? +/// @todo Shouldn't we also check if there is no other invitees before disbanding the group? void Player::UninviteFromGroup() { Group* group = GetGroupInvite(); @@ -3103,7 +3103,7 @@ void Player::GiveLevel(uint8 level) if (MailLevelReward const* mailReward = sObjectMgr->GetMailLevelReward(level, getRaceMask())) { - //- TODO: Poor design of mail system + /// @todo Poor design of mail system SQLTransaction trans = CharacterDatabase.BeginTransaction(); MailDraft(mailReward->mailTemplateId).SendMailTo(trans, this, MailSender(MAIL_CREATURE, mailReward->senderEntry)); CharacterDatabase.CommitTransaction(trans); @@ -5824,7 +5824,7 @@ void Player::GetDodgeFromAgility(float &diminishing, float &nondiminishing) if (dodgeRatio == NULL || pclass > MAX_CLASSES) return; - // TODO: research if talents/effects that increase total agility by x% should increase non-diminishing part + /// @todo research if talents/effects that increase total agility by x% should increase non-diminishing part float base_agility = GetCreateStat(STAT_AGILITY) * m_auraModifiersGroup[UNIT_MOD_STAT_START + STAT_AGILITY][BASE_PCT]; float bonus_agility = GetStat(STAT_AGILITY) - base_agility; @@ -8769,7 +8769,7 @@ void Player::SendLoot(uint64 guid, LootType loot_type) { uint32 lootid = go->GetGOInfo()->GetLootId(); - //TODO: fix this big hack + /// @todo fix this big hack if ((go->GetEntry() == BG_AV_OBJECTID_MINE_N || go->GetEntry() == BG_AV_OBJECTID_MINE_S)) if (Battleground* bg = GetBattleground()) if (bg->GetTypeID(true) == BATTLEGROUND_AV) @@ -11902,7 +11902,7 @@ InventoryResult Player::CanUseItem(Item* pItem, bool not_loading) const // Armor that is binded to account can "morph" from plate to mail, etc. if skill is not learned yet. if (pProto->Quality == ITEM_QUALITY_HEIRLOOM && pProto->Class == ITEM_CLASS_ARMOR && !HasSkill(itemSkill)) { - // TODO: when you right-click already equipped item it throws EQUIP_ERR_NO_REQUIRED_PROFICIENCY. + /// @todo when you right-click already equipped item it throws EQUIP_ERR_NO_REQUIRED_PROFICIENCY. // In fact it's a visual bug, everything works properly... I need sniffs of operations with // binded to account items from off server. @@ -13692,7 +13692,7 @@ void Player::AddTradeableItem(Item* item) m_itemSoulboundTradeable.push_back(item); } -//TODO: should never allow an item to be added to m_itemSoulboundTradeable twice +/// @todo should never allow an item to be added to m_itemSoulboundTradeable twice void Player::RemoveTradeableItem(Item* item) { m_itemSoulboundTradeable.remove(item); @@ -14747,7 +14747,7 @@ void Player::SendPreparedQuest(uint64 guid) else if (icon == 4) PlayerTalkClass->SendQuestGiverRequestItems(quest, guid, CanRewardQuest(quest, false), true); // Send completable on repeatable and autoCompletable quest if player don't have quest - // TODO: verify if check for !quest->IsDaily() is really correct (possibly not) + /// @todo verify if check for !quest->IsDaily() is really correct (possibly not) else { Object* object = ObjectAccessor::GetObjectByTypeMask(*this, guid, TYPEMASK_UNIT | TYPEMASK_GAMEOBJECT | TYPEMASK_ITEM); @@ -15284,7 +15284,7 @@ void Player::RewardQuest(Quest const* quest, uint32 reward, Object* questGiver, // Send reward mail if (uint32 mail_template_id = quest->GetRewMailTemplateId()) { - //- TODO: Poor design of mail system + /// @todo Poor design of mail system SQLTransaction trans = CharacterDatabase.BeginTransaction(); MailDraft(mail_template_id).SendMailTo(trans, this, questGiver, MAIL_CHECK_MASK_HAS_BODY, quest->GetRewMailDelaySecs()); CharacterDatabase.CommitTransaction(trans); @@ -17750,7 +17750,7 @@ void Player::_LoadInventory(PreparedQueryResult result, uint32 timeDiff) //NOTE: the "order by `bag`" is important because it makes sure //the bagMap is filled before items in the bags are loaded //NOTE2: the "order by `slot`" is needed because mainhand weapons are (wrongly?) - //expected to be equipped before offhand items (TODO: fixme) + //expected to be equipped before offhand items (@todo fixme) if (result) { @@ -20696,7 +20696,7 @@ void Player::RestoreSpellMods(Spell* spell, uint32 ownerAuraId, Aura* aura) mod->charges = mod->ownerAura->GetCharges(); // Skip this check for now - aura charges may change due to various reason - // TODO: trac these changes correctly + /// @todo trac these changes correctly //ASSERT (mod->ownerAura->GetCharges() <= mod->charges); } } @@ -21551,7 +21551,7 @@ void Player::UpdateHomebindTime(uint32 time) void Player::UpdatePvPState(bool onlyFFA) { - // TODO: should we always synchronize UNIT_FIELD_BYTES_2, 1 of controller and controlled? + /// @todo should we always synchronize UNIT_FIELD_BYTES_2, 1 of controller and controlled? // no, we shouldn't, those are checked for affecting player by client if (!pvpInfo.IsInNoPvPArea && !isGameMaster() && (pvpInfo.IsInFFAPvPArea || sWorld->IsFFAPvPRealm())) @@ -23825,7 +23825,7 @@ PartyResult Player::CanUninviteFromGroup() const if (grp->isRollLootActive()) return ERR_PARTY_LFG_BOOT_LOOT_ROLLS; - // TODO: Should also be sent when anyone has recently left combat, with an aprox ~5 seconds timer. + /// @todo Should also be sent when anyone has recently left combat, with an aprox ~5 seconds timer. for (GroupReference const* itr = grp->GetFirstMember(); itr != NULL; itr = itr->next()) if (itr->getSource() && itr->getSource()->isInCombat()) return ERR_PARTY_LFG_BOOT_IN_COMBAT; @@ -25913,7 +25913,7 @@ bool Player::AddItem(uint32 itemId, uint32 count) if (count == 0 || dest.empty()) { - // -- TODO: Send to mailbox if no space + /// @todo Send to mailbox if no space ChatHandler(GetSession()).PSendSysMessage("You don't have any space in your bags."); return false; } |
