1

/* $Id$ */

     2

     3

/** @file ai_object.hpp Main object, on which all objects depend. */

     4

     5

#ifndef AI_OBJECT_HPP

     6

#define AI_OBJECT_HPP

     7

     8

#include "../../stdafx.h"

     9

#include "../../misc/countedptr.hpp"

    10

    12

    13

/**

    14

 * The type (an alias) for all errors the AI API knows.

    15

 */

    16

typedef uint AIErrorType;

    17

    18

/**

    19

 * The callback function for Mode-classes.

    20

 */

    21

typedef bool (AIModeProc)(TileIndex tile, uint32 p1, uint32 p2, uint procc, CommandCost costs);

    22

    23

/**

    24

 * Uper-parent object of all API classes. You should never use this class in

    25

 *   your AI, as it doesn't publish any public functions. It is used

    26

 *   internally to have a common place to handle general things, like internal

    27

 *   command processing, and command-validation checks.

    28

 */

    29

class AIObject : public SimpleCountedObject {

    30

private:

    32

    33

	/**

    34

	 * The current mode of the AI players.

    35

	 */

    36

	static AIDoCommandStruct *GetDoCommandStruct(PlayerID player);

    37

    38

protected:

    39

	/**

    40

	 * Executes a raw DoCommand for the AI.

    41

	 */

    42

	static bool DoCommand(TileIndex tile, uint32 p1, uint32 p2, uint procc, bool water_protection = true);

    43

    44

	/**

    45

	 * Sets the DoCommand costs counter to a value.

    46

	 */

    47

	static void SetDoCommandCosts(Money value);

    48

    49

	/**

    50

	 * Increase the current value of the DoCommand costs counter.

    51

	 */

    52

	static void IncreaseDoCommandCosts(Money value);

    53

    54

	/**

    55

	 * Get the current DoCommand costs counter.

    56

	 */

    57

	static Money GetDoCommandCosts();

    58

    59

	/**

    60

	 * Set the DoCommand last error.

    61

	 */

    62

	static void SetLastError(AIErrorType last_error);

    63

    64

	/**

    65

	 * Get the DoCommand last error.

    66

	 */

    67

	static AIErrorType GetLastError();

    68

    69

	/**

    70

	 * Set the current mode of your AI to this proc.

    71

	 */

    72

	static void SetDoCommandMode(AIModeProc *proc, AIObject *instance);

    73

    74

	/**

    75

	 * Get the current mode your AI is currently under.

    76

	 */

    77

	static AIModeProc *GetDoCommandMode();

    78

    79

	/**

    80

	 * Get the instance of the current mode your AI is currently under.

    81

	 */

    82

	static AIObject *GetDoCommandModeInstance();

    83

    84

	/**

    85

	 * Set the delay of the DoCommand.

    86

	 */

    87

	static void SetDoCommandDelay(uint ticks);

    88

    89

	/**

    90

	 * Get the delay of the DoCommand.

    91

	 */

    92

	static uint GetDoCommandDelay();

    93

    94

	/**

    95

	 * Get the latest result of a DoCommand.

    96

	 */

    97

	static bool GetLastCommandRes();

    98

    99

	/**

   100

	 * Get the latest stored new_vehicle_id.

   101

	 */

   102

	static VehicleID GetNewVehicleID();

   103

   104

	/**

   105

	 * Get the latest stored new_sign_id.

   106

	 */

   107

	static SignID GetNewSignID();

   108

   109

	/**

   110

	 * Get the pointer to store event data in.

   111

	 */

   112

	static void *&GetEventPointer();

   113

   114

public:

   115

	/**

   116

	 * Store the latest result of a DoCommand per player.

   117

	 * @note NEVER use this yourself in your AI!

   118

	 * @param res The result of the last command.

   119

	 */

   120

	static void SetLastCommandRes(bool res);

   121

   122

	/**

   123

	 * Store a new_vehicle_id per player.

   124

	 * @note NEVER use this yourself in your AI!

   125

	 * @param vehicle_id The new VehicleID.

   126

	 */

   127

	static void SetNewVehicleID(VehicleID vehicle_id);

   128

   129

	/**

   130

	 * Store a new_sign_id per player.

   131

	 * @note NEVER use this yourself in your AI!

   132

	 * @param sign_id The new SignID.

   133

	 */

   134

	static void SetNewSignID(SignID sign_id);

   135

   136

	/**

   137

	 * If an AI starts, some internals needs to be resetted. This function

   138

	 *   takes care of that.

   139

	 * @note NEVER use this yourself in your AI!

   140

	 */

   141

	static void ResetInternalPlayerData();

   142

   143

	/**

   144

	 * Get the pointer to store log message in.

   145

	 * @note NEVER use this yourself in your AI!

   146

	 */

   147

	static void *&GetLogPointer();

   148

};

   149

   150

#endif /* AI_OBJECT_HPP */