1

/* $Id$ */

     2

     3

/** @file ai_object.hpp declaration of class for AIObject class */

     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

/**

    13

 * The callback function for Mode-classes.

    14

 */

    15

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

    16

    17

/**

    18

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

    19

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

    20

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

    21

 *   command processing, and command-validation checks.

    22

 */

    23

class AIObject : public SimpleCountedObject {

    24

private:

    25

	struct AIDoCommandStruct {

    26

		AIModeProc *mode;

    27

		AIObject *mode_instance;

    28

		uint delay;

    29

		CommandCost costs;

    31

		VehicleID new_vehicle_id;

    32

		SignID new_sign_id;

    33

		void *event_data;

    34

	};

    35

    36

	/**

    37

	 * The current mode of the AI players.

    38

	 */

    39

	static AIDoCommandStruct *GetDoCommandStruct(PlayerID player);

    40

    41

protected:

    42

	/**

    43

	 * Executes a raw DoCommand for the AI.

    44

	 */

    45

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

    46

    47

	/**

    48

	 * Sets the DoCommand costs counter to a value.

    49

	 */

    50

	static void SetDoCommandCosts(Money value);

    51

    52

	/**

    53

	 * Increase the current value of the DoCommand costs counter.

    54

	 */

    55

	static void IncreaseDoCommandCosts(Money value);

    56

    57

	/**

    58

	 * Get the current DoCommand costs counter.

    59

	 */

    60

	static Money GetDoCommandCosts();

    61

    62

	/**

    63

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

    64

	 */

    65

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

    66

    67

	/**

    68

	 * Get the current mode your AI is currently under.

    69

	 */

    70

	static AIModeProc *GetDoCommandMode();

    71

    72

	/**

    73

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

    74

	 */

    75

	static AIObject *GetDoCommandModeInstance();

    76

    77

	/**

    78

	 * Set the delay of the DoCommand.

    79

	 */

    80

	static void SetDoCommandDelay(uint ticks);

    81

    82

	/**

    83

	 * Get the delay of the DoCommand.

    84

	 */

    85

	static uint GetDoCommandDelay();

    86

    87

	/**

    93

	 * Get the latest stored new_vehicle_id.

    94

	 */

    95

	static VehicleID GetNewVehicleID();

    96

    97

	/**

    98

	 * Get the latest stored new_sign_id.

    99

	 */

   100

	static SignID GetNewSignID();

   101

   102

	/**

   103

	 * Get the pointer to store event data in.

   104

	 */

   105

	static void *&GetEventPointer();

   106

   107

public:

   108

	/**

   115

	 * Store a new_vehicle_id per player.

   116

	 * @note NEVER use this yourself in your AI!

   117

	 */

   118

	static void SetNewVehicleID(VehicleID vehicle);

   119

   120

	/**

   121

	 * Store a new_sign_id per player.

   122

	 * @note NEVER use this yourself in your AI!

   123

	 */

   124

	static void SetNewSignID(SignID vehicle);

   125

   126

	/**

   127

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

   128

	 *   takes care of that.

   129

	 * @note NEVER use this yourself in your AI!

   130

	 */

   131

	static void ResetInternalPlayerData();

   132

};

   133

   134

#endif /* AI_OBJECT_HPP */