mirror of https://github.com/OpenTTD/OpenTTD
(svn r23201) -Doc: [NoAI] Hide all contents of AIObject from the API documentation as AIs were never able to use it anyway
parent
e963ff9cf9
commit
924a5e06b3
|
@ -294,7 +294,7 @@ struct AISettingsWindow : public Window {
|
|||
|
||||
this->SetWidgetDisabledState(AIS_WIDGET_RESET, _game_mode != GM_MENU && Company::IsValidID(this->slot));
|
||||
|
||||
this->vscroll->SetCount(this->visible_settings.size());
|
||||
this->vscroll->SetCount((int)this->visible_settings.size());
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
|
@ -206,7 +206,7 @@ EXPAND_ONLY_PREDEF = YES
|
|||
SEARCH_INCLUDES = YES
|
||||
INCLUDE_PATH =
|
||||
INCLUDE_FILE_PATTERNS =
|
||||
PREDEFINED = DOXYGEN_SKIP
|
||||
PREDEFINED = DOXYGEN_AI_DOCS
|
||||
EXPAND_AS_DEFINED = DEF_COMMAND
|
||||
SKIP_FUNCTION_MACROS = YES
|
||||
#---------------------------------------------------------------------------
|
||||
|
|
|
@ -109,7 +109,7 @@ public:
|
|||
*/
|
||||
static int32 GetMinLength(BridgeID bridge_id);
|
||||
|
||||
#ifndef DOXYGEN_SKIP
|
||||
#ifndef DOXYGEN_AI_DOCS
|
||||
/**
|
||||
* Internal function to help BuildBridge in case of road.
|
||||
*/
|
||||
|
|
|
@ -282,7 +282,7 @@ public:
|
|||
* Get the type of the offered engine.
|
||||
* @return The type the engine has.
|
||||
*/
|
||||
#ifdef DOXYGEN_SKIP
|
||||
#ifdef DOXYGEN_AI_DOCS
|
||||
AIVehicle::VehicleType GetVehicleType();
|
||||
#else
|
||||
int32 GetVehicleType();
|
||||
|
|
|
@ -10,7 +10,7 @@
|
|||
/** @file ai_info_docs.hpp Description of the functions an AI can/must provide in AIInfo. */
|
||||
|
||||
/* This file exists purely for doxygen purposes. */
|
||||
#ifdef DOXYGEN_SKIP
|
||||
#ifdef DOXYGEN_AI_DOCS
|
||||
/**
|
||||
* 'Abstract' class of the class AIs/AI libraries use to register themselves.
|
||||
*
|
||||
|
|
|
@ -239,7 +239,7 @@ public:
|
|||
*/
|
||||
void KeepList(AIList *list);
|
||||
|
||||
#ifndef DOXYGEN_SKIP
|
||||
#ifndef DOXYGEN_AI_DOCS
|
||||
/**
|
||||
* Used for 'foreach()' and [] get from Squirrel.
|
||||
*/
|
||||
|
@ -280,7 +280,7 @@ public:
|
|||
* list.Valuate(MyVal, 12);
|
||||
*/
|
||||
void Valuate(void *valuator_function, int params, ...);
|
||||
#endif /* DOXYGEN_SKIP */
|
||||
#endif /* DOXYGEN_AI_DOCS */
|
||||
};
|
||||
|
||||
#endif /* AI_LIST_HPP */
|
||||
|
|
|
@ -38,6 +38,7 @@ class AIObject : public SimpleCountedObject {
|
|||
friend void CcAI(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2);
|
||||
friend class AIInstance;
|
||||
friend class AIController;
|
||||
#ifndef DOXYGEN_AI_DOCS
|
||||
protected:
|
||||
/**
|
||||
* Executes a raw DoCommand for the AI.
|
||||
|
@ -181,51 +182,45 @@ protected:
|
|||
public:
|
||||
/**
|
||||
* Store the latest result of a DoCommand per company.
|
||||
* @note NEVER use this yourself in your AI!
|
||||
* @param res The result of the last command.
|
||||
*/
|
||||
static void SetLastCommandRes(bool res);
|
||||
|
||||
/**
|
||||
* Store a new_vehicle_id per company.
|
||||
* @note NEVER use this yourself in your AI!
|
||||
* @param vehicle_id The new VehicleID.
|
||||
*/
|
||||
static void SetNewVehicleID(VehicleID vehicle_id);
|
||||
|
||||
/**
|
||||
* Store a new_sign_id per company.
|
||||
* @note NEVER use this yourself in your AI!
|
||||
* @param sign_id The new SignID.
|
||||
*/
|
||||
static void SetNewSignID(SignID sign_id);
|
||||
|
||||
/**
|
||||
* Store a new_tunnel_endtile per company.
|
||||
* @note NEVER use this yourself in your AI!
|
||||
* @param tile The new TileIndex.
|
||||
*/
|
||||
static void SetNewTunnelEndtile(TileIndex tile);
|
||||
|
||||
/**
|
||||
* Store a new_group_id per company.
|
||||
* @note NEVER use this yourself in your AI!
|
||||
* @param group_id The new GroupID.
|
||||
*/
|
||||
static void SetNewGroupID(GroupID group_id);
|
||||
|
||||
/**
|
||||
* Store a allow_do_command per company.
|
||||
* @note NEVER use this yourself in your AI!
|
||||
* @param allow The new allow.
|
||||
*/
|
||||
static void SetAllowDoCommand(bool allow);
|
||||
|
||||
/**
|
||||
* Get the pointer to store log message in.
|
||||
* @note NEVER use this yourself in your AI!
|
||||
*/
|
||||
static void *&GetLogPointer();
|
||||
#endif /* DOXYGEN_AI_DOCS */
|
||||
};
|
||||
|
||||
#endif /* AI_OBJECT_HPP */
|
||||
|
|
|
@ -480,12 +480,12 @@ public:
|
|||
*/
|
||||
static bool RemoveOrder(VehicleID vehicle_id, OrderPosition order_position);
|
||||
|
||||
#ifndef DOXYGEN_SKIP
|
||||
#ifndef DOXYGEN_AI_DOCS
|
||||
/**
|
||||
* Internal function to help SetOrderFlags.
|
||||
*/
|
||||
static bool _SetOrderFlags();
|
||||
#endif /* DOXYGEN_SKIP */
|
||||
#endif /* DOXYGEN_AI_DOCS */
|
||||
|
||||
/**
|
||||
* Changes the order flags of the given order.
|
||||
|
|
|
@ -65,7 +65,7 @@ public:
|
|||
*/
|
||||
static TileIndex GetOtherTunnelEnd(TileIndex tile);
|
||||
|
||||
#ifndef DOXYGEN_SKIP
|
||||
#ifndef DOXYGEN_AI_DOCS
|
||||
/**
|
||||
* Internal function to help BuildTunnel in case of road.
|
||||
*/
|
||||
|
@ -75,7 +75,7 @@ public:
|
|||
* Internal function to help BuildTunnel in case of road.
|
||||
*/
|
||||
static bool _BuildTunnelRoad2();
|
||||
#endif /* DOXYGEN_SKIP */
|
||||
#endif /* DOXYGEN_AI_DOCS */
|
||||
|
||||
/**
|
||||
* Builds a tunnel starting at start. The direction of the tunnel depends
|
||||
|
|
Loading…
Reference in New Issue