AIEventCompanyAskMerger Class Reference

Event Company Ask Merger, indicating a company can be bought (cheaply) by you. More...

#include <ai_event_types.hpp>

Inheritance diagram for AIEventCompanyAskMerger:
AIEvent AIObject SimpleCountedObject

Public Member Functions

 AIEventCompanyAskMerger (Owner owner, int32 value)
AICompany::CompanyID GetCompanyID ()
 Get the CompanyID of the company that can be bought.
int32 GetValue ()
 Get the value of the new company.
bool AcceptMerger ()
 Take over the company for this merger.

Static Public Member Functions

static const char * GetClassName ()
 Get the name of this class to identify it towards squirrel.
static AIEventCompanyAskMergerConvert (AIEvent *instance)
 Convert an AIEvent to the real instance.

Private Attributes

AICompany::CompanyID owner
int32 value

Detailed Description

Event Company Ask Merger, indicating a company can be bought (cheaply) by you.

Definition at line 371 of file ai_event_types.hpp.


Constructor & Destructor Documentation

AIEventCompanyAskMerger::AIEventCompanyAskMerger ( Owner  owner,
int32  value 
) [inline]
Parameters:
owner The company that can be bough.
value The value/costs of buying the company.

Definition at line 380 of file ai_event_types.hpp.


Member Function Documentation

bool AIEventCompanyAskMerger::AcceptMerger (  ) 

Take over the company for this merger.

Returns:
true if the merger was a success.

Definition at line 104 of file ai_event_types.cpp.

References CMD_BUY_COMPANY, and AIObject::DoCommand().

static AIEventCompanyAskMerger* AIEventCompanyAskMerger::Convert ( AIEvent instance  )  [inline, static]

Convert an AIEvent to the real instance.

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

Definition at line 391 of file ai_event_types.hpp.

static const char* AIEventCompanyAskMerger::GetClassName (  )  [inline, static]

Get the name of this class to identify it towards squirrel.

Reimplemented from AIEvent.

Definition at line 374 of file ai_event_types.hpp.

AICompany::CompanyID AIEventCompanyAskMerger::GetCompanyID (  )  [inline]

Get the CompanyID of the company that can be bought.

Returns:
The CompanyID of the company that can be bought.
Note:
If the company is bought this will become invalid.

Definition at line 398 of file ai_event_types.hpp.

int32 AIEventCompanyAskMerger::GetValue (  )  [inline]

Get the value of the new company.

Returns:
The value of the new company.

Definition at line 404 of file ai_event_types.hpp.


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

Generated on Fri Feb 4 20:54:18 2011 for OpenTTD by  doxygen 1.6.1