AICompany Class Reference

Class that handles all company related functions. More...

Inheritance diagram for AICompany:

AIObject

Public Types

enum  CompanyID {
  COMPANY_FIRST = 0,
  COMPANY_LAST = ::MAX_COMPANIES,
  COMPANY_SELF = 254,
  COMPANY_INVALID = -1
}
 Different constants related to CompanyID. More...
enum  Gender {
  GENDER_MALE,
  GENDER_FEMALE,
  GENDER_INVALID = -1
}
 Possible genders for company presidents. More...

Static Public Member Functions

static CompanyID ResolveCompanyID (CompanyID company)
 Resolved the given company index to the correct index for the company.
static bool IsMine (CompanyID company)
 Check if a CompanyID is your CompanyID, to ease up checks.
static bool SetName (const char *name)
 Set the name of your company.
static char * GetName (CompanyID company)
 Get the name of the given company.
static bool SetPresidentName (const char *name)
 Set the name of your president.
static char * GetPresidentName (CompanyID company)
 Get the name of the president of the given company.
static bool SetPresidentGender (Gender gender)
 Set the gender of the president of your company.
static Gender GetPresidentGender (CompanyID company)
 Get the gender of the president of the given company.
static bool SetLoanAmount (int32 loan)
 Sets the amount to loan.
static bool SetMinimumLoanAmount (int32 loan)
 Sets the minimum amount to loan, i.e.
static Money GetLoanAmount ()
 Gets the amount your company have loaned.
static Money GetMaxLoanAmount ()
 Gets the maximum amount your company can loan.
static Money GetLoanInterval ()
 Gets the interval/loan step.
static Money GetCompanyValue (CompanyID company)
 Gets the current value of the given company.
static Money GetBankBalance (CompanyID company)
 Gets the bank balance.
static bool BuildCompanyHQ (TileIndex tile)
 Build your company's HQ on the given tile.
static TileIndex GetCompanyHQ (CompanyID company)
 Return the location of a company's HQ.
static bool SetAutoRenewStatus (bool autorenew)
 Set whether autorenew is enabled for your company.
static bool GetAutoRenewStatus (CompanyID company)
 Return whether autorenew is enabled for a company.
static bool SetAutoRenewMonths (int16 months)
 Set the number of months before/after max age to autorenew an engine for your company.
static int16 GetAutoRenewMonths (CompanyID company)
 Return the number of months before/after max age to autorenew an engine for a company.
static bool SetAutoRenewMoney (uint32 money)
 Set the minimum money needed to autorenew an engine for your company.
static uint32 GetAutoRenewMoney (CompanyID company)
 Return the minimum money needed to autorenew an engine for a company.

Detailed Description

Class that handles all company related functions.

Member Enumeration Documentation

Different constants related to CompanyID.

Enumerator:
COMPANY_FIRST  The first available company.
COMPANY_LAST  The last available company.
COMPANY_SELF  Constant that gets resolved to the correct company index for your company.
COMPANY_INVALID  An invalid company.

Possible genders for company presidents.

Enumerator:
GENDER_MALE  A male person.
GENDER_FEMALE  A female person.
GENDER_INVALID  An invalid gender.


Member Function Documentation

static CompanyID AICompany::ResolveCompanyID ( CompanyID  company  )  [static]

Resolved the given company index to the correct index for the company.

If the company index was COMPANY_SELF it will be resolved to the index of your company. If the company with the given index does not exist it will return COMPANY_INVALID.

Parameters:
company The company index to resolve.
Returns:
The resolved company index.

static bool AICompany::IsMine ( CompanyID  company  )  [static]

Check if a CompanyID is your CompanyID, to ease up checks.

Parameters:
company The company index to check.
Returns:
True if and only if this company is your CompanyID.

static bool AICompany::SetName ( const char *  name  )  [static]

Set the name of your company.

Parameters:
name The new name of the company.
Precondition:
'name' must have at least one character.

'name' must have at most 30 characters.

Exceptions:
AIError::ERR_NAME_IS_NOT_UNIQUE 
Returns:
True if the name was changed.

static char* AICompany::GetName ( CompanyID  company  )  [static]

Get the name of the given company.

Parameters:
company The company to get the name for.
Precondition:
ResolveCompanyID(company) != COMPANY_INVALID.
Returns:
The name of the given company.

static bool AICompany::SetPresidentName ( const char *  name  )  [static]

Set the name of your president.

Parameters:
name The new name of the president.
Precondition:
'name' must have at least one character.
Exceptions:
AIError::ERR_NAME_IS_NOT_UNIQUE 
Returns:
True if the name was changed.

static char* AICompany::GetPresidentName ( CompanyID  company  )  [static]

Get the name of the president of the given company.

Parameters:
company The company to get the president's name for.
Precondition:
ResolveCompanyID(company) != COMPANY_INVALID.
Returns:
The name of the president of the given company.

static bool AICompany::SetPresidentGender ( Gender  gender  )  [static]

Set the gender of the president of your company.

