Creature: add DoCleaveAttack

CHANGELOG.md

@@ -16,6 +16,7 @@ https://github.com/nwnxee/unified/compare/build8193.35.37...HEAD
 
 ##### New NWScript Functions
 - Util: GetStringLevenshteinDistance()
+- Creature: DoCleaveAttack()
 - Creature: {Get|Set}LockOrientationToObject()
 - Creature: BroadcastAttackOfOpportunity()
 

Plugins/Creature/Creature.cpp

@@ -3305,6 +3305,35 @@ NWNX_EXPORT ArgumentStack SetMaximumBonusAttacks(ArgumentStack&& args)
     return {};
 }
 
+NWNX_EXPORT ArgumentStack DoCleaveAttack(ArgumentStack&& args)
+{
+    if (auto *pCreature = Utils::PopCreature(args))
+    {
+        auto *pCombatRound = pCreature->m_pcCombatRound;
+
+        if (pCombatRound->GetTotalAttacks() < 50)
+        {
+            bool bHasGreatCleave = pCreature->m_pStats->HasFeat(Constants::Feat::GreatCleave);
+            if (bHasGreatCleave || (pCreature->m_pStats->HasFeat(Constants::Feat::Cleave) && pCombatRound->m_nCleaveAttacks > 0))
+            {
+                float fAttackRange = pCreature->MaxAttackRange(pCreature->m_idSelf, false, true);
+                auto oidNearestEnemy = pCreature->GetNearestEnemy(fAttackRange, pCreature->m_oidAttackTarget, true, false);
+                if (oidNearestEnemy != Constants::OBJECT_INVALID)
+                {
+                    pCombatRound->m_oidNewAttackTarget = oidNearestEnemy;
+                    pCombatRound->AddCleaveAttack(oidNearestEnemy, bHasGreatCleave);
+                    pCreature->m_bPassiveAttackBehaviour = 1;
+
+                    if (!bHasGreatCleave)
+                        pCombatRound->m_nCleaveAttacks--;
+                }
+            }
+        }
+    }
+
+    return {};
+}
+
 NWNX_EXPORT ArgumentStack GetLockOrientationToObject(ArgumentStack&& args)
 {
     ObjectID retval = Constants::OBJECT_INVALID;

Plugins/Creature/NWScript/nwnx_creature.nss

@@ -953,6 +953,11 @@ int NWNX_Creature_GetMaximumBonusAttacks(object oCreature);
 /// @note Persistence is enabled after a server reset by the first use of this function. Recommended to trigger on a dummy target OnModuleLoad to enable persistence.
 void NWNX_Creature_SetMaximumBonusAttacks(object oCreature, int nMaxBonusAttacks, int bPersist = FALSE);
 
+/// @brief Inserts a cleave or great cleave attack into oCreature's current attack round against the nearest enemy within melee reach.
+/// @param oCreature The creature object.
+/// @note oCreature must have the cleave or great cleave feats, must be in combat, and must have available attacks remaining in their combat round to use for cleave attack.
+void NWNX_Creature_DoCleaveAttack(object oCreature);
+
 /// @brief Gets the current object oCreature's orientation is locked to.
 /// @param oCreature The creature object.
 /// @return The object oCreature's orientation is locked to, or OBJECT_INVALID if oCreature's orientation is not locked.
@@ -2483,6 +2488,14 @@ void NWNX_Creature_SetMaximumBonusAttacks(object oCreature, int nMaxBonusAttacks
     NWNX_CallFunction(NWNX_Creature, sFunc);
 }
 
+void NWNX_Creature_DoCleaveAttack(object oCreature)
+{
+    string sFunc = "DoCleaveAttack";
+
+    NWNX_PushArgumentObject(oCreature);
+    NWNX_CallFunction(NWNX_Creature, sFunc);
+}
+
 object NWNX_Creature_GetLockOrientationToObject(object oCreature)
 {
     string sFunc = "GetLockOrientationToObject";