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

    11

/**

    12

 * The callback function for Mode-classes.

    13

 */

    14

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

    15

    16

/**

    17

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

    18

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

    19

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

    20

 *   command processing, and command-validation checks.

    21

 */

    22

class AIObject {

    23

private:

    24

	struct AIDoCommandStruct {

    25

		AIModeProc *mode;

    26

		AIObject *mode_instance;

    27

		uint delay;

    28

		int32 costs;

    29

		VehicleID new_vehicle_id;

    30

		SignID new_sign_id;

    31

	};

    32

    33

	/**

    34

	 * The current mode of the AI players.

    35

	 */

    36

	static AIDoCommandStruct *GetDoCommandStruct(PlayerID player);

    37

    38

protected:

    39

	/**

    40

	 * Executes a raw DoCommand for the AI.

    41

	 */

    42

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

    43

    44

	/**

    45

	 * Sets the DoCommand costs counter to a value.

    46

	 */

    47

	static void SetDoCommandCosts(int32 value);

    48

    49

	/**

    50

	 * Increase the current value of the DoCommand costs counter.

    51

	 */

    52

	static void IncreaseDoCommandCosts(int32 value);

    53

    54

	/**

    55

	 * Get the current DoCommand costs counter.

    56

	 */

    57

	static int32 GetDoCommandCosts();

    58

    59

	/**

    60

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

    61

	 */

    62

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

    63

    64

	/**

    65

	 * Get the current mode your AI is currently under.

    66

	 */

    67

	static AIModeProc *GetDoCommandMode();

    68

    69

	/**

    70

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

    71

	 */

    72

	static AIObject *GetDoCommandModeInstance();

    73

    74

	/**

    75

	 * Set the delay of the DoCommand.

    76

	 */

    77

	static void SetDoCommandDelay(uint ticks);

    78

    79

	/**

    80

	 * Get the delay of the DoCommand.

    81

	 */

    82

	static uint GetDoCommandDelay();

    83

    84

	/**

    85

	 * Get the latest stored new_vehicle_id.

    86

	 */

    87

	static VehicleID GetNewVehicleID();

    88

    89

	/**

    90

	 * Get the latest stored new_sign_id.

    91

	 */

    92

	static SignID GetNewSignID();

    93

    94

public:

    95

	/**

    96

	 * Store a new_vehicle_id per player.

    97

	 * @note NEVER use this yourself in your AI!

    98

	 */

    99

	static void SetNewVehicleID(VehicleID vehicle);

   100

   101

	/**

   102

	 * Store a new_sign_id per player.

   103

	 * @note NEVER use this yourself in your AI!

   104

	 */

   105

	static void SetNewSignID(SignID vehicle);

   106

   107

	/**

   108

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

   109

	 *   takes care of that.

   110

	 * @note NEVER use this yourself in your AI!

   111

	 */

   112

	static void ResetInternalPlayerData();

   113

};

   114

   115

#endif /* AI_OBJECT_HPP */