mirror of
https://github.com/mod-playerbots/mod-playerbots.git
synced 2026-01-13 17:09:08 +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.
159 lines
5.5 KiB
C++
159 lines
5.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 "GenericDruidStrategy.h"
|
|
|
|
#include "Playerbots.h"
|
|
|
|
class GenericDruidStrategyActionNodeFactory : public NamedObjectFactory<ActionNode>
|
|
{
|
|
public:
|
|
GenericDruidStrategyActionNodeFactory()
|
|
{
|
|
creators["melee"] = &melee;
|
|
creators["caster form"] = &caster_form;
|
|
creators["cure poison"] = &cure_poison;
|
|
creators["cure poison on party"] = &cure_poison_on_party;
|
|
creators["abolish poison"] = &abolish_poison;
|
|
creators["abolish poison on party"] = &abolish_poison_on_party;
|
|
creators["rebirth"] = &rebirth;
|
|
creators["entangling roots on cc"] = &entangling_roots_on_cc;
|
|
creators["innervate"] = &innervate;
|
|
}
|
|
|
|
private:
|
|
static ActionNode* melee([[maybe_unused]] PlayerbotAI* botAI)
|
|
{
|
|
return new ActionNode("melee",
|
|
/*P*/ {},
|
|
/*A*/ {},
|
|
/*C*/ {});
|
|
}
|
|
|
|
static ActionNode* caster_form([[maybe_unused]] PlayerbotAI* botAI)
|
|
{
|
|
return new ActionNode("caster form",
|
|
/*P*/ {},
|
|
/*A*/ {},
|
|
/*C*/ {});
|
|
}
|
|
|
|
static ActionNode* cure_poison([[maybe_unused]] PlayerbotAI* botAI)
|
|
{
|
|
return new ActionNode("cure poison",
|
|
/*P*/ {},
|
|
/*A*/ {},
|
|
/*C*/ {});
|
|
}
|
|
|
|
static ActionNode* cure_poison_on_party([[maybe_unused]] PlayerbotAI* botAI)
|
|
{
|
|
return new ActionNode("cure poison on party",
|
|
/*P*/ {},
|
|
/*A*/ {},
|
|
/*C*/ {});
|
|
}
|
|
|
|
static ActionNode* abolish_poison([[maybe_unused]] PlayerbotAI* botAI)
|
|
{
|
|
return new ActionNode("abolish poison",
|
|
/*P*/ {},
|
|
/*A*/ {},
|
|
/*C*/ {});
|
|
}
|
|
|
|
static ActionNode* abolish_poison_on_party([[maybe_unused]] PlayerbotAI* botAI)
|
|
{
|
|
return new ActionNode("abolish poison on party",
|
|
/*P*/ {},
|
|
/*A*/ {},
|
|
/*C*/ {});
|
|
}
|
|
|
|
static ActionNode* rebirth([[maybe_unused]] PlayerbotAI* botAI)
|
|
{
|
|
return new ActionNode("rebirth",
|
|
/*P*/ {},
|
|
/*A*/ {},
|
|
/*C*/ {});
|
|
}
|
|
|
|
static ActionNode* entangling_roots_on_cc([[maybe_unused]] PlayerbotAI* botAI)
|
|
{
|
|
return new ActionNode("entangling roots on cc",
|
|
/*P*/ { NextAction("caster form") },
|
|
/*A*/ {},
|
|
/*C*/ {});
|
|
}
|
|
|
|
static ActionNode* innervate([[maybe_unused]] PlayerbotAI* botAI)
|
|
{
|
|
return new ActionNode("innervate",
|
|
/*P*/ {},
|
|
/*A*/ { NextAction("mana potion") },
|
|
/*C*/ {});
|
|
}
|
|
};
|
|
|
|
GenericDruidStrategy::GenericDruidStrategy(PlayerbotAI* botAI) : CombatStrategy(botAI)
|
|
{
|
|
actionNodeFactories.Add(new GenericDruidStrategyActionNodeFactory());
|
|
}
|
|
|
|
void GenericDruidStrategy::InitTriggers(std::vector<TriggerNode*>& triggers)
|
|
{
|
|
CombatStrategy::InitTriggers(triggers);
|
|
|
|
triggers.push_back(
|
|
new TriggerNode("low health", { NextAction("barkskin", ACTION_HIGH + 7) }));
|
|
|
|
triggers.push_back(new TriggerNode("combat party member dead",
|
|
{ NextAction("rebirth", ACTION_HIGH + 9) }));
|
|
triggers.push_back(new TriggerNode("being attacked",
|
|
{ NextAction("nature's grasp", ACTION_HIGH + 1) }));
|
|
triggers.push_back(new TriggerNode("new pet", { NextAction("set pet stance", 60.0f) }));
|
|
}
|
|
|
|
void DruidCureStrategy::InitTriggers(std::vector<TriggerNode*>& triggers)
|
|
{
|
|
triggers.push_back(
|
|
new TriggerNode("party member cure poison",
|
|
{ NextAction("abolish poison on party", ACTION_DISPEL + 1) }));
|
|
|
|
triggers.push_back(
|
|
new TriggerNode("party member remove curse",
|
|
{ NextAction("remove curse on party", ACTION_DISPEL + 7) }));
|
|
|
|
}
|
|
|
|
void DruidBoostStrategy::InitTriggers(std::vector<TriggerNode*>& triggers)
|
|
{
|
|
triggers.push_back(new TriggerNode(
|
|
"nature's swiftness", { NextAction("nature's swiftness", ACTION_HIGH + 9) }));
|
|
}
|
|
|
|
void DruidCcStrategy::InitTriggers(std::vector<TriggerNode*>& triggers)
|
|
{
|
|
triggers.push_back(new TriggerNode(
|
|
"entangling roots", { NextAction("entangling roots on cc", ACTION_HIGH + 2) }));
|
|
triggers.push_back(new TriggerNode(
|
|
"entangling roots kite", { NextAction("entangling roots", ACTION_HIGH + 2) }));
|
|
triggers.push_back(new TriggerNode(
|
|
"hibernate", { NextAction("hibernate on cc", ACTION_HIGH + 3) }));
|
|
}
|
|
|
|
void DruidHealerDpsStrategy::InitTriggers(std::vector<TriggerNode*>& triggers)
|
|
{
|
|
triggers.push_back(
|
|
new TriggerNode("healer should attack",
|
|
{
|
|
NextAction("cancel tree form", ACTION_DEFAULT + 0.3f),
|
|
NextAction("moonfire", ACTION_DEFAULT + 0.2f),
|
|
NextAction("wrath", ACTION_DEFAULT + 0.1f),
|
|
NextAction("starfire", ACTION_DEFAULT),
|
|
}));
|
|
|
|
}
|