Advanced Strategic Command
command.h
Go to the documentation of this file.
1 /*
2  This file is part of Advanced Strategic Command; http://www.asc-hq.de
3  Copyright (C) 1994-2010 Martin Bickel and Marc Schellenberger
4 
5  This program is free software; you can redistribute it and/or modify
6  it under the terms of the GNU General Public License as published by
7  the Free Software Foundation; either version 2 of the License, or
8  (at your option) any later version.
9 
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY; without even the implied warranty of
12  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  GNU General Public License for more details.
14 
15  You should have received a copy of the GNU General Public License
16  along with this program; see the file COPYING. If not, write to the
17  Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18  Boston, MA 02111-1307 USA
19 */
20 
21 
22 #ifndef CommandH
23 #define CommandH
24 
25 #include "action.h"
26 
114 class Command : public GameAction {
115  public:
116  enum State { Planned,
119  Run,
122  private:
123  State state;
124  public:
125  State getState() const { return state; };
126 
127  virtual ASCString getCommandString() const = 0;
128 
129  ActionResult redo( const Context& context );
130 
132  virtual vector<MapCoordinate> getCoordinates() const;
133 
134  protected:
135  Command( GameMap* gamemap );
136 
137  void setState( State state );
138 
139  virtual ActionResult go ( const Context& context ) = 0;
140 
141  virtual ActionResult runAction( const Context& context ) ;
142  virtual ActionResult undoAction( const Context& context );
143 
144  virtual void readData ( tnstream& stream );
145  virtual void writeData ( tnstream& stream ) const;
146 
148 
149 };
150 
151 #endif
152 
the command is totally done
Definition: command.h:120
State getState() const
Definition: command.h:125
The interface for all kinds of IO stream.
A Command is an action that the player initiates.
Definition: command.h:114
The ASCString class provides an abstract way to manipulate strings.
Definition: ascstring.h:14
Command(GameMap *gamemap)
Definition: command.cpp:26
virtual ASCString getCommandString() const =0
virtual ActionResult runAction(const Context &context)
Definition: command.cpp:50
virtual void readData(tnstream &stream)
Definition: command.cpp:31
virtual ActionResult checkExecutionPrecondition() const
Definition: command.cpp:82
virtual ActionResult undoAction(const Context &context)
Definition: command.cpp:60
void setState(State state)
Definition: command.cpp:44
virtual void writeData(tnstream &stream) const
Definition: command.cpp:38
ActionResult redo(const Context &context)
Definition: command.cpp:65
virtual ActionResult go(const Context &context)=0
the command is completed this turn, but there is still something to do next turn
Definition: command.h:119
A GameAction is an modification of something on a map.
Definition: action.h:45
virtual vector< MapCoordinate > getCoordinates() const
this is for informational purposes, so the player can see where a Command has taken place when review...
Definition: command.cpp:77
The map. THE central structure of ASC, which holds everything not globally available together...
Definition: gamemap.h:182