Common return value for all commands. More...

#include <command_type.h>

Public Member Functions
	CommandCost ()
	Creates a command cost return with no cost and no error.

	CommandCost (StringID msg, StringID extra_msg=INVALID_STRING_ID)
	Creates a command return value with one, or optionally two, error message strings.

	CommandCost (ExpensesType ex_t)
	Creates a command cost with given expense type and start cost of 0.

	CommandCost (ExpensesType ex_t, const Money &cst)
	Creates a command return value with the given start cost and expense type.

void	SetErrorOwner (Owner owner)
	Set the 'owner' (the originator) of this error message.

CompanyID	GetErrorOwner () const
	Get the originator owner for this error.

void	AddCost (const Money &cost)
	Adds the given cost to the cost of the command.

void	AddCost (const CommandCost &cmd_cost)
	Adds the cost of the given command return value to this cost.

void	MultiplyCost (int factor)
	Multiplies the cost of the command by the given factor.

Money	GetCost () const
	The costs as made up to this moment.

ExpensesType	GetExpensesType () const
	The expense type of the cost.

void	MakeError (StringID message)
	Makes this CommandCost behave like an error command.

StringID	GetErrorMessage () const
	Returns the error message of a command.

StringID	GetExtraErrorMessage () const
	Returns the extra error message of a command.

bool	Succeeded () const
	Did this command succeed?

bool	Failed () const
	Did this command fail?

Static Public Member Functions
static void	SetEncodedMessage (EncodedString &&message)
	Set the encoded message string.

static EncodedString &	GetEncodedMessage ()
	Get the last encoded error message.

Private Attributes
Money	cost
	The cost of this action.

StringID	message
	Warning message for when success is unset.

ExpensesType	expense_type
	the type of expence as shown on the finances view

bool	success
	Whether the command went fine up to this moment.

Owner	owner = CompanyID::Invalid()
	Originator owner of error.

StringID	extra_message = INVALID_STRING_ID
	Additional warning message for when success is unset.

Static Private Attributes
static EncodedString	encoded_message
	Encoded error message, used if the error message includes parameters.

Detailed Description

Common return value for all commands.

Wraps the cost and a possible error message/state together.

Definition at line 24 of file command_type.h.

Constructor & Destructor Documentation

◆ CommandCost() [1/4]

CommandCost::CommandCost ( )

inline

Creates a command cost return with no cost and no error.

Definition at line 38 of file command_type.h.

◆ CommandCost() [2/4]

CommandCost::CommandCost	(	StringID	msg,
		StringID	extra_msg = `INVALID_STRING_ID`
	)

inlineexplicit

Creates a command return value with one, or optionally two, error message strings.

Definition at line 43 of file command_type.h.

◆ CommandCost() [3/4]

CommandCost::CommandCost ( ExpensesType ex_t )

inlineexplicit

Creates a command cost with given expense type and start cost of 0.

Parameters

ex_t	the expense type

Definition at line 49 of file command_type.h.

◆ CommandCost() [4/4]

CommandCost::CommandCost	(	ExpensesType	ex_t,
		const Money &	cst
	)

inline

Creates a command return value with the given start cost and expense type.

Parameters

ex_t	the expense type
cst	the initial cost of this command

Definition at line 56 of file command_type.h.

Member Function Documentation

◆ AddCost() [1/2]

void CommandCost::AddCost ( const CommandCost & ret )

Adds the cost of the given command return value to this cost.

Also takes a possible error message when it is set.

Parameters

ret	The command to add the cost of.

Definition at line 401 of file command.cpp.

References AddCost(), cost, message, and success.

◆ AddCost() [2/2]

void CommandCost::AddCost ( const Money & cost )

inline

Adds the given cost to the cost of the command.

Parameters

cost	the cost to add

Definition at line 99 of file command_type.h.

References cost.

