diff --git a/src/script/api/script_types.hpp b/src/script/api/script_types.hpp index ca525a9ede..9deba0681d 100644 --- a/src/script/api/script_types.hpp +++ b/src/script/api/script_types.hpp @@ -85,27 +85,32 @@ #include "../../tile_type.h" #include -/* 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 uint8_t CargoID; ///< The ID of a cargo. -class CommandCost; ///< The cost of a command. +/* Define all types here, so they are added to the API docs. */ +typedef uint BridgeID; ///< The ID of a bridge type. +typedef uint8_t CargoID; ///< The ID of a cargo. typedef uint16_t EngineID; ///< The ID of an engine. typedef uint16_t GoalID; ///< The ID of a goal. typedef uint16_t GroupID; ///< The ID of a group. typedef uint16_t IndustryID; ///< The ID of an industry. typedef uint8_t IndustryType; ///< The ID of an industry-type. -typedef OverflowSafeInt64 Money; ///< Money, stored in a 32bit/64bit safe way. For scripts money is always in pounds. +#ifdef DOXYGEN_API +typedef int64_t Money; ///< Money, stored in a 32bit/64bit safe way. For scripts money is always in pounds. +#else +typedef OverflowSafeInt64 Money; +#endif /* DOXYGEN_API */ +typedef uint16_t ObjectType; ///< The ID of an object-type. typedef uint16_t SignID; ///< The ID of a sign. typedef uint16_t StationID; ///< The ID of a station. typedef uint32_t StringID; ///< The ID of a string. typedef uint16_t SubsidyID; ///< The ID of a subsidy. typedef uint16_t StoryPageID; ///< The ID of a story page. typedef uint16_t StoryPageElementID; ///< The ID of a story page element. +#ifdef DOXYGEN_API +typedef uint32_t TileIndex; ///< The ID of a map location. +#endif /* DOXYGEN_API */ typedef uint16_t TownID; ///< The ID of a town. typedef uint32_t VehicleID; ///< The ID of a vehicle. -/* Types we defined ourself, as the OpenTTD core doesn't have them (yet) */ typedef uint ScriptErrorType;///< The types of errors inside the script framework. -typedef BridgeType BridgeID; ///< The ID of a bridge. #endif /* SCRIPT_TYPES_HPP */