GSEventCompanyMerger Class Reference

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

Inheritance diagram for GSEventCompanyMerger:

GSEvent

Public Member Functions

 GSEventCompanyMerger (Owner old_owner, Owner new_owner)
GSCompany::CompanyID GetOldCompanyID ()
 Get the CompanyID of the company that has been bought.
GSCompany::CompanyID GetNewCompanyID ()
 Get the CompanyID of the new owner.

Static Public Member Functions

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

Detailed Description

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

Constructor & Destructor Documentation

GSEventCompanyMerger::GSEventCompanyMerger ( Owner  old_owner,
Owner  new_owner 
)

Parameters:
old_owner The company bought off.
new_owner The company that bought owner.


Member Function Documentation

static GSEventCompanyMerger* GSEventCompanyMerger::Convert ( GSEvent instance  )  [inline, static]

Convert an GSEvent to the real instance.

Parameters:
instance The instance to convert.
Returns:
The converted instance.

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.

GSCompany::CompanyID GSEventCompanyMerger::GetNewCompanyID (  )  [inline]

Get the CompanyID of the new owner.

Returns:
The CompanyID of the new owner.


Generated on Sun Mar 31 21:37:40 2013 for OpenTTD Game API by  doxygen 1.5.6