Public Member Functions | Static Public Member Functions | Private Attributes

ScriptEventCompanyMerger Class Reference

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

#include <script_event_types.hpp>

Inheritance diagram for ScriptEventCompanyMerger:
ScriptEvent ScriptObject SimpleCountedObject

Public Member Functions

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

Static Public Member Functions

static ScriptEventCompanyMergerConvert (ScriptEvent *instance)
 Convert an ScriptEvent to the real instance.

Private Attributes

ScriptCompany::CompanyID old_owner
 The company that ended to exist.
ScriptCompany::CompanyID new_owner
 The company that's the end result of the merger.

Detailed Description

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

ai game

Definition at line 411 of file script_event_types.hpp.


Constructor & Destructor Documentation

ScriptEventCompanyMerger::ScriptEventCompanyMerger ( Owner  old_owner,
Owner  new_owner 
) [inline]
Parameters:
old_owner The company bought off.
new_owner The company that bougth owner.

Definition at line 417 of file script_event_types.hpp.


Member Function Documentation

static ScriptEventCompanyMerger* ScriptEventCompanyMerger::Convert ( ScriptEvent instance  )  [inline, static]

Convert an ScriptEvent to the real instance.

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

Definition at line 428 of file script_event_types.hpp.

ScriptCompany::CompanyID ScriptEventCompanyMerger::GetNewCompanyID (  )  [inline]

Get the CompanyID of the new owner.

Returns:
The CompanyID of the new owner.

Definition at line 443 of file script_event_types.hpp.

References new_owner.

ScriptCompany::CompanyID ScriptEventCompanyMerger::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 ScriptCompany::ResolveCompanyID will return COMPANY_COMPANY. It's only usefull if you're keeping track of company's yourself.

Definition at line 437 of file script_event_types.hpp.

References old_owner.


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