Referenced by AddCost(), BuildReplacementVehicle(), CalculateRailStationCost(), CalculateRoadStopCost(), CheckBuildableTile(), CheckFlatLandAirport(), CheckFlatLandRailStation(), CheckFlatLandRoadStop(), ClearTile_Town(), CmdAutoreplaceVehicle(), CmdBuildAirport(), CmdBuildBridge(), CmdBuildBuoy(), CmdBuildCanal(), CmdBuildDock(), CmdBuildLongRoad(), CmdBuildObject(), CmdBuildObjectArea(), CmdBuildRailWaypoint(), CmdBuildRoad(), CmdBuildRoadDepot(), CmdBuildShipDepot(), CmdBuildSingleRail(), CmdBuildTrainDepot(), CmdBuildTunnel(), CmdBuildVehicle(), CmdClearArea(), CmdCloneVehicle(), CmdConvertRail(), CmdConvertRoad(), CmdDepotMassAutoReplace(), CmdDepotSellAllVehicles(), CmdLandscapeClear(), CmdLevelLand(), CmdPlantTree(), CmdRailTrackHelper(), CmdRemoveLongRoad(), CmdRemoveSingleRail(), CmdSellRailWagon(), CmdSignalTrackHelper(), CmdTerraformLand(), CompaniesGenStatistics(), CopyHeadSpecificThings(), DoBuildLock(), RefitVehicle(), RemoveAirport(), RemoveFromRailBaseStation(), RemoveGenericRoadStop(), RemoveRailStation(), RemoveRoad(), ReplaceChain(), ReplaceFreeUnit(), TerraformTileHeight(), and TestAutoslopeOnRailTile().

◆ Failed()

bool CommandCost::Failed ( ) const

inline

Did this command fail?

Returns: true if and only if it failed

Definition at line 178 of file command_type.h.

References success.

Referenced by BuildReplacementVehicle(), BuildStationPart(), CalculateRailStationCost(), CalculateRoadStopCost(), CanRemoveRoadWithStop(), CcAddVehicleNewGroup(), CcBuildBridge(), CcBuildPrimaryVehicle(), CcBuildWagon(), CcCloneVehicle(), CcCreateGroup(), CcPlaceSign(), CcRoadStop(), CcStartStopVehicle(), CheckAllowRemoveRoad(), CheckBuildableTile(), CheckFlatLandAirport(), CheckFlatLandRailStation(), CheckFlatLandRoadStop(), CheckIfIndustryTilesAreFree(), CheckIfIndustryTileSlopes(), ClearTile_Station(), CmdAutofillTimetable(), CmdAutoreplaceVehicle(), CmdBuildAirport(), CmdBuildBridge(), CmdBuildBuoy(), CmdBuildCanal(), CmdBuildDock(), CmdBuildIndustry(), CmdBuildLongRoad(), CmdBuildObject(), CmdBuildObjectArea(), CmdBuildRailStation(), CmdBuildRailWaypoint(), CmdBuildRoad(), CmdBuildRoadDepot(), CmdBuildRoadStop(), CmdBuildRoadWaypoint(), CmdBuildShipDepot(), CmdBuildSingleRail(), CmdBuildSingleSignal(), CmdBuildTrainDepot(), CmdBuildTunnel(), CmdBulkChangeTimetable(), CmdChangeServiceInt(), CmdChangeTimetable(), CmdClearArea(), CmdCloneOrder(), CmdCloneVehicle(), CmdConvertRail(), CmdConvertRoad(), CmdDeleteOrder(), CmdDeleteTown(), CmdDoTownAction(), CmdForceTrainProceed(), CmdFoundTown(), CmdInsertOrder(), CmdLevelLand(), CmdModifyOrder(), CmdMoveOrder(), CmdMoveRailVehicle(), CmdOpenCloseAirport(), CmdOrderRefit(), CmdPlantTree(), CmdRailTrackHelper(), CmdRefitVehicle(), CmdRemoveFromRailStation(), CmdRemoveSingleRail(), CmdRemoveSingleSignal(), CmdRenameDepot(), CmdRenameStation(), CmdRenameVehicle(), CmdRenameWaypoint(), CmdReverseTrainDirection(), CmdSellRailWagon(), CmdSellVehicle(), CmdSetTimetableStart(), CmdSetVehicleOnTime(), CmdSignalTrackHelper(), CmdSkipToOrder(), CmdStartStopVehicle(), CmdTerraformLand(), CmdTurnRoadVeh(), CreateNewIndustry(), CreateNewIndustryHelper(), DoBuildLock(), DoClearBridge(), DoClearTunnel(), ScriptInstance::DoCommandCallback(), ExploreSegment(), FindJoiningBaseStation(), CommandHelperBase::InternalExecuteProcessResult(), CommandHelperBase::InternalExecuteValidateTestAndPrepExec(), CommandHelperBase::InternalPostResult(), IsRoadAllowedHere(), IsValidTileForWaypoint(), RemoveAirport(), RemoveBuoy(), RemoveDock(), RemoveFromRailBaseStation(), RemoveGenericRoadStop(), RemoveLock(), RemoveRailStation(), RemoveRoad(), RemoveRoadStop(), RemoveRoadWaypointStop(), ReplaceChain(), Vehicle::SendToDepot(), ShowBuildBridgeWindow(), ValidateTrains(), and VehicleEnterDepot().

