OpenTTD GameScript API  20241120-master-g6d3adc6169
Public Types | Public Member Functions
GSEvent Class Reference

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

Inheritance diagram for GSEvent:
GSEventAdminPort GSEventCompanyBankrupt GSEventCompanyInTrouble GSEventCompanyMerger GSEventCompanyNew GSEventCompanyTown GSEventGoalQuestionAnswer GSEventIndustryClose GSEventIndustryOpen GSEventStationFirstVehicle GSEventStoryPageButtonClick GSEventStoryPageTileSelect GSEventStoryPageVehicleSelect GSEventSubsidyAwarded GSEventSubsidyExpired GSEventSubsidyOffer GSEventSubsidyOfferExpired GSEventTownFounded GSEventVehicleCrashed GSEventWindowWidgetClick

Public Types

enum  GSEventType {
  ET_INVALID ,
  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 ,
  ET_GOAL_QUESTION_ANSWER ,
  ET_EXCLUSIVE_TRANSPORT_RIGHTS ,
  ET_ROAD_RECONSTRUCTION ,
  ET_VEHICLE_AUTOREPLACED ,
  ET_STORYPAGE_BUTTON_CLICK ,
  ET_STORYPAGE_TILE_SELECT ,
  ET_STORYPAGE_VEHICLE_SELECT
}
 The type of event. More...
 

Public Member Functions

 GSEvent (GSEvent::GSEventType type)
 Constructor of GSEvent, to get the type of event. More...
 
GSEventType GetEventType ()
 Get the event-type. More...
 

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.

Member Enumeration Documentation

◆ GSEventType

The type of event.

Needed to lookup the detailed class.

Constructor & Destructor Documentation

◆ GSEvent()

GSEvent::GSEvent ( GSEvent::GSEventType  type)

Constructor of GSEvent, to get the type of event.

Parameters
typeThe type of event to construct.

Member Function Documentation

◆ GetEventType()

GSEventType GSEvent::GetEventType ( )
inline

Get the event-type.

Returns
The GSEventType.