OpenTTD GameScript API  12.0-beta2
Public Member Functions | Static Public Member Functions
GSEventStoryPageButtonClick Class Reference

Event StoryPageButtonClick, indicating a player clicked a push button on a storybook page. More...

Inheritance diagram for GSEventStoryPageButtonClick:
GSEvent

Public Member Functions

 GSEventStoryPageButtonClick (CompanyID company_id, StoryPageID page_id, StoryPageElementID element_id)
 
GSCompany::CompanyID GetCompanyID ()
 Get the CompanyID of the player that selected a tile.
 
StoryPageID GetStoryPageID ()
 Get the StoryPageID of the storybook page the clicked button is located on.
 
StoryPageElementID GetElementID ()
 Get the StoryPageElementID of the button element that was clicked.
 
- Public Member Functions inherited from GSEvent
 GSEvent (GSEvent::GSEventType type)
 Constructor of GSEvent, to get the type of event.
 
GSEventType GetEventType ()
 Get the event-type. More...
 

Static Public Member Functions

static GSEventStoryPageButtonClickConvert (GSEvent *instance)
 Convert an GSEvent to the real instance. More...
 

Additional Inherited Members

- Public Types inherited from GSEvent
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...
 

Detailed Description

Event StoryPageButtonClick, indicating a player clicked a push button on a storybook page.

Constructor & Destructor Documentation

◆ GSEventStoryPageButtonClick()

GSEventStoryPageButtonClick::GSEventStoryPageButtonClick ( CompanyID  company_id,
StoryPageID  page_id,
StoryPageElementID  element_id 
)
Parameters
company_idWhich company triggered the event.
page_idWhich page was the clicked button on.
element_idWhich button element was clicked.

Member Function Documentation

◆ Convert()

static GSEventStoryPageButtonClick* GSEventStoryPageButtonClick::Convert ( GSEvent instance)
inlinestatic

Convert an GSEvent to the real instance.

Parameters
instanceThe instance to convert.
Returns
The converted instance.