OpenTTD Source  20241120-master-g6d3adc6169
company_func.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #ifndef COMPANY_FUNC_H
11 #define COMPANY_FUNC_H
12 
13 #include "command_type.h"
14 #include "company_type.h"
15 #include "gfx_type.h"
16 #include "vehicle_type.h"
17 
19 void ChangeOwnershipOfCompanyItems(Owner old_owner, Owner new_owner);
21 void SetDParamsForOwnedBy(Owner owner, TileIndex tile);
22 void SetLocalCompany(CompanyID new_company);
23 void ShowBuyCompanyDialog(CompanyID company, bool hostile_takeover);
24 void CompanyAdminUpdate(const Company *company);
25 void CompanyAdminBankrupt(CompanyID company_id);
28 
32 void SubtractMoneyFromCompany(const CommandCost &cost);
33 void SubtractMoneyFromCompanyFract(CompanyID company, const CommandCost &cost);
34 CommandCost CheckOwnership(Owner owner, TileIndex tile = 0U);
36 
39 
40 extern Colours _company_colours[MAX_COMPANIES];
42 
47 inline bool IsLocalCompany()
48 {
50 }
51 
57 inline bool IsInteractiveCompany(CompanyID company)
58 {
59  return company == _local_company;
60 }
61 
62 int CompanyServiceInterval(const Company *c, VehicleType type);
64 
65 #endif /* COMPANY_FUNC_H */
Common return value for all commands.
Definition: command_type.h:23
Types related to commands.
Colours _company_colours[MAX_COMPANIES]
NOSAVE: can be determined from company structs.
Definition: company_cmd.cpp:54
bool IsInteractiveCompany(CompanyID company)
Is the user representing company?
Definition: company_func.h:57
void ChangeOwnershipOfCompanyItems(Owner old_owner, Owner new_owner)
Change the ownership of all the items of a company.
Definition: economy.cpp:334
void ShowBuyCompanyDialog(CompanyID company, bool hostile_takeover)
Show the query to buy another company.
static const int OWNED_BY_OWNER_IN_PARAMETERS_OFFSET
The index in the parameters for the owner information.
Definition: company_func.h:20
void UpdateCompanyLiveries(Company *c)
Update liveries for a company.
CommandCost CheckTileOwnership(TileIndex tile)
Check whether the current owner owns the stuff on the given tile.
int CompanyServiceInterval(const Company *c, VehicleType type)
Get the service interval for the given company and vehicle type.
bool CheckCompanyHasMoney(CommandCost &cost)
Verify whether the company can pay the bill.
CompanyID GetFirstPlayableCompanyID()
Get the index of the first available company.
bool CheckTakeoverVehicleLimit(CompanyID cbig, CompanyID small)
Can company cbig buy company csmall without exceeding vehicle limits?
Money GetAvailableMoneyForCommand()
This functions returns the money which can be used to execute a command.
void CompanyAdminUpdate(const Company *company)
Called whenever company related information changes in order to notify admins.
void SetDParamsForOwnedBy(Owner owner, TileIndex tile)
Set the right DParams for STR_ERROR_OWNED_BY.
void SubtractMoneyFromCompany(const CommandCost &cost)
Subtract money from the _current_company, if the company is valid.
void SubtractMoneyFromCompanyFract(CompanyID company, const CommandCost &cost)
Subtract money from a company, including the money fraction.
bool IsLocalCompany()
Is the current company the local company?
Definition: company_func.h:47
CommandCost CheckOwnership(Owner owner, TileIndex tile=0U)
Check whether the current owner owns something.
Money GetAvailableMoney(CompanyID company)
Get the amount of money that a company has available, or INT64_MAX if there is no such valid company.
void UpdateLandscapingLimits()
Update the landscaping limits per company.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:52
CompanyManagerFace _company_manager_face
for company manager face storage in openttd.cfg
Definition: company_cmd.cpp:55
void SetLocalCompany(CompanyID new_company)
Sets the local company and updates the settings that are set on a per-company basis to reflect the co...
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:53
Types related to companies.
uint32_t CompanyManagerFace
Company manager face bits, info see in company_manager_face.h.
Definition: company_type.h:52
Owner
Enum for all companies/owners.
Definition: company_type.h:18
@ MAX_COMPANIES
Maximum number of companies.
Definition: company_type.h:23
Types related to the graphics and/or input devices.
Types related to vehicles.
VehicleType
Available vehicle types.
Definition: vehicle_type.h:21