Api.hh

/*
** TowBowlTactics, a turn-based strategy football game.
** 
** Copyright (C) 2006-2010 The TBT Team.
** 
** This program is free software; you can redistribute it and/or
** modify it under the terms of the GNU General Public License
** as published by the Free Software Foundation; either version 2
** of the License, or (at your option) any later version.
** 
** The complete GNU General Public Licence Notice can be found as the
** `NOTICE' file in the root directory.
** 
** The TBT Team consists of people listed in the `AUTHORS' file.
*/

#ifndef API_HH_
# define API_HH_

# include "rules/BaseApi.hh"
# include "CRules.hh"
# include "CMatch.hh"

class Api : public BaseApi<CRules>
{
public:
  Api(CRules* rules);
  ~Api();
 

  int                   turn() const;

  int                   half() const;
 
  int                   myTeamId() const;

  int                   getActiveTeamId() const;

  Coordinates            ball() const;
  const CPlayer*        getBallOwner() const;

  const char*           gameStateString() const;

  int                   canMakeRequest() const;

  int                   mustMakeChoice() const;

  int                   teamId(const Coordinates& coord);
  
  int                   selectTeam(int team_id);
  const CTeam*          getTeam() const;

  int                   selectPlayer(int player_id);
  
  int                   selectSkilledPlayer(int player_id);
  
  int                   playerId(const Coordinates& coord);

  const CPlayer*        getPlayer() const;
  const CPlayer*        getPlayer(int player_id);
  const CPlayer*        getPlayer(const Coordinates& coord);
  const CPlayer*        getActivePlayer() const;
  
  int                   actionPossibleNumber();

  int                   actionPossible(int index) const;

  int                   effortPossibleNumber();

  int                   effortPossible(int index) const;

  int                   isEffortPossible(int effort) const;

  int                   moveLength(const Coordinates& to);

  int                   moveDifficulty(int step);

  Coordinates            movePath(int step);

  int                   movePossible(const Coordinates& to);

  int                   blockDicesNumber(const Coordinates& to) const;

  int                   blockDicesNumberPadding() const;

  int                   throwDifficulty(const Coordinates& to) const;

  int           remainingTime() const;

  int           isTimerPaused() const;
  
  const Weather*        getWeather() const;
  



  int           doEndTurn();

  int           doCalmDown();

  int           doCelebrate();

  int           doMoveTurnMarker();

  int           doAskIllegalProcedure();

  int           doChooseKickoff(bool kickoff);

  int           doPlacePlayer(const Coordinates& coord);

  int           doPlaceTeam(int formation_id);

  int           doEndPlacement();

  int           doPlaceBall(const Coordinates& coord);

  int           doGiveBall(int p);

  int           doReroll(bool reroll);

  int           doUseSkill(enum eSkill skill, bool useIt);

  int           doBeginAction(enum eAction action);

  int           doEndAction();

  int           doChooseBlockDice(int n);

  int           doBlockPush(int n);

  int           doFollow(bool follow);

  int           doEffort(enum eEffort effort, const Coordinates& to);

  int           doStandUpPlayer();

  int           doMovePlayer(const Coordinates& to);

  int           doBlockPlayer(int def_p);

  int           doPassPlayer(const Coordinates& to);

  int           doCheatDice(int roll);

  int           sendChatMessage(const std::string& msg);

  int           sendDebugRequest();



private:
  CTeam*                selected_team_;
  CPlayer*              selected_player_;
  CPlayer*              skilled_player_;
  const CoordList*      player_path_;
  bool                  possible_actions_[ACT_LAST];
  bool                  possible_efforts_[EFF_LAST];
};

# include "Api.hxx"

#endif /* !API_HH_ */