Functions related to companies. More...

#include "command_type.h"
#include "company_type.h"
#include "gfx_type.h"
#include "vehicle_type.h"

Functions
bool	CheckTakeoverVehicleLimit (CompanyID cbig, CompanyID small)
	Can company cbig buy company csmall without exceeding vehicle limits?

void	ChangeOwnershipOfCompanyItems (Owner old_owner, Owner new_owner)
	Change the ownership of all the items of a company.

std::array< StringParameter, 2 >	GetParamsForOwnedBy (Owner owner, TileIndex tile)
	Set the right DParams for STR_ERROR_OWNED_BY.

void	SetLocalCompany (CompanyID new_company)
	Sets the local company and updates the settings that are set on a per-company basis to reflect the core's state in the GUI.

void	ShowBuyCompanyDialog (CompanyID company, bool hostile_takeover)
	Show the query to buy another company.

void	CompanyAdminUpdate (const Company *company)
	Called whenever company related information changes in order to notify admins.

void	CompanyAdminBankrupt (CompanyID company_id)

void	UpdateLandscapingLimits ()
	Update the landscaping limits per company.

void	UpdateCompanyLiveries (Company *c)
	Update liveries for a company.

Money	GetAvailableMoney (CompanyID company)
	Get the amount of money that a company has available, or INT64_MAX if there is no such valid company.

Money	GetAvailableMoneyForCommand ()
	This functions returns the money which can be used to execute a command.

bool	CheckCompanyHasMoney (CommandCost &cost)
	Verify whether the company can pay the bill.

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.

CommandCost	CheckOwnership (Owner owner, TileIndex tile={})
	Check whether the current owner owns something.

CommandCost	CheckTileOwnership (TileIndex tile)
	Check whether the current owner owns the stuff on the given tile.

bool	IsLocalCompany ()
	Is the current company the local company?

bool	IsInteractiveCompany (CompanyID company)
	Is the user representing company?

int	CompanyServiceInterval (const Company *c, VehicleType type)
	Get the service interval for the given company and vehicle type.

CompanyID	GetFirstPlayableCompanyID ()
	Get the index of the first available company.

Variables
CompanyID	_local_company
	Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.

CompanyID	_current_company
	Company currently doing an action.

ReferenceThroughBaseContainer< std::array< Colours, MAX_COMPANIES > >	_company_colours
	NOSAVE: can be determined from company structs.

CompanyManagerFace	_company_manager_face
	for company manager face storage in openttd.cfg

Detailed Description

Functions related to companies.

Definition in file company_func.h.

Function Documentation

◆ ChangeOwnershipOfCompanyItems()

void ChangeOwnershipOfCompanyItems	(	Owner	old_owner,
		Owner	new_owner
	)

Change the ownership of all the items of a company.

Parameters

old_owner	The company that gets removed.
new_owner	The company to merge to, or INVALID_OWNER to remove the company.

Definition at line 322 of file economy.cpp.

Referenced by CmdCompanyCtrl(), and ResetLandscapeConfirmationCallback().

◆ CheckCompanyHasMoney()

bool CheckCompanyHasMoney ( CommandCost & cost )

Verify whether the company can pay the bill.

Parameters

[in,out] cost Money to pay, is changed to an error if the company does not have enough money.

Returns: Function returns true if the company has enough money or infinite money is enabled, else it returns false.

Definition at line 240 of file company_cmd.cpp.

