sc2_coordinator.h

Go to the documentation of this file.

#pragma once

#include <vector>
#include <string>
#include "sc2api/sc2_game_settings.h"
#include "sc2api/sc2_proto_interface.h"

namespace sc2 {

class Agent;
class ReplayObserver;
class CoordinatorImp;

class Coordinator {
public:
    Coordinator();
    ~Coordinator();

    // Initialization and setup.

    bool LoadSettings(int argc, char** argv);

    void SetMultithreaded(bool value);

    void SetRealtime(bool value);

    void SetStepSize(int step_size);

    void SetProcessPath(const std::string& path);

    void SetDataVersion(const std::string& version);

    void SetTimeoutMS(uint32_t timeout_ms = kDefaultProtoInterfaceTimeout);

    void SetPortStart(int port_start);

    void SetFeatureLayers(const FeatureLayerSettings& settings);

    void SetRender(const RenderSettings& settings);

    void SetWindowSize(int width, int height);

    void SetWindowLocation(int x, int y);

    void SetUseGeneralizedAbilityId(bool value);

    // \param option The string to be appended to the executable invoke.
    void AddCommandLine(const std::string& option);

    // \param participants A vector of player setups for each participant in the game.
    // \sa PlayerSetup
    void SetParticipants(const std::vector<PlayerSetup>& participants);

    void SetReplayRecovery(bool value);

    // \param replay_observer A pointer to the replay observer to utilize.
    // \sa ReplayObserver
    void AddReplayObserver(ReplayObserver* replay_observer);

    // Start-up.

    void LaunchStarcraft();

    void Connect(int port);

    bool StartGame(const std::string& map_path = std::string());

    bool CreateGame(const std::string& map_path = std::string());

    bool JoinGame();

    void SetupPorts(size_t num_agents, int port_start, bool check_single = true);

    // Run.

    bool Update();

    void LeaveGame();

    // Status.

    bool AllGamesEnded() const;

    // Replay specific.
    // \param path The folder path.
    bool SetReplayPath(const std::string& path);
    // \param path The file path.
    bool LoadReplayList(const std::string& file_path);
    // \param path The file path.
    void SaveReplayList(const std::string& file_path);
    bool HasReplays() const;

    // Misc.

    void WaitForAllResponses();
    // \param data The map data.
    // \param data_size The size of map data.
    // \param remote_path The file path to save the data to.
    bool RemoteSaveMap(const void* data, int data_size, std::string remote_path);
    std::string GetExePath() const;

private:
    CoordinatorImp* imp_;
};

}