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 "../../openttd.h"

    10

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

    11

#include "../../signs_type.h"

    12

#include "../../strings_type.h"

    13

#include "../../command_type.h"

    14

#include "../../vehicle_type.h"

    15

#include "../../tile_type.h"

    16

#include "../../player_type.h"

    17

    18

#ifndef _SQUIRREL_H_

    19

/* Life becomes easier when we can tell about a function it needs the VM, but

    20

 *  without really including 'squirrel.h'. */

    21

typedef void *HSQUIRRELVM;

    22

typedef int SQInteger;

    23

#endif

    24

    25

/**

    26

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

    27

 */

    28

typedef uint AIErrorType;

    29

    30

/**

    31

 * The callback function for Mode-classes.

    32

 */

    33

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

    34

    35

/**

    36

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

    37

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

    38

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

    39

 *   command processing, and command-validation checks.

    40

 */

    41

class AIObject : public SimpleCountedObject {

    42

private:

    43

	struct AIDoCommandStruct {

    44

		AIModeProc *mode;

    45

		AIObject *mode_instance;

    46

		uint delay;

    47

		CommandCost costs;

    48

		uint last_error;

    49

		bool last_command_res;

    50

		VehicleID new_vehicle_id;

    51

		SignID new_sign_id;

    52

		void *event_data;

    53

		void *log_data;

    54

	};

    55

    56

	/**

    57

	 * The current mode of the AI players.

    58

	 */

    59

	static AIDoCommandStruct *GetDoCommandStruct(PlayerID player);

    60

    61

protected:

    62

	/**

    63

	 * Executes a raw DoCommand for the AI.

    64

	 */

    65

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

    66

    67

	/**

    68

	 * Sets the DoCommand costs counter to a value.

    69

	 */

    70

	static void SetDoCommandCosts(Money value);

    71

    72

	/**

    73

	 * Increase the current value of the DoCommand costs counter.

    74

	 */

    75

	static void IncreaseDoCommandCosts(Money value);

    76

    77

	/**

    78

	 * Get the current DoCommand costs counter.

    79

	 */

    80

	static Money GetDoCommandCosts();

    81

    82

	/**

    83

	 * Set the DoCommand last error.

    84

	 * @note last_error is an ERR_* from a ErrorMessages enum.

    85

	 */

    86

	static void SetLastError(AIErrorType last_error);

    87

    88

	/**

    89

	 * Get the DoCommand last error.

    90

	 */

    91

	static AIErrorType GetLastError();

    92

    93

	/**

    94

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

    95

	 */

    96

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

    97

    98

	/**

    99

	 * Get the current mode your AI is currently under.

   100

	 */

   101

	static AIModeProc *GetDoCommandMode();

   102

   103

	/**

   104

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

   105

	 */

   106

	static AIObject *GetDoCommandModeInstance();

   107

   108

	/**

   109

	 * Set the delay of the DoCommand.

   110

	 */

   111

	static void SetDoCommandDelay(uint ticks);

   112

   113

	/**

   114

	 * Get the delay of the DoCommand.

   115

	 */

   116

	static uint GetDoCommandDelay();

   117

   118

	/**

   119

	 * Get the latest result of a DoCommand.

   120

	 */

   121

	static bool GetLastCommandRes();

   122

   123

	/**

   124

	 * Get the latest stored new_vehicle_id.

   125

	 */

   126

	static VehicleID GetNewVehicleID();

   127

   128

	/**

   129

	 * Get the latest stored new_sign_id.

   130

	 */

   131

	static SignID GetNewSignID();

   132

   133

	/**

   134

	 * Get the pointer to store event data in.

   135

	 */

   136

	static void *&GetEventPointer();

   137

   138

public:

   139

	/**

   140

	 * Store the latest result of a DoCommand per player.

   141

	 * @note NEVER use this yourself in your AI!

   142

	 * @param res The result of the last command.

   143

	 */

   144

	static void SetLastCommandRes(bool res);

   145

   146

	/**

   147

	 * Store a new_vehicle_id per player.

   148

	 * @note NEVER use this yourself in your AI!

   149

	 * @param vehicle_id The new VehicleID.

   150

	 */

   151

	static void SetNewVehicleID(VehicleID vehicle_id);

   152

   153

	/**

   154

	 * Store a new_sign_id per player.

   155

	 * @note NEVER use this yourself in your AI!

   156

	 * @param sign_id The new SignID.

   157

	 */

   158

	static void SetNewSignID(SignID sign_id);

   159

   160

	/**

   161

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

   162

	 *   takes care of that.

   163

	 * @note NEVER use this yourself in your AI!

   164

	 */

   165

	static void ResetInternalPlayerData();

   166

   167

	/**

   168

	 * Get the pointer to store log message in.

   169

	 * @note NEVER use this yourself in your AI!

   170

	 */

   171

	static void *&GetLogPointer();

   172

};

   173

   174

#endif /* AI_OBJECT_HPP */