mirror of
https://github.com/mod-playerbots/mod-playerbots.git
synced 2026-01-15 09:50:27 +00:00
c9cc4324d3
<!-- > [!WARNING] > **This is a DRAFT PR.** > The structure is not definitive. The code might not be optimised yet. It might not even start nor compile yet. > **Don't panic. ✋ It's going to be ok. 👌 We can make modifications, we can fix things.** 😁 --> # Description This PR aims to refactor the NextAction declaration to achieve two goals: ## Eliminate C-style sentinel arrays Currently, a double pointer (`NextAction**`) approach is being used. This an old pre-C++11 (< 2011) trick before `std::vector<>` became a thing. This approach is painful for developers because they constantly need to declare their `NextAction` arrays as: ```cpp NextAction::array(0, new NextAction("foo", 1.0f), nullptr) ``` Instead of: ```cpp { new NextAction("foo", 1.0f) } ``` The first argument of `NextAction::array` is actually a hack. It is used to have a named argument so `va_args` can find the remaining arguments. It is set to 0 everywhere but in fact does nothing. This is very confusing to people unfamiliar with this antiquated syntax. The last argument `nullptr` is what we call a sentinel. It's a `nullptr` because `va_args` is looking for a `nullptr` to stop iterating. It's also a hack and also leads to confusion. ## Eliminate unnecessary pointers for `NextAction` Pointers can be used for several reasons, to cite a few: - Indicate strong, absolute identity. - Provide strong but transferable ownership (unlike references). - When a null value is acceptable (`nullptr`). - When copy is expensive. `NextAction` meets none of these criteria: - It has no identity because it is purely behavioural. - It is never owned by anything as it is passed around and never fetched from a registry. - The only situations where it can be `nullptr` are errors that should in fact throw an `std::invalid_argument` instead. - They are extremely small objects that embark a single `std::string` and a single `float`. Pointers should be avoided when not strictly necessary because they can quickly lead to undefined behaviour due to unhandled `nullptr` situations. They also make the syntax heavier due to the necessity to constantly check for `nullptr`. Finally, they aren't even good for performance in that situation because shifting a pointer so many times is likely more expensive than copying such a trivial object. # End goal The end goal is to declare `NextAction` arrays this way: ```cpp { NextAction("foo", 1.0f) } ``` > [!NOTE] > Additional note: `NextAction` is nothing but a hacky proxy to an `Action` constructor. This should eventually be reworked to use handles instead of strings. This would make copying `NextAction` even cheaper and remove the need for the extremely heavy stringly typed current approach. Stringly typed entities are a known anti-pattern so we need to move on from those.
110 lines
3.5 KiB
C++
110 lines
3.5 KiB
C++
/*
|
|
* Copyright (C) 2016+ AzerothCore <www.azerothcore.org>, released under GNU AGPL v3 license, you may redistribute it
|
|
* and/or modify it under version 3 of the License, or (at your option), any later version.
|
|
*/
|
|
|
|
#include "DruidActions.h"
|
|
|
|
#include "Event.h"
|
|
#include "Playerbots.h"
|
|
#include "ServerFacade.h"
|
|
#include "AoeValues.h"
|
|
#include "TargetValue.h"
|
|
|
|
std::vector<NextAction> CastAbolishPoisonAction::getAlternatives()
|
|
{
|
|
return NextAction::merge({ NextAction("cure poison") },
|
|
CastSpellAction::getPrerequisites());
|
|
}
|
|
|
|
std::vector<NextAction> CastAbolishPoisonOnPartyAction::getAlternatives()
|
|
{
|
|
return NextAction::merge({ NextAction("cure poison on party") },
|
|
CastSpellAction::getPrerequisites());
|
|
}
|
|
|
|
Value<Unit*>* CastEntanglingRootsCcAction::GetTargetValue()
|
|
{
|
|
return context->GetValue<Unit*>("cc target", "entangling roots");
|
|
}
|
|
|
|
bool CastEntanglingRootsCcAction::Execute(Event event) { return botAI->CastSpell("entangling roots", GetTarget()); }
|
|
|
|
Value<Unit*>* CastHibernateCcAction::GetTargetValue() { return context->GetValue<Unit*>("cc target", "hibernate"); }
|
|
|
|
bool CastHibernateCcAction::Execute(Event event) { return botAI->CastSpell("hibernate", GetTarget()); }
|
|
bool CastStarfallAction::isUseful()
|
|
{
|
|
if (!CastSpellAction::isUseful())
|
|
return false;
|
|
|
|
// Avoid breaking CC
|
|
WorldLocation aoePos = *context->GetValue<WorldLocation>("aoe position");
|
|
Unit* ccTarget = context->GetValue<Unit*>("current cc target")->Get();
|
|
if (ccTarget && ccTarget->IsAlive())
|
|
{
|
|
float dist2d = sServerFacade->GetDistance2d(ccTarget, aoePos.GetPositionX(), aoePos.GetPositionY());
|
|
if (sServerFacade->IsDistanceLessOrEqualThan(dist2d, sPlayerbotAIConfig->aoeRadius))
|
|
return false;
|
|
}
|
|
|
|
// Avoid single-target usage on initial pull
|
|
uint8 aoeCount = *context->GetValue<uint8>("aoe count");
|
|
if (aoeCount < 2)
|
|
{
|
|
Unit* target = context->GetValue<Unit*>("current target")->Get();
|
|
if (!target || (!botAI->HasAura("moonfire", target) && !botAI->HasAura("insect swarm", target)))
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
std::vector<NextAction> CastReviveAction::getPrerequisites()
|
|
{
|
|
return NextAction::merge({ NextAction("caster form") },
|
|
ResurrectPartyMemberAction::getPrerequisites());
|
|
}
|
|
|
|
std::vector<NextAction> CastRebirthAction::getPrerequisites()
|
|
{
|
|
return NextAction::merge({ NextAction("caster form") },
|
|
ResurrectPartyMemberAction::getPrerequisites());
|
|
}
|
|
|
|
bool CastRebirthAction::isUseful()
|
|
{
|
|
return CastSpellAction::isUseful() &&
|
|
AI_VALUE2(float, "distance", GetTargetName()) <= sPlayerbotAIConfig->spellDistance;
|
|
}
|
|
|
|
Unit* CastRejuvenationOnNotFullAction::GetTarget()
|
|
{
|
|
Group* group = bot->GetGroup();
|
|
MinValueCalculator calc(100);
|
|
for (GroupReference* gref = group->GetFirstMember(); gref; gref = gref->next())
|
|
{
|
|
Player* player = gref->GetSource();
|
|
if (!player)
|
|
continue;
|
|
if (player->isDead() || player->IsFullHealth())
|
|
{
|
|
continue;
|
|
}
|
|
if (player->GetDistance2d(bot) > sPlayerbotAIConfig->spellDistance)
|
|
{
|
|
continue;
|
|
}
|
|
if (botAI->HasAura("rejuvenation", player))
|
|
{
|
|
continue;
|
|
}
|
|
calc.probe(player->GetHealthPct(), player);
|
|
}
|
|
return (Unit*)calc.param;
|
|
}
|
|
|
|
bool CastRejuvenationOnNotFullAction::isUseful()
|
|
{
|
|
return GetTarget();
|
|
} |