ReinforcingState Class Reference

Squad moves towards nearby friendly squads being attacked. Once no nearby squads are being attacked or the squad moves too far away from its defensive position (MAX_REINFORCE_DIST defined in SquadStateTypes.h), the squad returns to its defensive state and position. More...

#include <SquadStateTypes.h>

Inheritance diagram for ReinforcingState:

Public Member Functions
void	Enter (Squad *squad)
	Adds squad to ReinforcingSquads vector in CombatManager.
void	Update (Squad *squad)
	Every frame, checks if the reinforce position sent to it by StrategyManager is within range (distance < MAX_REINFORCE_DIST) If enemies in range, moves towards reinforce position while attacking nearby enemies. If no longer close enough or no enemies remain, returns to DefendingState.
void	Exit (Squad *squad)
	Removes squad from ReinforcingSquads vector in CombatManager and resets currentReinforcePosition to invalid.

Static Public Member Functions
static SquadState &	getInstance ()

Private Member Functions
	ReinforcingState (const ReinforcingState &)
ReinforcingState &	operator= (const ReinforcingState &)

Detailed Description

Squad moves towards nearby friendly squads being attacked. Once no nearby squads are being attacked or the squad moves too far away from its defensive position (MAX_REINFORCE_DIST defined in SquadStateTypes.h), the squad returns to its defensive state and position.

Checks if nearby squads are being attacked with a distance < MAX_REINFORCE_DIST.
If so, the squad moves towards the nearby squad while attacking any enemies along the way. If no nearby squads are being attacked or the squad moves too far away from its defensive position, the squad returns to its defensive state and position.

Definition at line 92 of file SquadStateTypes.h.

Constructor & Destructor Documentation

ReinforcingState()

ReinforcingState::ReinforcingState ( )

inlineprivate

Definition at line 116 of file SquadStateTypes.h.

{};

Member Function Documentation

Enter()

void ReinforcingState::Enter ( Squad * squad )

virtual

Adds squad to ReinforcingSquads vector in CombatManager.

Parameters

squad

Implements SquadState.

Definition at line 104 of file SquadStateTypes.cpp.

                                         {
    CombatManager::ReinforcingSquads.push_back(squad);
 
#ifdef DEBUG_STATES
    cout << "(" << squad->info.squadId << ")" << "Entered REINFORCING state" << endl;
#endif
}

Exit()

void ReinforcingState::Exit ( Squad * squad )

virtual

Removes squad from ReinforcingSquads vector in CombatManager and resets currentReinforcePosition to invalid.

Parameters

squad

Implements SquadState.

Definition at line 146 of file SquadStateTypes.cpp.

                                        {
    squad->info.currentReinforcePosition = BWAPI::Positions::Invalid;
    CombatManager::ReinforcingSquads.erase(remove(CombatManager::ReinforcingSquads.begin(), CombatManager::ReinforcingSquads.end(), squad), CombatManager::ReinforcingSquads.end());
 
#ifdef DEBUG_STATES
    cout << "(" << squad->info.squadId << ")" << "Exited REINFORCING state" << endl;
#endif
}

getInstance()

SquadState & ReinforcingState::getInstance ( )

static

Definition at line 155 of file SquadStateTypes.cpp.

{
    static ReinforcingState singleton;
    return singleton;
}

operator=()

ReinforcingState & ReinforcingState::operator= ( const ReinforcingState & )

inlineprivate

Definition at line 118 of file SquadStateTypes.h.

{};

Update()

void ReinforcingState::Update ( Squad * squad )

virtual

Every frame, checks if the reinforce position sent to it by StrategyManager is within range (distance < MAX_REINFORCE_DIST)
If enemies in range, moves towards reinforce position while attacking nearby enemies.
If no longer close enough or no enemies remain, returns to DefendingState.

While in ReinforcingState, the squad handles combat similar to AttackingState.
Units use the kiting methods kitingMelee() and kitingRanged() from KitingBehaviors class to attack enemies while moving back towards the base or forward towards the reinforce position.

Parameters

squad

Implements SquadState.

Definition at line 112 of file SquadStateTypes.cpp.

                                          {
    // Every frame, check if squad is out of range
    if (squad->info.currentDefensivePosition != BWAPI::Positions::Invalid
        && squad->info.currentDefensivePosition.getApproxDistance(squad->info.commandPos) > MAX_REINFORCE_DIST) {
        squad->setState(DefendingState::getInstance());
        return;
    }
 
    if (squad->info.currentReinforcePosition != squad->info.commandPos) {
        squad->info.currentReinforcePosition = squad->info.commandPos;
    }
 
    // If no enemies are left but still in range, return to defending state
    int searchRadius = 100;
    BWAPI::Unitset enemies = BWAPI::Broodwar->getUnitsInRadius(squad->info.currentReinforcePosition, searchRadius, BWAPI::Filter::IsEnemy);
 
    if (enemies.empty()) {
        squad->setState(DefendingState::getInstance());
        return;
    }
 
    for (BWAPI::Unit& unit : squad->info.units)
    {
        if (unit->getType() == BWAPI::UnitTypes::Protoss_Zealot) {
            KitingBehaviors::kitingMelee(unit, squad->info.currentReinforcePosition);
        }
        else if (unit->getType() == BWAPI::UnitTypes::Protoss_Dragoon) {
            KitingBehaviors::kitingRanged(unit, squad->info.currentReinforcePosition);
        }
    }
 
    // TODO: Integrate logic to kite while reinforcing
}

---

The documentation for this class was generated from the following files:

• src/protobot/SquadStateTypes.h
• src/protobot/SquadStateTypes.cpp