a3dd7506d3
NoAI is an API (a framework) to build your own AIs in. See: http://wiki.openttd.org/wiki/index.php/AI:Main_Page With many thanks to: - glx and Rubidium for their syncing, feedback and hard work - Yexo for his feedback, patches, and AIs which tested the system very deep - Morloth for his feedback and patches - TJIP for hosting a challenge which kept NoAI on track - All AI authors for testing our AI API, and all other people who helped in one way or another -Remove: all old AIs and their cheats/hacks
77 lines
1.9 KiB
C++
77 lines
1.9 KiB
C++
/* $Id$ */
|
|
|
|
/** @file ai_log.hpp Everything to handle and issue log messages. */
|
|
|
|
#ifndef AI_LOG_HPP
|
|
#define AI_LOG_HPP
|
|
|
|
#include "ai_object.hpp"
|
|
|
|
/**
|
|
* Class that handles all log related functions.
|
|
*/
|
|
class AILog : public AIObject {
|
|
/* AIController needs access to Enum and Log, in order to keep the flow from
|
|
* OpenTTD core to NoAI API clear and simple. */
|
|
friend class AIController;
|
|
|
|
public:
|
|
static const char *GetClassName() { return "AILog"; }
|
|
|
|
/**
|
|
* Log levels; The value is also feed to DEBUG() lvl.
|
|
* This has no use for you, as AI writer.
|
|
*/
|
|
enum AILogType {
|
|
LOG_SQ_ERROR = 0, //!< Squirrel printed an error.
|
|
LOG_ERROR = 1, //!< User printed an error.
|
|
LOG_SQ_INFO = 2, //!< Squirrel printed some info.
|
|
LOG_WARNING = 3, //!< User printed some warning.
|
|
LOG_INFO = 4, //!< User printed some info.
|
|
};
|
|
|
|
/**
|
|
* Internal representation of the log-data inside the AI.
|
|
* This has no use for you, as AI writer.
|
|
*/
|
|
struct LogData {
|
|
char **lines; //!< The log-lines.
|
|
AILog::AILogType *type; //!< Per line, which type of log it was.
|
|
int count; //!< Total amount of log-lines possible.
|
|
int pos; //!< Current position in lines.
|
|
int used; //!< Total amount of used log-lines.
|
|
};
|
|
|
|
/**
|
|
* Print an Info message to the logs.
|
|
* @param message The message to log.
|
|
*/
|
|
static void Info(const char *message);
|
|
|
|
/**
|
|
* Print a Warning message to the logs.
|
|
* @param message The message to log.
|
|
*/
|
|
static void Warning(const char *message);
|
|
|
|
/**
|
|
* Print an Error message to the logs.
|
|
* @param message The message to log.
|
|
*/
|
|
static void Error(const char *message);
|
|
|
|
/**
|
|
* Free the log pointer.
|
|
* @note DO NOT CALL YOURSELF; leave it to the internal AI programming.
|
|
*/
|
|
static void FreeLogPointer();
|
|
|
|
private:
|
|
/**
|
|
* Internal command to log the message in a common way.
|
|
*/
|
|
static void Log(AILog::AILogType level, const char *message);
|
|
};
|
|
|
|
#endif /* AI_LOG_HPP */
|