Public Types | Public Member Functions | Protected Attributes

ScriptEvent Class Reference

Class that handles all event related functions. More...

#include <script_event.hpp>

Inheritance diagram for ScriptEvent:
ScriptObject SimpleCountedObject ScriptEventAdminPort ScriptEventAircraftDestTooFar ScriptEventCompanyAskMerger ScriptEventCompanyBankrupt ScriptEventCompanyInTrouble ScriptEventCompanyMerger ScriptEventCompanyNew ScriptEventDisasterZeppelinerCleared ScriptEventDisasterZeppelinerCrashed ScriptEventEngineAvailable ScriptEventEnginePreview ScriptEventIndustryClose ScriptEventIndustryOpen ScriptEventStationFirstVehicle ScriptEventSubsidyAwarded ScriptEventSubsidyExpired ScriptEventSubsidyOffer ScriptEventSubsidyOfferExpired ScriptEventTownFounded ScriptEventVehicleCrashed ScriptEventVehicleLost ScriptEventVehicleUnprofitable ScriptEventVehicleWaitingInDepot ScriptEventWindowWidgetClick

Public Types

enum  ScriptEventType {
  ET_INVALID = 0, ET_TEST, ET_SUBSIDY_OFFER, ET_SUBSIDY_OFFER_EXPIRED,
  ET_SUBSIDY_AWARDED, ET_SUBSIDY_EXPIRED, ET_ENGINE_PREVIEW, ET_COMPANY_NEW,
  ET_COMPANY_IN_TROUBLE, ET_COMPANY_ASK_MERGER, ET_COMPANY_MERGER, ET_COMPANY_BANKRUPT,
  ET_VEHICLE_CRASHED, ET_VEHICLE_LOST, ET_VEHICLE_WAITING_IN_DEPOT, ET_VEHICLE_UNPROFITABLE,
  ET_INDUSTRY_OPEN, ET_INDUSTRY_CLOSE, ET_ENGINE_AVAILABLE, ET_STATION_FIRST_VEHICLE,
  ET_DISASTER_ZEPPELINER_CRASHED, ET_DISASTER_ZEPPELINER_CLEARED, ET_TOWN_FOUNDED, ET_AIRCRAFT_DEST_TOO_FAR,
  ET_ADMIN_PORT, ET_WINDOW_WIDGET_CLICK
}
 

The type of event.

More...

Public Member Functions

 ScriptEvent (ScriptEvent::ScriptEventType type)
 Constructor of ScriptEvent, to get the type of event.
ScriptEventType GetEventType ()
 Get the event-type.

Protected Attributes

ScriptEventType type
 The type of this event.

Detailed Description

Class that handles all event related functions.

You can lookup the type, and than convert it to the real event-class. That way you can request more detailed information about the event. ai game

Definition at line 23 of file script_event.hpp.


Member Enumeration Documentation

The type of event.

Needed to lookup the detailed class.

Definition at line 28 of file script_event.hpp.


Member Function Documentation

ScriptEventType ScriptEvent::GetEventType (  )  [inline]

Get the event-type.

Returns:
The ScriptEventType.

Definition at line 68 of file script_event.hpp.

References type.


The documentation for this class was generated from the following file: