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

#include "../../road_type.h"

    11

    12

#include "ai_types.hpp"

    13

    14

/**

    15

 * The callback function for Mode-classes.

    16

 */

    17

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

    18

    19

/**

    20

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

    21

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

    22

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

    23

 *   command processing, and command-validation checks.

    24

 */

    25

class AIObject : public SimpleCountedObject {

    26

private:

    27

	struct AIDoCommandStruct;

    28

    29

	/**

    30

	 * The current mode of the AI players.

    31

	 */

    32

	static AIDoCommandStruct *GetDoCommandStruct(PlayerID player);

    33

    34

protected:

    35

	/**

    36

	 * Executes a raw DoCommand for the AI.

    37

	 */

    38

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

    39

    40

	/**

    41

	 * Sets the DoCommand costs counter to a value.

    42

	 */

    43

	static void SetDoCommandCosts(Money value);

    44

    45

	/**

    46

	 * Increase the current value of the DoCommand costs counter.

    47

	 */

    48

	static void IncreaseDoCommandCosts(Money value);

    49

    50

	/**

    51

	 * Get the current DoCommand costs counter.

    52

	 */

    53

	static Money GetDoCommandCosts();

    54

    55

	/**

    56

	 * Set the DoCommand last error.

    57

	 */

    58

	static void SetLastError(AIErrorType last_error);

    59

    60

	/**

    61

	 * Get the DoCommand last error.

    62

	 */

    63

	static AIErrorType GetLastError();

    64

    65

	/**

    66

	 * Set the road type.

    67

	 */

    68

	static void SetRoadType(RoadType road_type);

    69

    70

	/**

    71

	 * Get the road type.

    72

	 */

    73

	static RoadType GetRoadType();

    74

    75

	/**

    76

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

    77

	 */

    78

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

    79

    80

	/**

    81

	 * Get the current mode your AI is currently under.

    82

	 */

    83

	static AIModeProc *GetDoCommandMode();

    84

    85

	/**

    86

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

    87

	 */

    88

	static AIObject *GetDoCommandModeInstance();

    89

    90

	/**

    91

	 * Set the delay of the DoCommand.

    92

	 */

    93

	static void SetDoCommandDelay(uint ticks);

    94

    95

	/**

    96

	 * Get the delay of the DoCommand.

    97

	 */

    98

	static uint GetDoCommandDelay();

    99

   100

	/**

   101

	 * Get the latest result of a DoCommand.

   102

	 */

   103

	static bool GetLastCommandRes();

   104

   105

	/**

   106

	 * Get the latest stored new_vehicle_id.

   107

	 */

   108

	static VehicleID GetNewVehicleID();

   109

   110

	/**

   111

	 * Get the latest stored new_sign_id.

   112

	 */

   113

	static SignID GetNewSignID();

   114

   115

	/**

   116

	 * Get the pointer to store event data in.

   117

	 */

   118

	static void *&GetEventPointer();

   119

   120

public:

   121

	/**

   122

	 * Store the latest result of a DoCommand per player.

   123

	 * @note NEVER use this yourself in your AI!

   124

	 * @param res The result of the last command.

   125

	 */

   126

	static void SetLastCommandRes(bool res);

   127

   128

	/**

   129

	 * Store a new_vehicle_id per player.

   130

	 * @note NEVER use this yourself in your AI!

   131

	 * @param vehicle_id The new VehicleID.

   132

	 */

   133

	static void SetNewVehicleID(VehicleID vehicle_id);

   134

   135

	/**

   136

	 * Store a new_sign_id per player.

   137

	 * @note NEVER use this yourself in your AI!

   138

	 * @param sign_id The new SignID.

   139

	 */

   140

	static void SetNewSignID(SignID sign_id);

   141

   142

	/**

   143

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

   144

	 *   takes care of that.

   145

	 * @note NEVER use this yourself in your AI!

   146

	 */

   147

	static void ResetInternalPlayerData();

   148

   149

	/**

   150

	 * Get the pointer to store log message in.

   151

	 * @note NEVER use this yourself in your AI!

   152

	 */

   153

	static void *&GetLogPointer();

   154

};

   155

   156

#endif /* AI_OBJECT_HPP */