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 callback function for Mode-classes.

    27

 */

    28

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

    29

    30

/**

    31

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

    32

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

    33

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

    34

 *   command processing, and command-validation checks.

    35

 */

    36

class AIObject : public SimpleCountedObject {

    37

private:

    38

	struct AIDoCommandStruct {

    39

		AIModeProc *mode;

    40

		AIObject *mode_instance;

    41

		uint delay;

    42

		CommandCost costs;

    43

		StringID last_error;

    44

		bool last_command_res;

    45

		VehicleID new_vehicle_id;

    46

		SignID new_sign_id;

    47

		void *event_data;

    49

	};

    50

    51

	/**

    52

	 * The current mode of the AI players.

    53

	 */

    54

	static AIDoCommandStruct *GetDoCommandStruct(PlayerID player);

    55

    56

protected:

    57

	/**

    58

	 * Executes a raw DoCommand for the AI.

    59

	 */

    60

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

    61

    62

	/**

    63

	 * Sets the DoCommand costs counter to a value.

    64

	 */

    65

	static void SetDoCommandCosts(Money value);

    66

    67

	/**

    68

	 * Increase the current value of the DoCommand costs counter.

    69

	 */

    70

	static void IncreaseDoCommandCosts(Money value);

    71

    72

	/**

    73

	 * Get the current DoCommand costs counter.

    74

	 */

    75

	static Money GetDoCommandCosts();

    76

    77

	/**

    78

	 * Set the DoCommand last error.

    79

	 */

    80

	static void SetLastError(const StringID last_error);

    81

    82

	/**

    83

	 * Get the DoCommand last error.

    84

	 */

    85

	static StringID GetLastError();

    86

    87

	/**

    88

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

    89

	 */

    90

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

    91

    92

	/**

    93

	 * Get the current mode your AI is currently under.

    94

	 */

    95

	static AIModeProc *GetDoCommandMode();

    96

    97

	/**

    98

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

    99

	 */

   100

	static AIObject *GetDoCommandModeInstance();

   101

   102

	/**

   103

	 * Set the delay of the DoCommand.

   104

	 */

   105

	static void SetDoCommandDelay(uint ticks);

   106

   107

	/**

   108

	 * Get the delay of the DoCommand.

   109

	 */

   110

	static uint GetDoCommandDelay();

   111

   112

	/**

   113

	 * Get the latest result of a DoCommand.

   114

	 */

   115

	static bool GetLastCommandRes();

   116

   117

	/**

   118

	 * Get the latest stored new_vehicle_id.

   119

	 */

   120

	static VehicleID GetNewVehicleID();

   121

   122

	/**

   123

	 * Get the latest stored new_sign_id.

   124

	 */

   125

	static SignID GetNewSignID();

   126

   127

	/**

   128

	 * Get the pointer to store event data in.

   129

	 */

   130

	static void *&GetEventPointer();

   131

   132

public:

   133

	/**

   134

	 * Store the latest result of a DoCommand per player.

   135

	 * @note NEVER use this yourself in your AI!

   136

	 * @param res The result of the last command.

   137

	 */

   138

	static void SetLastCommandRes(bool res);

   139

   140

	/**

   141

	 * Store a new_vehicle_id per player.

   142

	 * @note NEVER use this yourself in your AI!

   143

	 * @param vehicle_id The new VehicleID.

   144

	 */

   145

	static void SetNewVehicleID(VehicleID vehicle_id);

   146

   147

	/**

   148

	 * Store a new_sign_id per player.

   149

	 * @note NEVER use this yourself in your AI!

   150

	 * @param sign_id The new SignID.

   151

	 */

   152

	static void SetNewSignID(SignID sign_id);

   153

   154

	/**

   155

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

   156

	 *   takes care of that.

   157

	 * @note NEVER use this yourself in your AI!

   158

	 */

   159

	static void ResetInternalPlayerData();

   166

};

   167

   168

#endif /* AI_OBJECT_HPP */