Parameters:
gender The new gender for your president.
Precondition:
GetPresidentGender(AICompany.COMPANY_SELF) != gender.
Returns:
True if the gender was changed.
Note:
When successful a random face will be created.

static Gender AICompany::GetPresidentGender ( CompanyID  company  )  [static]

Get the gender of the president of the given company.

Parameters:
company The company to get the presidents gender off.
Returns:
The gender of the president.

static bool AICompany::SetLoanAmount ( int32  loan  )  [static]

Sets the amount to loan.

Parameters:
loan The amount to loan (multiplier of GetLoanInterval()).
Precondition:
'loan' must be non-negative.

GetLoanInterval() must be a multiplier of 'loan'.

'loan' must be below GetMaxLoanAmount().

'loan' - GetLoanAmount() + GetBankBalance() must be non-negative.

Returns:
True if the loan could be set to your requested amount.

static bool AICompany::SetMinimumLoanAmount ( int32  loan  )  [static]

Sets the minimum amount to loan, i.e.

the given amount of loan rounded up.

Parameters:
loan The amount to loan (any positive number).
Precondition:
'loan' must be non-negative.

'loan' must be below GetMaxLoanAmount().

Returns:
True if we could allocate a minimum of 'loan' loan.

static Money AICompany::GetLoanAmount (  )  [static]

Gets the amount your company have loaned.

Returns:
The amount loaned money.
Postcondition:
The return value is always non-negative.

GetLoanInterval() is always a multiplier of the return value.

static Money AICompany::GetMaxLoanAmount (  )  [static]

Gets the maximum amount your company can loan.

Returns:
The maximum amount your company can loan.
Postcondition:
The return value is always non-negative.

GetLoanInterval() is always a multiplier of the return value.

static Money AICompany::GetLoanInterval (  )  [static]

Gets the interval/loan step.

Returns:
The loan step.
Postcondition:
Return value is always positive.

static Money AICompany::GetCompanyValue ( CompanyID  company  )  [static]

Gets the current value of the given company.

Parameters:
company The company to get the company value of.
Precondition:
ResolveCompanyID(company) != COMPANY_INVALID.
Returns:
The current value of the given company.

static Money AICompany::GetBankBalance ( CompanyID  company  )  [static]

Gets the bank balance.

In other words, the amount of money the given company can spent.

Parameters:
company The company to get the bank balance of.
Precondition:
ResolveCompanyID(company) != COMPANY_INVALID.
Returns:
The actual bank balance.

static bool AICompany::BuildCompanyHQ ( TileIndex  tile  )  [static]

Build your company's HQ on the given tile.

Parameters:
tile The tile to build your HQ on, this tile is the most nothern tile of your HQ.
Precondition:
AIMap::IsValidTile(tile).
Exceptions:
AIError::ERR_AREA_NOT_CLEAR 
AIError::ERR_FLAT_LAND_REQUIRED 
Returns:
True if the HQ could be build.
Note:
An HQ can not be removed, only by water or rebuilding; If an HQ is build again, the old one is removed.

static TileIndex AICompany::GetCompanyHQ ( CompanyID  company  )  [static]

Return the location of a company's HQ.

Parameters:
company The company the get the HQ of.
Precondition:
ResolveCompanyID(company) != COMPANY_INVALID.
Returns:
The tile of the company's HQ, this tile is the most nothern tile of that HQ, or AIMap::TILE_INVALID if there is no HQ yet.

static bool AICompany::SetAutoRenewStatus ( bool  autorenew  )  [static]

Set whether autorenew is enabled for your company.

Parameters:
autorenew The new autorenew status.
Returns:
True if autorenew status has been modified.

static bool AICompany::GetAutoRenewStatus ( CompanyID  company  )  [static]

Return whether autorenew is enabled for a company.

Parameters:
company The company to get the autorenew status of.
Precondition:
ResolveCompanyID(company) != COMPANY_INVALID.
Returns:
True if autorenew is enabled.

static bool AICompany::SetAutoRenewMonths ( int16  months  )  [static]

Set the number of months before/after max age to autorenew an engine for your company.

Parameters:
months The new months between autorenew.
Returns:
True if autorenew months has been modified.

static int16 AICompany::GetAutoRenewMonths ( CompanyID  company  )  [static]

Return the number of months before/after max age to autorenew an engine for a company.

Parameters:
company The company to get the autorenew months of.
Precondition:
ResolveCompanyID(company) != COMPANY_INVALID.
Returns:
The months before/after max age of engine.

static bool AICompany::SetAutoRenewMoney ( uint32  money  )  [static]

Set the minimum money needed to autorenew an engine for your company.

Parameters:
money The new minimum required money for autorenew to work.
Returns:
True if autorenew money has been modified.

static uint32 AICompany::GetAutoRenewMoney ( CompanyID  company  )  [static]

Return the minimum money needed to autorenew an engine for a company.

Parameters:
company The company to get the autorenew money of.
Precondition:
ResolveCompanyID(company) != COMPANY_INVALID.
Returns:
The minimum required money for autorenew to work.


Generated on Thu Mar 31 21:31:48 2011 for OpenTTD NoAI API by  doxygen 1.5.6