OpenTTD GameScript API 20250111-master-g8b664a42b0
Public Member Functions | Static Public Member Functions
GSEventCompanyMerger Class Reference

Event Company Merger, indicating a company has been bought by another company. More...

#include <script_event_types.hpp>

Inheritance diagram for GSEventCompanyMerger:
GSEvent

Public Member Functions

GSCompany::CompanyID GetOldCompanyID ()
 Get the CompanyID of the company that has been bought.
 
GSCompany::CompanyID GetNewCompanyID ()
 Get the CompanyID of the new owner.
 
- 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.
 

Static Public Member Functions

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

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 Company Merger, indicating a company has been bought by another company.

Member Function Documentation

◆ Convert()

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

Convert an GSEvent to the real instance.

Parameters
instanceThe instance to convert.
Returns
The converted instance.

◆ GetNewCompanyID()

GSCompany::CompanyID GSEventCompanyMerger::GetNewCompanyID ( )
inline

Get the CompanyID of the new owner.

Returns
The CompanyID of the new owner.

◆ GetOldCompanyID()

GSCompany::CompanyID GSEventCompanyMerger::GetOldCompanyID ( )
inline

Get the CompanyID of the company that has been bought.

Returns
The CompanyID of the company that has been bought.
Note
: The value below is not valid anymore as CompanyID, and GSCompany::ResolveCompanyID will return COMPANY_COMPANY. It's only useful if you're keeping track of company's yourself.