OpenTTD Source  20241121-master-g67a0fccfad
company_cmd.h File Reference

Command definitions related to companies. More...

#include "command_type.h"
#include "company_type.h"
#include "livery.h"

Go to the source code of this file.

Functions

enum ClientID uint32_t enum Colours uint8_t CommandCost CmdCompanyCtrl (DoCommandFlag flags, CompanyCtrlAction cca, CompanyID company_id, CompanyRemoveReason reason, ClientID client_id)
 Control the companies: add, delete, etc. More...
 
CommandCost CmdCompanyAllowListCtrl (DoCommandFlag flags, CompanyAllowListCtrlAction action, const std::string &public_key)
 Add or remove the given public key to the allow list of this company. More...
 
CommandCost CmdGiveMoney (DoCommandFlag flags, Money money, CompanyID dest_company)
 Transfer funds (money) from one company to another. More...
 
CommandCost CmdRenameCompany (DoCommandFlag flags, const std::string &text)
 Change the name of the company. More...
 
CommandCost CmdRenamePresident (DoCommandFlag flags, const std::string &text)
 Change the name of the president. More...
 
CommandCost CmdSetCompanyManagerFace (DoCommandFlag flags, CompanyManagerFace cmf)
 Change the company manager's face. More...
 
CommandCost CmdSetCompanyColour (DoCommandFlag flags, LiveryScheme scheme, bool primary, Colours colour)
 Change the company's company-colour. More...
 

Detailed Description

Command definitions related to companies.

Definition in file company_cmd.h.

Function Documentation

◆ CmdCompanyAllowListCtrl()

CommandCost CmdCompanyAllowListCtrl ( DoCommandFlag  flags,
CompanyAllowListCtrlAction  action,
const std::string &  public_key 
)

Add or remove the given public key to the allow list of this company.

Parameters
flagsOperation to perform.
actionThe action to perform.
public_keyThe public key of the client to add or remove.
Returns
The cost of this operation or an error.

Definition at line 1004 of file company_cmd.cpp.

References _current_company, CALCA_ADD, CALCA_REMOVE, CMD_ERROR, DC_EXEC, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::GetIfValid(), and NETWORK_PUBLIC_KEY_LENGTH.

◆ CmdCompanyCtrl()

enum ClientID uint32_t enum Colours uint8_t CommandCost CmdCompanyCtrl ( DoCommandFlag  flags,
CompanyCtrlAction  cca,
CompanyID  company_id,
CompanyRemoveReason  reason,
ClientID  client_id 
)

◆ CmdGiveMoney()

CommandCost CmdGiveMoney ( DoCommandFlag  flags,
Money  money,
CompanyID  dest_company 
)

Transfer funds (money) from one company to another.

To prevent abuse in multiplayer games you can only send money to other companies if you have paid off your loan (either explicitly, or implicitly given the fact that you have more money than loan).

Parameters
flagsoperation to perform
moneythe amount of money to transfer; max 20.000.000
dest_companythe company to transfer the money to
Returns
the cost of this operation or an error

Definition at line 1296 of file company_cmd.cpp.

References _current_company, _networking, _settings_game, CMD_ERROR, CompanyProperties::current_loan, DC_EXEC, GameSettings::economy, EXPENSES_OTHER, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), CommandCost::GetCost(), GetString(), EconomySettings::give_money, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::IsValidID(), CompanyProperties::money, Backup< T >::Restore(), return_cmd_error, SetDParam(), and SubtractMoneyFromCompany().

◆ CmdRenameCompany()

CommandCost CmdRenameCompany ( DoCommandFlag  flags,
const std::string &  text 
)

Change the name of the company.

Parameters
flagsoperation to perform
textthe new name or an empty string when resetting to the default
Returns
the cost of this operation or an error

Definition at line 1169 of file company_cmd.cpp.

References _current_company, CMD_ERROR, CompanyAdminUpdate(), DC_EXEC, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), IsUniqueCompanyName(), MarkWholeScreenDirty(), MAX_LENGTH_COMPANY_NAME_CHARS, CompanyProperties::name, return_cmd_error, and Utf8StringLength().

◆ CmdRenamePresident()

CommandCost CmdRenamePresident ( DoCommandFlag  flags,
const std::string &  text 
)

◆ CmdSetCompanyColour()

CommandCost CmdSetCompanyColour ( DoCommandFlag  flags,
LiveryScheme  scheme,
bool  primary,
Colours  colour 
)

Change the company's company-colour.

Parameters
flagsoperation to perform
schemescheme to set
primaryset first/second colour
colournew colour for vehicles, property, etc.
Returns
the cost of this operation or an error

Definition at line 1070 of file company_cmd.cpp.

◆ CmdSetCompanyManagerFace()

CommandCost CmdSetCompanyManagerFace ( DoCommandFlag  flags,
CompanyManagerFace  cmf 
)

Change the company manager's face.

Parameters
flagsoperation to perform
cmfface bitmasked
Returns
the cost of this operation or an error

Definition at line 1037 of file company_cmd.cpp.

References _current_company, CMD_ERROR, DC_EXEC, Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_company_pool >::Get(), IsValidCompanyManagerFace(), and MarkWholeScreenDirty().