◆ GetCost()

Money CommandCost::GetCost ( ) const

inline

The costs as made up to this moment.

Returns: the costs

Definition at line 119 of file command_type.h.

References cost.

Referenced by CheckCompanyHasMoney(), CmdAutoreplaceVehicle(), CmdBuildBridge(), CmdBuildCanal(), CmdBuildObjectArea(), CmdBuildRoad(), CmdBuildTunnel(), CmdBuildVehicle(), CmdClearArea(), CmdFoundTown(), CmdGiveMoney(), CmdLevelLand(), CmdPlantTree(), CmdRemoveLongRoad(), ScriptInstance::DoCommandCallback(), HandleStationRefit(), CommandHelperBase::InternalExecuteProcessResult(), CommandHelperBase::InternalPostResult(), Aircraft::OnNewEconomyDay(), RoadVehicle::OnNewEconomyDay(), Ship::OnNewEconomyDay(), Train::OnNewEconomyDay(), ReplaceChain(), ShowBuildBridgeWindow(), SubtractMoneyFromAnyCompany(), SubtractMoneyFromCompanyFract(), and VehicleEnterDepot().

◆ GetEncodedMessage()

static EncodedString & CommandCost::GetEncodedMessage ( )

inlinestatic

Get the last encoded error message.

Returns: Reference to the encoded message.

Definition at line 82 of file command_type.h.

References encoded_message.

Referenced by ShowErrorMessage().

◆ GetErrorMessage()

StringID CommandCost::GetErrorMessage ( ) const

inline

Returns the error message of a command.

Returns: the error message, if succeeded INVALID_STRING_ID

Definition at line 149 of file command_type.h.

References INVALID_STRING_ID, and message.

Referenced by CcBuildIndustry(), CmdBuildLongRoad(), CmdLevelLand(), CmdRailTrackHelper(), CmdRemoveLongRoad(), CmdSignalTrackHelper(), ScriptInstance::DoCommandCallback(), ReplaceChain(), ShowBuildBridgeWindow(), and ShowErrorMessage().

◆ GetErrorOwner()

CompanyID CommandCost::GetErrorOwner ( ) const

inline

Get the originator owner for this error.

Definition at line 90 of file command_type.h.

References owner.

Referenced by ShowErrorMessage().

◆ GetExpensesType()

ExpensesType CommandCost::GetExpensesType ( ) const

inline

The expense type of the cost.

Returns: the expense type

Definition at line 128 of file command_type.h.

References expense_type.

Referenced by SubtractMoneyFromAnyCompany(), and SubtractMoneyFromCompanyFract().

◆ GetExtraErrorMessage()

StringID CommandCost::GetExtraErrorMessage ( ) const

inline

Returns the extra error message of a command.

Returns: the extra error message, if succeeded INVALID_STRING_ID

Definition at line 159 of file command_type.h.

References extra_message, and INVALID_STRING_ID.

Referenced by ShowErrorMessage().

◆ MakeError()

void CommandCost::MakeError ( StringID message )

inline

Makes this CommandCost behave like an error command.

Parameters

message The error message.

Definition at line 137 of file command_type.h.

References INVALID_STRING_ID, and message.

Referenced by CheckCompanyHasMoney(), CmdConvertRail(), and CmdConvertRoad().

◆ MultiplyCost()

void CommandCost::MultiplyCost ( int factor )

inline

Multiplies the cost of the command by the given factor.

Parameters

factor factor to multiply the costs with

Definition at line 110 of file command_type.h.

Referenced by CmdFoundTown().

◆ SetEncodedMessage()

static void CommandCost::SetEncodedMessage ( EncodedString && message )

inlinestatic

Set the encoded message string.

