BWMirror-Generator/bwapi-master/Error.h

#pragma once
#include <string>
#include <set>
#include "Type.h"
namespace BWAPI
{
  class UnitType;

  /** Functions in BWAPI may set an error code. To retrieve the error code, call Game::getLastError. */
  class Error : public Type
  {
  public:
    Error();
    Error(int id);

    /** Returns the name of the error. For example Errors::Insufficient_Minerals?.toString() will return a
     * std::string object containing "Insufficient Minerals". */
    std::string toString() const;
    const char *c_str() const;
  };
  namespace Errors
  {
    /** Given the name of an error, this function will return the error code. For example:
     * Errors::getError("Unbuildable Location") will return Errors::Unbuildable_Location?. */
    Error getError(std::string name);

    /** The set of all the error codes. */
    const std::set<Error>& allErrors();

    void init();

    /** Returned if you try to order a unit or get information from a unit that no longer exists. */
    extern const Error Unit_Does_Not_Exist;

    /** Returned if you try to retrieve information about a unit that is not currently visible or is dead. */
    extern const Error Unit_Not_Visible;

    /** Returned when attempting to order a unit that BWAPI does not own (i.e. can't order enemy army to go
     *  away) */
    extern const Error Unit_Not_Owned;

    /** Returned when trying to order a unit to do something when it is performing another order or is in a
     * state which prevents it from performing the desired order. For example, ordering a Terran Engineering
     * Bay to upgrade something while it is already upgrading something else will return this error.
     * Similarly, trying to train units from a factory that is lifted will return this error. */
    extern const Error Unit_Busy;

    /** Returned if you do something weird like try to build a Pylon with an SCV, or train Vultures in a
     * Barracks, or order a Hydralisk to lay a spider mine. */
    extern const Error Incompatible_UnitType;

    /** Returned when trying to use a tech type with the wrong Unit::useTech method. */
    extern const Error Incompatible_TechType;

    /** Returned if you to do something like try to cancel an upgrade when the unit isn't upgrading. */
    extern const Error Incompatible_State;

    /** Returned if you try to research something that is already researched. */
    extern const Error Already_Researched;

    /** Returned if you try to upgrade something that is already fully upgraded. */
    extern const Error Fully_Upgraded;

    /** Returned if you try to research something that is already being researched. */
    extern const Error Currently_Researching;

    /** Returned if you try to upgrade something that is already being upgraded. */
    extern const Error Currently_Upgrading;

    /** Returned if you try to train or build something without enough minerals. */
    extern const Error Insufficient_Minerals;

    /** Returned if you try to train or build something without enough vespene gas. */
    extern const Error Insufficient_Gas;

    /** Returned if you try to train something without enough supply. */
    extern const Error Insufficient_Supply;

    /** Returned if you to do something like try to order a Defiler to cast a Dark Swarm without enough
     * energy. */
    extern const Error Insufficient_Energy;

    /** Returned if you do something like try to train Medics when you don't have an Academy, or try to lay
     * Spider Mines before spider mines have been researched. */
    extern const Error Insufficient_Tech;

    /** Returned if you do something like try to lay Spider Mines when your Vulture is out of Spider Mines.
     * Same thing with Reavers and Scarabs. */
    extern const Error Insufficient_Ammo;

    /** Returned if you try to train more Interceptors than the Carrier can hold, try to train more Scarabs
      * than a Reaver can hold, or try to load more units into a transport than there is space. */
    extern const Error Insufficient_Space;

    /** Returned if you try to build a barracks at TilePositions::None or something similar */
    extern const Error Invalid_Tile_Position;

    /** Returned if you try to construct a building on an unbuildable location */
    extern const Error Unbuildable_Location;

    /** Returned if you try to construct a building where the worker cannot reach based on static map data. */
    extern const Error Unreachable_Location;

    /** Returned if you order an immovable unit, like a Protoss Photon Cannon, to attack a unit that is out of
     * range.*/
    extern const Error Out_Of_Range;

    /** Returned if you do something like order a Vulture to attack a flying unit. */
    extern const Error Unable_To_Hit;

    /** Returned if you try to get information that is not allowed with the given flag settings. For example,
     * trying to read the enemy's resource counts while the CompleteMapInformation?  flag is not enabled will
     * return this error. Similarly, trying to read the coordinates of the screen or mouse while the UserInput
     *  flag is not enabled will also return this error. */
    extern const Error Access_Denied;

    /** Used when a file can't be found. */
    extern const Error File_Not_Found;

    /** Used for bad parameters, like passing NULL or an empty string. */
    extern const Error Invalid_Parameter;

    /** Used when no error has been encountered. */
    extern const Error None;

    /** Used when the error code is not recognized or can not be determined. */
    extern const Error Unknown;
  }
}