1

/* $Id$ */

     2

     4

     5

#ifndef AI_OBJECT_HPP

     6

#define AI_OBJECT_HPP

     7

     8

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

     9

#include "../../functions.h"

    10

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

    11

    12

#ifndef _SQUIRREL_H_

    13

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

    14

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

    16

typedef int SQInteger;

    17

#endif

    18

    19

/**

    20

 * The callback function for Mode-classes.

    21

 */

    22

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

    23

    24

/**

    25

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

    26

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

    27

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

    28

 *   command processing, and command-validation checks.

    29

 */

    30

class AIObject : public SimpleCountedObject {

    31

private:

    32

	struct AIDoCommandStruct {

    33

		AIModeProc *mode;

    34

		AIObject *mode_instance;

    35

		uint delay;

    36

		CommandCost costs;

    37

		bool last_command_res;

    38

		VehicleID new_vehicle_id;

    39

		SignID new_sign_id;

    40

		void *event_data;

    41

	};

    42

    43

	/**

    44

	 * The current mode of the AI players.

    45

	 */

    46

	static AIDoCommandStruct *GetDoCommandStruct(PlayerID player);

    47

    48

protected:

    49

	/**

    50

	 * Executes a raw DoCommand for the AI.

    51

	 */

    52

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

    53

    54

	/**

    55

	 * Sets the DoCommand costs counter to a value.

    56

	 */

    57

	static void SetDoCommandCosts(Money value);

    58

    59

	/**

    60

	 * Increase the current value of the DoCommand costs counter.

    61

	 */

    62

	static void IncreaseDoCommandCosts(Money value);

    63

    64

	/**

    65

	 * Get the current DoCommand costs counter.

    66

	 */

    67

	static Money GetDoCommandCosts();

    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

	 */

   119

	static void SetLastCommandRes(bool res);

   120

   121

	/**

   122

	 * Store a new_vehicle_id per player.

   123

	 * @note NEVER use this yourself in your AI!

   124

	 */

   125

	static void SetNewVehicleID(VehicleID vehicle);

   126

   127

	/**

   128

	 * Store a new_sign_id per player.

   129

	 * @note NEVER use this yourself in your AI!

   130

	 */

   131

	static void SetNewSignID(SignID vehicle);

   132

   133

	/**

   134

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

   135

	 *   takes care of that.

   136

	 * @note NEVER use this yourself in your AI!

   137

	 */

   138

	static void ResetInternalPlayerData();

   139

};

   140

   141

#endif /* AI_OBJECT_HPP */