#include <ai_company.hpp>
Public Types | |
enum | CompanyID { COMPANY_INVALID = -1, COMPANY_SELF = 254 } |
Different constants related to CompanyID. More... | |
Static Public Member Functions | |
static const char * | GetClassName () |
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 | 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. |
Definition at line 13 of file ai_company.hpp.
enum AICompany::CompanyID |
Different constants related to CompanyID.
COMPANY_INVALID | An invalid company. |
COMPANY_SELF | Constant that gets resolved to the correct company index for your company. |
Definition at line 18 of file ai_company.hpp.
AICompany::CompanyID AICompany::ResolveCompanyID | ( | AICompany::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.
company | The company index to resolve. |
Definition at line 18 of file ai_company.cpp.
References COMPANY_INVALID, and COMPANY_SELF.
Referenced by GetAutoRenewMoney(), GetAutoRenewMonths(), GetAutoRenewStatus(), GetBankBalance(), GetCompanyHQ(), GetCompanyValue(), GetName(), AITile::GetOwner(), GetPresidentName(), AITown::GetRating(), and IsMine().
bool AICompany::IsMine | ( | AICompany::CompanyID | company | ) | [static] |
Check if a CompanyID is your CompanyID, to ease up checks.
company | The company index to check. |
Definition at line 25 of file ai_company.cpp.
References COMPANY_SELF, and ResolveCompanyID().
bool AICompany::SetName | ( | const char * | name | ) | [static] |
Set the name of your company.
name | The new name of the company. |
'name' must have at most 30 characters.
AIError::ERR_NAME_IS_NOT_UNIQUE |
Definition at line 30 of file ai_company.cpp.
References CMD_RENAME_COMPANY, AIObject::DoCommand(), EnforcePrecondition, EnforcePreconditionCustomError, AIError::ERR_PRECONDITION_STRING_TOO_LONG, MAX_LENGTH_COMPANY_NAME_BYTES, and StrEmpty().
char * AICompany::GetName | ( | AICompany::CompanyID | company | ) | [static] |
Get the name of the given company.
company | The company to get the name for. |
Definition at line 38 of file ai_company.cpp.
References COMPANY_INVALID, and ResolveCompanyID().
bool AICompany::SetPresidentName | ( | const char * | name | ) | [static] |
Set the name of your president.
name | The new name of the president. |
AIError::ERR_NAME_IS_NOT_UNIQUE |
Definition at line 51 of file ai_company.cpp.
References CMD_RENAME_PRESIDENT, AIObject::DoCommand(), EnforcePrecondition, and StrEmpty().
char * AICompany::GetPresidentName | ( | AICompany::CompanyID | company | ) | [static] |
Get the name of the president of the given company.
company | The company to get the president's name for. |
Definition at line 58 of file ai_company.cpp.
References COMPANY_INVALID, and ResolveCompanyID().
bool AICompany::SetLoanAmount | ( | int32 | loan | ) | [static] |
Sets the amount to loan.
loan | The amount to loan (multiplier of GetLoanInterval()). |
GetLoanInterval() must be a multiplier of 'loan'.
'loan' must be below GetMaxLoanAmount().
'loan' - GetLoanAmount() + GetBankBalance() must be non-negative.
Definition at line 105 of file ai_company.cpp.
References abs(), CMD_DECREASE_LOAN, CMD_INCREASE_LOAN, COMPANY_SELF, AIObject::DoCommand(), EnforcePrecondition, GetBankBalance(), GetLoanAmount(), GetLoanInterval(), and GetMaxLoanAmount().
Referenced by SetMinimumLoanAmount().
bool AICompany::SetMinimumLoanAmount | ( | int32 | loan | ) | [static] |
Sets the minimum amount to loan, i.e.
the given amount of loan rounded up.
loan | The amount to loan (any positive number). |
'loan' must be below GetMaxLoanAmount().
Definition at line 119 of file ai_company.cpp.
References EnforcePrecondition, GetLoanAmount(), GetLoanInterval(), GetMaxLoanAmount(), and SetLoanAmount().
Money AICompany::GetLoanAmount | ( | ) | [static] |
Gets the amount your company have loaned.
GetLoanInterval() is always a multiplier of the return value.
Definition at line 90 of file ai_company.cpp.
Referenced by SetLoanAmount(), and SetMinimumLoanAmount().
Money AICompany::GetMaxLoanAmount | ( | ) | [static] |
Gets the maximum amount your company can loan.
GetLoanInterval() is always a multiplier of the return value.
Definition at line 95 of file ai_company.cpp.
Referenced by SetLoanAmount(), and SetMinimumLoanAmount().
Money AICompany::GetLoanInterval | ( | ) | [static] |
Gets the interval/loan step.
Definition at line 100 of file ai_company.cpp.
Referenced by SetLoanAmount(), and SetMinimumLoanAmount().
Money AICompany::GetCompanyValue | ( | AICompany::CompanyID | company | ) | [static] |
Gets the current value of the given company.
company | The company to get the company value of. |
Definition at line 74 of file ai_company.cpp.
References COMPANY_INVALID, and ResolveCompanyID().
Money AICompany::GetBankBalance | ( | AICompany::CompanyID | company | ) | [static] |
Gets the bank balance.
In other words, the amount of money the given company can spent.
company | The company to get the bank balance of. |
Definition at line 82 of file ai_company.cpp.
References COMPANY_INVALID, and ResolveCompanyID().
Referenced by SetLoanAmount().
bool AICompany::BuildCompanyHQ | ( | TileIndex | tile | ) | [static] |
Build your company's HQ on the given tile.
tile | The tile to build your HQ on, this tile is the most nothern tile of your HQ. |
Definition at line 133 of file ai_company.cpp.
References CMD_BUILD_COMPANY_HQ, AIObject::DoCommand(), EnforcePrecondition, and IsValidTile().
Return the location of a company's HQ.
company | The company the get the HQ of. |
Definition at line 140 of file ai_company.cpp.
References COMPANY_INVALID, INVALID_TILE, and ResolveCompanyID().
bool AICompany::SetAutoRenewStatus | ( | bool | autorenew | ) | [static] |
Set whether autorenew is enabled for your company.
autorenew | The new autorenew status. |
Definition at line 149 of file ai_company.cpp.
References CMD_SET_AUTOREPLACE, and AIObject::DoCommand().
bool AICompany::GetAutoRenewStatus | ( | CompanyID | company | ) | [static] |
Return whether autorenew is enabled for a company.
company | The company to get the autorenew status of. |
Definition at line 154 of file ai_company.cpp.
References COMPANY_INVALID, and ResolveCompanyID().
bool AICompany::SetAutoRenewMonths | ( | int16 | months | ) | [static] |
Set the number of months before/after max age to autorenew an engine for your company.
months | The new months between autorenew. |
Definition at line 162 of file ai_company.cpp.
References CMD_SET_AUTOREPLACE, and AIObject::DoCommand().
int16 AICompany::GetAutoRenewMonths | ( | CompanyID | company | ) | [static] |
Return the number of months before/after max age to autorenew an engine for a company.
company | The company to get the autorenew months of. |
Definition at line 167 of file ai_company.cpp.
References COMPANY_INVALID, and ResolveCompanyID().
bool AICompany::SetAutoRenewMoney | ( | uint32 | money | ) | [static] |
Set the minimum money needed to autorenew an engine for your company.
money | The new minimum required money for autorenew to work. |
Definition at line 175 of file ai_company.cpp.
References CMD_SET_AUTOREPLACE, and AIObject::DoCommand().
uint32 AICompany::GetAutoRenewMoney | ( | CompanyID | company | ) | [static] |
Return the minimum money needed to autorenew an engine for a company.
company | The company to get the autorenew money of. |
Definition at line 180 of file ai_company.cpp.
References COMPANY_INVALID, and ResolveCompanyID().