commands.h

Go to the documentation of this file.

//       _________ __                 __
//      /   _____//  |_____________ _/  |______     ____  __ __  ______
//      \_____  \\   __\_  __ \__  \\   __\__  \   / ___\|  |  \/  ___/
//      /        \|  |  |  | \// __ \|  |  / __ \_/ /_/  >  |  /\___ |
//     /_______  /|__|  |__|  (____  /__| (____  /\___  /|____//____  >
//             \/                  \/          \//_____/            \/
//  ______________________                           ______________________
//                        T H E   W A R   B E G I N S
//         Stratagus - A free fantasy real time strategy game engine
//
//
//      (c) Copyright 1998-2006 by Lutz Sammer and Jimmy Salmon
//
//      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; only version 2 of the License.
//
//      This program is distributed in the hope that it will be useful,
//      but WITHOUT ANY WARRANTY; without even the implied warranty of
//      MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//      GNU General Public License for more details.
//
//      You should have received a copy of the GNU General Public License
//      along with this program; if not, write to the Free Software
//      Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
//      02111-1307, USA.
//
 
#ifndef __COMMANDS_H__
#define __COMMANDS_H__
 
 
#include "vec2i.h"
 
/*----------------------------------------------------------------------------
--  Declarations
----------------------------------------------------------------------------*/
 
class CUnit;
class CFile;
class SpellType;
class CUnitType;
class CUpgrade;
 
/*----------------------------------------------------------------------------
--  Functions
----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------
--  Commands: in command.c
----------------------------------------------------------------------------*/
 
extern void CommandQuit(int player);
extern void CommandStopUnit(CUnit &unit);
extern void CommandStandGround(CUnit &unit, int flush);
extern void CommandDefend(CUnit &unit, CUnit &dest, int flush);
extern void CommandFollow(CUnit &unit, CUnit &dest, int flush);
extern void CommandMove(CUnit &unit, const Vec2i &pos, int flush);
extern void CommandRepair(CUnit &unit, const Vec2i &pos, CUnit *dest, int flush);
extern void CommandAutoRepair(CUnit &unit, int on);
extern void CommandAttack(CUnit &unit, const Vec2i &pos, CUnit *dest, int flush);
extern void CommandAttackGround(CUnit &unit, const Vec2i &pos, int flush);
extern void CommandPatrolUnit(CUnit &unit, const Vec2i &pos, int flush);
extern void CommandBoard(CUnit &unit, CUnit &dest, int flush);
extern void CommandUnload(CUnit &unit, const Vec2i &pos, CUnit *what, int flush);
extern void CommandBuildBuilding(CUnit &unit, const Vec2i &pos, CUnitType &, int flush);
extern void CommandExplore(CUnit &unit, int flush);
extern void CommandDismiss(CUnit &unit);
extern void CommandResourceLoc(CUnit &unit, const Vec2i &pos, int flush);
extern void CommandResource(CUnit &unit, CUnit &dest, int flush);
extern void CommandReturnGoods(CUnit &unit, CUnit *depot, int flush);
extern void CommandTrainUnit(CUnit &unit, CUnitType &what, int flush);
extern void CommandCancelTraining(CUnit &unit, int slot, const CUnitType *type);
extern void CommandUpgradeTo(CUnit &unit, CUnitType &what, int flush, bool instant = false);
extern void CommandTransformIntoType(CUnit &unit, CUnitType &type);
extern void CommandCancelUpgradeTo(CUnit &unit);
extern void CommandResearch(CUnit &unit, CUpgrade &what, int flush);
extern void CommandCancelResearch(CUnit &unit);
extern void CommandSpellCast(CUnit &unit, const Vec2i &pos, CUnit *dest, const SpellType &spell, int flush, bool isAutocast = false);
extern void CommandAutoSpellCast(CUnit &unit, int spellid, int on);
extern void CommandDiplomacy(int player, int state, int opponent);
extern void CommandSharedVision(int player, bool state, int opponent);
 
/*
**  The send command functions sends a command, if needed over the
**  Network, this is only for user commands. Automatic reactions which
**  are on all computers equal, should use the functions without Send.
*/
 
typedef unsigned short UnitRef;
 
extern void SendCommandStopUnit(CUnit &unit);
extern void SendCommandStandGround(CUnit &unit, int flush);
extern void SendCommandDefend(CUnit &unit, CUnit &dest, int flush);
extern void SendCommandFollow(CUnit &unit, CUnit &dest, int flush);
extern void SendCommandMove(CUnit &unit, const Vec2i &pos, int flush);
extern void SendCommandRepair(CUnit &unit, const Vec2i &pos, CUnit *dest, int flush);
extern void SendCommandAutoRepair(CUnit &unit, int on);
extern void SendCommandAttack(CUnit &unit, const Vec2i &pos, CUnit *dest, int flush);
extern void SendCommandAttackGround(CUnit &unit, const Vec2i &pos, int flush);
extern void SendCommandPatrol(CUnit &unit, const Vec2i &pos, int flush);
extern void SendCommandBoard(CUnit &unit, CUnit &dest, int flush);
extern void SendCommandUnload(CUnit &unit, const Vec2i &pos, CUnit *what, int flush);
extern void SendCommandBuildBuilding(CUnit &unit, const Vec2i &pos, CUnitType &what, int flush);
extern void SendCommandExplore(CUnit &unit, int flush);
extern void SendCommandDismiss(CUnit &unit);
extern void SendCommandResourceLoc(CUnit &unit, const Vec2i &pos, int flush);
extern void SendCommandResource(CUnit &unit, CUnit &dest, int flush);
extern void SendCommandReturnGoods(CUnit &unit, CUnit *dest, int flush);
extern void SendCommandTrainUnit(CUnit &unit, CUnitType &what, int flush);
extern void SendCommandCancelTraining(CUnit &unit, int slot, const CUnitType *type);
extern void SendCommandUpgradeTo(CUnit &unit, CUnitType &what, int flush);
extern void SendCommandCancelUpgradeTo(CUnit &unit);
extern void SendCommandResearch(CUnit &unit, CUpgrade &what, int flush);
extern void SendCommandCancelResearch(CUnit &unit);
extern void SendCommandSpellCast(CUnit &unit, const Vec2i &pos, CUnit *dest, int spellid, int flush);
extern void SendCommandAutoSpellCast(CUnit &unit, int spellid, int on);
extern void SendCommandDiplomacy(int player, int state, int opponent);
extern void SendCommandSharedVision(int player, bool state, int opponent);
 
extern void ExecCommand(unsigned char type, UnitRef unum, unsigned short x,
                                                unsigned short y, UnitRef dest);
extern void ExecExtendedCommand(unsigned char type, int status, unsigned char arg1,
                                                                unsigned short arg2, unsigned short arg3,
                                                                unsigned short arg4);
 
#define FlushCommands 1          
 
 
 
#endif // !__COMMANDS_H__