1

/* $Id$ */

     2

     3

/** @file ai_event.hpp Everything to handle events from the game. */

     4

     5

#ifndef AI_EVENT_HPP

     6

#define AI_EVENT_HPP

     7

     8

#include "ai_object.hpp"

     9

    10

/**

    11

 * Class that handles all event related functions.

    12

 * You can lookup the type, and than convert it to the real event-class.

    13

 * That way you can request more detailed information about the event.

    14

 */

    15

class AIEvent : public AIObject {

    16

public:

    17

	static const char *GetClassName() { return "AIEvent"; }

    18

    19

	/**

    20

	 * The type of event. Needed to lookup the detailed class.

    21

	 */

    22

	enum AIEventType {

    23

		AI_ET_INVALID = 0,

    24

		AI_ET_TEST,

    25

		AI_ET_CRASHED_VEHICLE,

    26

		AI_ET_SUBSIDY_OFFER,

    27

		AI_ET_ENGINE_PREVIEW,

    28

	};

    29

    30

	/**

    31

	 * Constructor of AIEvent, to get the type of event.

    32

	 */

    33

	AIEvent(AIEvent::AIEventType type) :

    34

		type(type)

    35

	{}

    36

    37

	/**

    38

	 * Get the event-type.

    39

	 * @return The @c AIEventType.

    40

	 */

    41

	AIEventType GetEventType() { return this->type; }

    42

    43

protected:

    44

	/**

    45

	 * The type of this event.

    46

	 */

    47

	AIEventType type;

    48

};

    49

    50

/**

    51

 * Class that handles all event related functions.

    52

 * @note it is not needed to create an instance of AIEvent to access it, as

    53

 *  all members are static, and all data is stored AI-wide.

    54

 */

    55

class AIEventController : public AIObject {

    56

public:

    57

	/**

    58

	 * The name of the class, needed by several sub-processes.

    59

	 */

    60

	static const char *GetClassName() { return "AIEventController"; }

    61

    62

	/**

    63

	 * Check if there is an event waiting.

    64

	 * @return true if there is an event on the stack.

    65

	 */

    66

	static bool IsEventWaiting();

    67

    68

	/**

    69

	 * Get the next event.

    70

	 * @return a class of the event-child issues.

    71

	 */

    72

	static AIEvent *GetNextEvent();

    73

    74

	/**

    75

	 * No longer report an event of this type.

    76

	 * @param event the event to no longer report.

    77

	 */

    78

	static void DisableEvent(AIEvent::AIEventType event);

    79

    80

	/**

    81

	 * Report events of this type.

    82

	 * @param event the event to report again.

    83

	 */

    84

	static void EnableEvent(AIEvent::AIEventType event);

    85

    86

	/**

    87

	 * Disable all events.

    88

	 */

    89

	static void DisableAllEvents();

    90

    91

	/**

    92

	 * Enable all events.

    93

	 */

    94

	static void EnableAllEvents();

    95

    96

	/**

    97

	 * Insert an event to the queue for the player.

    98

	 * @param event The event to insert.

    99

	 */

   100

	static void InsertEvent(AIEvent *event);

   101

   102

	/**

   103

	 * Give a test event to the system.

   104

	 */

   105

	static void Test();

   106

   107

	/**

   108

	 * Free the event pointer.

   109

	 * @note DO NOT CALL YOURSELF; leave it to the internal AI programming.

   110

	 */

   111

	static void FreeEventPointer();

   112

   113

private:

   114

	/**

   115

	 * Create the event pointer.

   116

	 */

   117

	static void CreateEventPointer();

   118

};

   119

   120

#endif /* AI_EVENT_HPP */