src/ai/api/ai_types.hpp
author truebrain
Thu, 24 Apr 2008 23:57:19 +0000
branchnoai
changeset 10343 0ccd326f082e
parent 10341 08f39ee90bdf
child 10344 b7e9f5c65e30
permissions -rw-r--r--
(svn r12884) [NoAI] -Fix r12880: make doxygen happy by commenting on all the typedefs.. boy, what are those comments explaining!
/* $Id$ */

/** @file ai_types.hpp Defines all the types of the game, like VehicleID, .... */

#ifndef AI_TYPES_HPP
#define AI_TYPES_HPP

#include "../../core/overflowsafe_type.hpp"
#include "../../player_type.h"

/* Define all types here, so we don't have to include the whole _type.h maze */
typedef uint BridgeType;     //!< Internal name, not of any use for you.
typedef byte CargoID;        //!< The ID of a cargo.
class CommandCost;           //!< The cost of a command.
typedef uint16 EngineID;     //!< The ID of an engine.
typedef uint16 IndustryID;   //!< The ID of an industry.
typedef OverflowSafeInt64 Money; //!< Money, stored in a 32bit/64bit safe way.
typedef uint16 SignID;       //!< The ID of a sign.
typedef uint16 StationID;    //!< The ID of a station.
typedef uint16 StringID;     //!< The ID of a string.
typedef uint32 TileIndex;    //!< The ID of a tile (just named differently).
typedef uint16 TownID;       //!< The ID of a town.
typedef uint16 VehicleID;    //!< The ID of a vehicle.

/* Types we defined ourself, as the OpenTTD core doesn't have them (yet) */
typedef uint AIErrorType;    //!< The types of errors inside the NoAI framework.
typedef BridgeType BridgeID; //!< The ID of a bridge.

#ifndef _SQUIRREL_H_
/* Life becomes easier when we can tell about a function it needs the VM, but
 *  without really including 'squirrel.h'. */
typedef void *HSQUIRRELVM;   //!< Pointer to Squirrel Virtual Machine.
typedef int SQInteger;       //!< Squirrel Integer.
#endif

#endif /* AI_TYPES_HPP */