IdleState Class Reference

When any squad is created, it is assigned this state by default. This state does nothing. More...

#include <SquadStateTypes.h>

Inheritance diagram for IdleState:

Public Member Functions
void	Enter (Squad *squad)
	Squad is added to IdleSquads vector in CombatManager.
void	Update (Squad *squad)
	Base state for all squads when first created. These squads will be later reassigned after actions are received from StrategyManager. Idle squads will not do anything until they are assigned a new state.
void	Exit (Squad *squad)
	Squad is removed from IdleSquads vector in CombatManager and resets all command positions to invalid.

Static Public Member Functions
static SquadState &	getInstance ()

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

Detailed Description

When any squad is created, it is assigned this state by default. This state does nothing.

Definition at line 124 of file SquadStateTypes.h.

Constructor & Destructor Documentation

IdleState()

IdleState::IdleState ( )

inlineprivate

Definition at line 145 of file SquadStateTypes.h.

{};

Member Function Documentation

Enter()

void IdleState::Enter ( Squad * squad )

virtual

Squad is added to IdleSquads vector in CombatManager.

Parameters

squad

Implements SquadState.

Definition at line 246 of file SquadStateTypes.cpp.

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

Exit()

void IdleState::Exit ( Squad * squad )

virtual

Squad is removed from IdleSquads vector in CombatManager and resets all command positions to invalid.

Parameters

squad

Implements SquadState.

Definition at line 255 of file SquadStateTypes.cpp.

                                 {
    CombatManager::IdleSquads.erase(remove(CombatManager::IdleSquads.begin(), CombatManager::IdleSquads.end(), squad), CombatManager::IdleSquads.end());
    squad->info.kitePos = BWAPI::Positions::Invalid;
    squad->info.currentPath = Path();
    squad->info.currentPathIdx = 0;
 
#ifdef DEBUG_STATES
    cout << "(" << squad->info.squadId << ")" << "Exited IDLE state" << endl;
#endif
}

getInstance()

SquadState & IdleState::getInstance ( )

static

Definition at line 266 of file SquadStateTypes.cpp.

{
    static IdleState singleton;
    return singleton;
}

operator=()

IdleState & IdleState::operator= ( const IdleState & )

inlineprivate

Definition at line 147 of file SquadStateTypes.h.

{};

Update()

void IdleState::Update ( Squad * squad )

virtual

Base state for all squads when first created.
These squads will be later reassigned after actions are received from StrategyManager.
Idle squads will not do anything until they are assigned a new state.

Parameters

squad

Implements SquadState.

Definition at line 253 of file SquadStateTypes.cpp.

                                   {
}

---

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

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