References _current_company, _settings_game, GameSettings::difficulty, CommandCost::GetCost(), GetEncodedString(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::GetIfValid(), DifficultySettings::infinite_money, IsLocalCompany(), CommandCost::MakeError(), CompanyProperties::money, and CommandCost::SetEncodedMessage().

Referenced by CmdCloneVehicle(), CommandHelperBase::InternalDoAfter(), and CommandHelperBase::InternalExecuteValidateTestAndPrepExec().

◆ CheckOwnership()

CommandCost CheckOwnership	(	Owner	owner,
		TileIndex	tile
	)

Check whether the current owner owns something.

If that isn't the case an appropriate error will be given.

Parameters

owner	the owner of the thing to check.
tile	optional tile to get the right town.

Precondition: if tile == 0 then the owner can't be OWNER_TOWN.

Returns: A succeeded command iff it's owned by the current company, else a failed command.

Definition at line 358 of file company_cmd.cpp.

References _current_company, GetEncodedStringWithArgs(), GetParamsForOwnedBy(), IsLocalCompany(), OWNER_END, and OWNER_TOWN.

Referenced by CanRemoveRoadWithStop(), CheckAllowRemoveRoad(), CheckAllowRemoveTunnelBridge(), CheckFlatLandRoadStop(), CheckTileOwnership(), CmdAutofillTimetable(), CmdAutoreplaceVehicle(), CmdBuildObject(), CmdBuildRoad(), CmdBuildSingleRail(), CmdBulkChangeTimetable(), CmdChangeServiceInt(), CmdChangeTimetable(), CmdCloneOrder(), CmdCloneVehicle(), CmdConvertRoad(), CmdDeleteOrder(), CmdForceTrainProceed(), CmdInsertOrder(), CmdModifyOrder(), CmdMoveOrder(), CmdMoveRailVehicle(), CmdOpenCloseAirport(), CmdOrderRefit(), CmdRefitVehicle(), CmdRenameStation(), CmdRenameVehicle(), CmdRenameWaypoint(), CmdReverseTrainDirection(), CmdSellVehicle(), CmdSetTimetableStart(), CmdSetVehicleOnTime(), CmdSkipToOrder(), CmdStartStopVehicle(), CmdTurnRoadVeh(), IsValidTileForWaypoint(), RemoveAirport(), RemoveDock(), RemoveFromRailBaseStation(), RemoveRailStation(), RemoveRoadStop(), RemoveRoadWaypointStop(), and Vehicle::SendToDepot().

◆ CheckTakeoverVehicleLimit()

bool CheckTakeoverVehicleLimit	(	CompanyID	cbig,
		CompanyID	csmall
	)

Can company cbig buy company csmall without exceeding vehicle limits?

Parameters

cbig	Company buying csmall.
csmall	Company getting bought.

Returns: Return true if it is allowed.

Definition at line 667 of file company_cmd.cpp.

References _settings_game, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::Get(), Company::group_all, VehicleSettings::max_aircraft, VehicleSettings::max_roadveh, VehicleSettings::max_ships, VehicleSettings::max_trains, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, VEH_TRAIN, and GameSettings::vehicle.

Referenced by CmdBuyCompany(), and HandleBankruptcyTakeover().

◆ CheckTileOwnership()

CommandCost CheckTileOwnership ( TileIndex tile )

Check whether the current owner owns the stuff on the given tile.

If that isn't the case an appropriate error will be given.

Parameters

tile	the tile to check.

Returns: A succeeded command iff it's owned by the current company, else a failed command.

Definition at line 381 of file company_cmd.cpp.

References CheckOwnership(), and GetTileOwner().

Referenced by CheckAllowRemoveTunnelBridge(), CmdBuildRoad(), CmdBuildRoadDepot(), CmdBuildSingleRail(), CmdBuildSingleSignal(), CmdBuildTrainDepot(), CmdConvertRail(), CmdRemoveSingleRail(), CmdRemoveSingleSignal(), CmdRenameDepot(), and RemoveLock().

◆ CompanyAdminUpdate()

void CompanyAdminUpdate ( const Company * company )

Called whenever company related information changes in order to notify admins.

Parameters

company The company data changed of.

Definition at line 830 of file company_cmd.cpp.

References _network_server, and NetworkAdminCompanyUpdate().

Referenced by CmdRenameCompany(), CmdRenamePresident(), CmdSetCompanyColour(), and CompanyCheckBankrupt().

◆ CompanyServiceInterval()

int CompanyServiceInterval	(	const Company *	c,
		VehicleType	type
	)

Get the service interval for the given company and vehicle type.

Parameters

c	The company, or nullptr for client-default settings.
type	The vehicle type to get the interval for.

Returns: The service interval.

Definition at line 1242 of file company_cmd.cpp.

References _settings_client, ClientSettings::company, VehicleDefaultSettings::servint_aircraft, VehicleDefaultSettings::servint_roadveh, VehicleDefaultSettings::servint_ships, VehicleDefaultSettings::servint_trains, CompanyProperties::settings, VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, VEH_TRAIN, and CompanySettings::vehicle.

Referenced by ChangeOwnershipOfCompanyItems(), CmdChangeServiceInt(), and UpdateAllServiceInterval().

◆ GetAvailableMoney()

Money GetAvailableMoney ( CompanyID company )

Get the amount of money that a company has available, or INT64_MAX if there is no such valid company.

Parameters

company Company to check

Returns: The available money of the company or INT64_MAX

Definition at line 215 of file company_cmd.cpp.

References _settings_game, GameSettings::difficulty, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::Get(), DifficultySettings::infinite_money, and Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_company_pool >::IsValidID().

Referenced by CompaniesPayInterest(), TownAuthorityWindow::DrawWidget(), GetAvailableMoneyForCommand(), GetMaskOfTownActions(), and Vehicle::NeedsServicing().

◆ GetAvailableMoneyForCommand()

Money GetAvailableMoneyForCommand ( )

This functions returns the money which can be used to execute a command.

This is either the money of the current company, or INT64_MAX if infinite money is enabled or there is no such a company "at the moment" like the server itself.

Returns: The available money of the current company or INT64_MAX

Definition at line 229 of file company_cmd.cpp.

References _current_company, and GetAvailableMoney().

Referenced by CmdBuildObjectArea(), CmdClearArea(), CmdDecreaseLoan(), CmdFoundTown(), CmdLevelLand(), and CmdRemoveLongRoad().

◆ GetFirstPlayableCompanyID()

CompanyID GetFirstPlayableCompanyID ( )

Get the index of the first available company.

It attempts, from first to last, and as soon as the attempt succeeds, to get the index of the company: 1st - get the first existing human company. 2nd - get the first non-existing company. 3rd - get CompanyID::Begin().