sc2_client.h

Go to the documentation of this file.

#pragma once

#include <string>
#include <vector>
#include <cassert>

#include "sc2api/sc2_typeenums.h"

namespace sc2 {

class ControlImp;
class Unit;
class ObservationInterface;
class QueryInterface;
class DebugInterface;
class ControlInterface;
class ControlImp;

enum class ClientError {
    ErrorSC2,
    InvalidAbilityRemap, 
    InvalidResponse,     
    NoAbilitiesForTag,   
    ResponseNotConsumed, 
    ResponseMismatch,    
    ConnectionClosed,    
    SC2UnknownStatus,
    SC2AppFailure,       
    SC2ProtocolError,    
    SC2ProtocolTimeout,  
    WrongGameVersion,    
};

class ClientEvents {
public:
    virtual ~ClientEvents() {}

    virtual void OnGameFullStart() {}

    virtual void OnGameStart() {}

    virtual void OnGameEnd() {}

    virtual void OnStep() {}

    virtual void OnUnitDestroyed(const Unit*) {}

    virtual void OnNeutralUnitCreated(const Unit*) {}

    virtual void OnUnitCreated(const Unit*) {}

    virtual void OnUnitIdle(const Unit*) {}

    virtual void OnUpgradeCompleted(UpgradeID) {}

    // !the current step.
    virtual void OnBuildingConstructionComplete(const Unit*) {}

    virtual void OnUnitDamaged(const Unit*, float /*health*/, float /*shields*/) {}

    virtual void OnNydusDetected() {}

    virtual void OnNuclearLaunchDetected() {}

    virtual void OnUnitEnterVision(const Unit*) {}

    virtual void OnError(const std::vector<ClientError>& /*client_errors*/, const std::vector<std::string>& /*protocol_errors*/ = {}) {}
};

class Client : public ClientEvents {
public:
    Client();
    virtual ~Client();

    const ObservationInterface* Observation() const;

    QueryInterface* Query();

    DebugInterface* Debug();

    ControlInterface* Control();
    const ControlInterface* Control() const;

    void Reset();

private:
    ControlImp* control_imp_;
};

bool IsCarryingMinerals(const Unit& unit);

bool IsCarryingVespene(const Unit& unit);

struct IsVisible {
    bool operator()(const Unit& unit);
};

}