If set, this is used by the error message window instead of the error StringID, to allow more information to be displayed to the local player.

Note: Do not set an encoded message if the error is not for the local player, as it will never be seen.

Parameters

message EncodedString message to set.

Definition at line 73 of file command_type.h.

References encoded_message, and message.

Referenced by CheckCompanyHasMoney(), CmdConvertRoad(), CommandCostWithParam(), and GetErrorMessageFromLocationCallbackResult().

◆ SetErrorOwner()

void CommandCost::SetErrorOwner ( Owner owner )

inline

Set the 'owner' (the originator) of this error message.

This is used to show a company owner's face if you attempt an action on something owned by other company.

Definition at line 62 of file command_type.h.

References owner.

◆ Succeeded()

bool CommandCost::Succeeded ( ) const

inline

Did this command succeed?

Returns: true if and only if it succeeded

Definition at line 169 of file command_type.h.

References success.

Referenced by AddNearbyStation(), BuildReplacementVehicle(), CanBuildTramTrackOnTile(), CcBuildIndustry(), CcBuildRailTunnel(), CcBuildRoadTunnel(), CheckAllowRemoveTunnelBridge(), CheckClearTile(), ClearMakeHouseTile(), CmdAutoreplaceVehicle(), CmdBuildIndustry(), CmdBuildSingleRail(), CmdBuildVehicle(), CmdCloneVehicle(), CmdDepotMassAutoReplace(), CmdDepotSellAllVehicles(), CmdLevelLand(), CmdPlaceHouse(), CmdRemoveLongRoad(), CmdSignalTrackHelper(), CmdTerraformLand(), CopyHeadSpecificThings(), CreateRandomTown(), DoBuildLock(), ScriptInstance::DoCommandCallback(), HandleStationRefit(), CommandHelperBase::InternalDoAfter(), IsValidTileForWaypoint(), RemoveDock(), RemoveLock(), ReplaceChain(), ReplaceFreeUnit(), SendAllVehiclesToDepot(), and ShowBuildBridgeWindow().

Field Documentation

◆ cost

Money CommandCost::cost

private

The cost of this action.

Definition at line 25 of file command_type.h.

Referenced by AddCost(), AddCost(), and GetCost().

◆ encoded_message

EncodedString CommandCost::encoded_message

staticprivate

Encoded error message, used if the error message includes parameters.

Definition at line 32 of file command_type.h.

Referenced by GetEncodedMessage(), and SetEncodedMessage().

◆ expense_type

ExpensesType CommandCost::expense_type

private

the type of expence as shown on the finances view

Definition at line 27 of file command_type.h.

Referenced by GetExpensesType().

◆ extra_message

StringID CommandCost::extra_message = INVALID_STRING_ID

private

Additional warning message for when success is unset.

Definition at line 30 of file command_type.h.

Referenced by GetExtraErrorMessage().

◆ message

StringID CommandCost::message

private

Warning message for when success is unset.

Definition at line 26 of file command_type.h.

Referenced by AddCost(), GetErrorMessage(), MakeError(), and SetEncodedMessage().

◆ owner

Owner CommandCost::owner = CompanyID::Invalid()

private

Originator owner of error.

Definition at line 29 of file command_type.h.

Referenced by GetErrorOwner(), and SetErrorOwner().

◆ success

bool CommandCost::success

private

Whether the command went fine up to this moment.

Definition at line 28 of file command_type.h.

Referenced by AddCost(), Failed(), and Succeeded().

The documentation for this class was generated from the following files:

src/command_type.h
src/command.cpp

Public Member Functions

Static Public Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ CommandCost() [1/4]

◆ CommandCost() [2/4]

◆ CommandCost() [3/4]

◆ CommandCost() [4/4]

Member Function Documentation

◆ AddCost() [1/2]

◆ AddCost() [2/2]

◆ Failed()

◆ GetCost()

◆ GetEncodedMessage()

◆ GetErrorMessage()

◆ GetErrorOwner()

◆ GetExpensesType()

◆ GetExtraErrorMessage()

◆ MakeError()

◆ MultiplyCost()

◆ SetEncodedMessage()

◆ SetErrorOwner()

◆ Succeeded()

Field Documentation

◆ cost

◆ encoded_message

◆ expense_type

◆ extra_message

◆ message

◆ owner

◆ success