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_SUBSIDY_OFFER_EXPIRED,

    28

		AI_ET_SUBSIDY_AWARDED,

    29

		AI_ET_SUBSIDY_EXPIRED,

    30

		AI_ET_ENGINE_PREVIEW,

    31

		AI_ET_COMPANY_NEW,

    32

		AI_ET_COMPANY_IN_TROUBLE,

    33

		AI_ET_COMPANY_MERGER,

    34

		AI_ET_COMPANY_BANKRUPT,

    35

		AI_ET_VEHICLE_LOST,

    36

		AI_ET_VEHICLE_WAITING_IN_DEPOT,

    37

		AI_ET_VEHICLE_UNPROFITABLE,

    38

	};

    39

    40

	/**

    41

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

    42

	 */

    43

	AIEvent(AIEvent::AIEventType type) :

    44

		type(type)

    45

	{}

    46

    47

	/**

    48

	 * Get the event-type.

    49

	 * @return The @c AIEventType.

    50

	 */

    51

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

    52

    53

protected:

    54

	/**

    55

	 * The type of this event.

    56

	 */

    57

	AIEventType type;

    58

};

    59

    60

/**

    61

 * Class that handles all event related functions.

    62

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

    63

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

    64

 */

    65

class AIEventController : public AIObject {

    66

public:

    67

	/**

    68

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

    69

	 */

    70

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

    71

    72

	/**

    73

	 * Check if there is an event waiting.

    74

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

    75

	 */

    76

	static bool IsEventWaiting();

    77

    78

	/**

    79

	 * Get the next event.

    80

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

    81

	 */

    82

	static AIEvent *GetNextEvent();

    83

    84

	/**

    85

	 * No longer report an event of this type.

    86

	 * @param event the event to no longer report.

    87

	 */

    88

	static void DisableEvent(AIEvent::AIEventType event);

    89

    90

	/**

    91

	 * Report events of this type.

    92

	 * @param event the event to report again.

    93

	 */

    94

	static void EnableEvent(AIEvent::AIEventType event);

    95

    96

	/**

    97

	 * Disable all events.

    98

	 */

    99

	static void DisableAllEvents();

   100

   101

	/**

   102

	 * Enable all events.

   103

	 */

   104

	static void EnableAllEvents();

   105

   106

	/**

   107

	 * Insert an event to the queue for the player.

   108

	 * @param event The event to insert.

   109

	 */

   110

	static void InsertEvent(AIEvent *event);

   111

   112

	/**

   113

	 * Give a test event to the system.

   114

	 */

   115

	static void Test();

   116

   117

	/**

   118

	 * Free the event pointer.

   119

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

   120

	 */

   121

	static void FreeEventPointer();

   122

   123

private:

   124

	/**

   125

	 * Create the event pointer.

   126

	 */

   127

	static void CreateEventPointer();

   128

};

   129

   130

#endif /* AI_EVENT_HPP */