Handling of NewGRF industries. More...

#include "stdafx.h"
#include "debug.h"
#include "industry.h"
#include "newgrf_badge.h"
#include "newgrf_industries.h"
#include "newgrf_town.h"
#include "newgrf_cargo.h"
#include "window_func.h"
#include "town.h"
#include "company_base.h"
#include "error.h"
#include "strings_func.h"
#include "core/random_func.hpp"
#include "timer/timer_game_calendar.h"
#include "table/strings.h"
#include "safeguards.h"

Functions
IndustryType	MapNewGRFIndustryType (IndustryType grf_type, uint32_t grf_id)
	Map the GRF local type to an industry type.

uint32_t	GetIndustryIDAtOffset (TileIndex tile, const Industry *i, uint32_t cur_grfid)
	Make an analysis of a tile and check for its belonging to the same industry, and/or the same grf file.

static uint32_t	GetClosestIndustry (TileIndex tile, IndustryType type, const Industry *current)

static uint32_t	GetCountAndDistanceOfClosestInstance (const ResolverObject &object, uint8_t param_set_id, uint8_t layout_filter, bool town_filter, const Industry *current)
	Implementation of both var 67 and 68 since the mechanism is almost the same, it is easier to regroup them on the same function.

static const GRFFile *	GetGrffile (IndustryType type)
	Get the grf file associated with the given industry type.

uint16_t	GetIndustryCallback (CallbackID callback, uint32_t param1, uint32_t param2, Industry *industry, IndustryType type, TileIndex tile, std::span< int32_t > regs100)
	Perform an industry callback.

CommandCost	CheckIfCallBackAllowsCreation (TileIndex tile, IndustryType type, size_t layout, uint32_t seed, uint16_t initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type)
	Check that the industry callback allows creation of the industry.

uint32_t	GetIndustryProbabilityCallback (IndustryType type, IndustryAvailabilityCallType creation_type, uint32_t default_prob)
	Check with callback CBID_INDUSTRY_PROBABILITY whether the industry can be built.

void	IndustryProductionCallback (Industry *ind, int reason)
	Get the industry production callback and apply it to the industry.

bool	IndustryTemporarilyRefusesCargo (Industry *ind, CargoType cargo_type)
	Check whether an industry temporarily refuses to accept a certain cargo.

Variables
IndustryOverrideManager	_industry_mngr (NEW_INDUSTRYOFFSET, NUM_INDUSTRYTYPES, IT_INVALID)

IndustryTileOverrideManager	_industile_mngr (NEW_INDUSTRYTILEOFFSET, NUM_INDUSTRYTILES, INVALID_INDUSTRYTILE)

Detailed Description

Handling of NewGRF industries.

Definition in file newgrf_industries.cpp.

Function Documentation

◆ CheckIfCallBackAllowsCreation()

CommandCost CheckIfCallBackAllowsCreation	(	TileIndex	tile,
		IndustryType	type,
		size_t	layout,
		uint32_t	seed,
		uint16_t	initial_random_bits,
		Owner	founder,
		IndustryAvailabilityCallType	creation_type
	)

Check that the industry callback allows creation of the industry.

Parameters

tile	Tile to build the industry.
type	Type of industry to build.
layout	Layout number.
seed	Seed for the random generator.
initial_random_bits	The random bits the industry is going to have after construction.
founder	Industry founder
creation_type	The circumstances the industry is created under.

Returns: Succeeded or failed command.

Definition at line 545 of file newgrf_industries.cpp.

References CALLBACK_FAILED, CBID_INDUSTRY_LOCATION, ClosestTownFromTile(), Industry::founder, GetErrorMessageFromLocationCallbackResult(), GetIndustrySpec(), IndustrySpec::grf_prop, GRFFilePropsBase::grffile, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem< Tpool >::index, Industry::location, Industry::psa, Industry::random, Industry::selected_layout, OrthogonalTileArea::tile, Industry::town, Industry::type, and OrthogonalTileArea::w.

Referenced by CreateNewIndustryHelper().

◆ GetClosestIndustry()

static uint32_t GetClosestIndustry	(	TileIndex	tile,
		IndustryType	type,
		const Industry *	current
	)

static

Definition at line 93 of file newgrf_industries.cpp.

◆ GetCountAndDistanceOfClosestInstance()

static uint32_t GetCountAndDistanceOfClosestInstance	(	const ResolverObject &	object,
		uint8_t	param_set_id,
		uint8_t	layout_filter,
		bool	town_filter,
		const Industry *	current
	)

static

Implementation of both var 67 and 68 since the mechanism is almost the same, it is easier to regroup them on the same function.

Parameters

object	ResolverObject owning the temporary storage.
param_set_id	parameter given to the callback, which is the set id, or the local id, in our terminology
layout_filter	on what layout do we filter?
town_filter	Do we filter on the same town as the current industry?
current	Industry for which the inquiry is made

Returns: the formatted answer to the callback : rr(reserved) cc(count) dddd(manhattan distance of closest sister)

< Get the GRFID of the definition to look for in register 100h

Definition at line 117 of file newgrf_industries.cpp.

References DistanceManhattan(), GB(), Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem<&_industry_pool >::Get(), GetIndustrySpec(), Industry::GetIndustryTypeCount(), IndustrySpec::grf_prop, GRFFilePropsBase::grfid, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem< Tpool >::index, Industry::industries, Industry::location, MapNewGRFIndustryType(), NUM_INDUSTRYTYPES, Industry::selected_layout, SetBit(), OrthogonalTileArea::tile, Industry::town, and Industry::type.

Referenced by IndustriesScopeResolver::GetVariable(), and ObjectScopeResolver::GetVariable().

◆ GetGrffile()

static const GRFFile * GetGrffile ( IndustryType type )

static

Get the grf file associated with the given industry type.

Parameters

type	Industry type to query.

Returns: The associated GRF file, if any.

Definition at line 462 of file newgrf_industries.cpp.

References GetIndustrySpec(), IndustrySpec::grf_prop, and GRFFilePropsBase::grffile.

◆ GetIndustryCallback()

uint16_t GetIndustryCallback	(	CallbackID	callback,
		uint32_t	param1,
		uint32_t	param2,
		Industry *	industry,
		IndustryType	type,
		TileIndex	tile,
		std::span< int32_t >	regs100
	)

Perform an industry callback.

Parameters

	callback	The callback to perform.
	param1	The first parameter.
	param2	The second parameter.
	industry	The industry to do the callback for.
	type	The type of industry to do the callback for.
	tile	The tile associated with the callback.
[out]	regs100	Additional result values from registers 100+

Returns: The callback result.

Definition at line 528 of file newgrf_industries.cpp.

Referenced by ChangeIndustryProduction(), DoCreateNewIndustry(), IndustryViewWindow::DrawInfo(), BuildIndustryWindow::DrawWidget(), GetCargoSuffix(), GetIndustryProbabilityCallback(), and IndustryTemporarilyRefusesCargo().

◆ GetIndustryIDAtOffset()

uint32_t GetIndustryIDAtOffset	(	TileIndex	tile,
		const Industry *	i,
		uint32_t	cur_grfid
	)

Make an analysis of a tile and check for its belonging to the same industry, and/or the same grf file.

Parameters

tile	TileIndex of the tile to query
i	Industry to which to compare the tile to
cur_grfid	GRFID of the current callback chain

Returns: value encoded as per NFO specs

Definition at line 57 of file newgrf_industries.cpp.

References GetCleanIndustryGfx(), GetIndustryTileSpec(), IndustryTileSpec::grf_prop, GRFFilePropsBase::grfid, StandardGRFFileProps::HasSpriteGroups(), INVALID_INDUSTRYTILE, GRFFilePropsBase::local_id, NEW_INDUSTRYTILEOFFSET, SubstituteGRFFileProps::override_id, and Industry::TileBelongsToIndustry().

Referenced by IndustriesScopeResolver::GetVariable(), and IndustryTileScopeResolver::GetVariable().

◆ GetIndustryProbabilityCallback()

uint32_t GetIndustryProbabilityCallback	(	IndustryType	type,
		IndustryAvailabilityCallType	creation_type,
		uint32_t	default_prob
	)

Check with callback CBID_INDUSTRY_PROBABILITY whether the industry can be built.

Parameters

type	Industry type to check.
creation_type	Reason to construct a new industry.

Returns: If the industry has no callback or allows building, true is returned. Otherwise, false is returned.

Definition at line 577 of file newgrf_industries.cpp.

References CALLBACK_FAILED, IndustrySpec::callback_mask, CBID_INDUSTRY_PROBABILITY, ErrorUnknownCallbackResult(), GetIndustryCallback(), GetIndustrySpec(), IndustrySpec::grf_prop, GRFFilePropsBase::grffile, GRFFilePropsBase::grfid, INVALID_TILE, Probability, and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test().

Referenced by CmdBuildIndustry(), GetIndustryGamePlayProbability(), and GetScaledIndustryGenerationProbability().

◆ IndustryProductionCallback()

void IndustryProductionCallback	(	Industry *	ind,
		int	reason
	)

Get the industry production callback and apply it to the industry.

Parameters

ind	the industry this callback has to be called for
reason	the reason it is called (0 = incoming cargo, 1 = periodic tick callback)

Definition at line 605 of file newgrf_industries.cpp.

References Industry::accepted, IndustrySpec::behaviour, Industry::GetCargoAccepted(), Industry::GetCargoProduced(), GetEncodedString(), GetIndustrySpec(), IndustrySpec::grf_prop, GRFFilePropsBase::grffile, Pool< Titem, Tindex, Tgrowth_step, Tpool_type, Tcache >::PoolItem< Tpool >::index, IsValidCargoType(), Industry::location, IndustrySpec::name, Industry::prod_level, ProdCallbackRandom, ProdMultiHandling, Industry::produced, Random, SB(), SetWindowDirty(), ShowErrorMessage(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), OrthogonalTileArea::tile, Industry::type, WC_INDUSTRY_VIEW, and WL_WARNING.

Referenced by DoCreateNewIndustry(), and TriggerIndustryProduction().

◆ IndustryTemporarilyRefusesCargo()

bool IndustryTemporarilyRefusesCargo	(	Industry *	ind,
		CargoType	cargo_type
	)

Check whether an industry temporarily refuses to accept a certain cargo.

Parameters

ind	The industry to query.
cargo_type	The cargo to get information about.

Precondition: cargo_type is in ind->accepts_cargo.

Returns: Whether the given industry refuses to accept this cargo type.

Definition at line 687 of file newgrf_industries.cpp.

References CALLBACK_FAILED, IndustrySpec::callback_mask, GRFFile::cargo_map, CBID_INDUSTRY_REFUSE_CARGO, ConvertBooleanCallback(), GetIndustryCallback(), GetIndustrySpec(), IndustrySpec::grf_prop, GRFFilePropsBase::grffile, Industry::IsCargoAccepted(), Industry::location, RefuseCargo, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), OrthogonalTileArea::tile, and Industry::type.

Referenced by CanCargoServiceIndustry(), DeliverGoodsToIndustry(), and IndustryDirectoryWindow::DrawWidget().

◆ MapNewGRFIndustryType()

IndustryType MapNewGRFIndustryType	(	IndustryType	grf_type,
		uint32_t	grf_id
	)

Map the GRF local type to an industry type.

Parameters

grf_type	The GRF local type.
grf_id	The GRF of the local type.

Returns: The industry type in the global scope.

Definition at line 41 of file newgrf_industries.cpp.

References GB(), IndustryOverrideManager::GetID(), and HasBit().

Referenced by FinaliseIndustriesArray(), GetCountAndDistanceOfClosestInstance(), and IndustriesScopeResolver::GetVariable().

Functions

Variables

Detailed Description

Function Documentation

◆ CheckIfCallBackAllowsCreation()

◆ GetClosestIndustry()

◆ GetCountAndDistanceOfClosestInstance()

◆ GetGrffile()

◆ GetIndustryCallback()

◆ GetIndustryIDAtOffset()

◆ GetIndustryProbabilityCallback()

◆ IndustryProductionCallback()

◆ IndustryTemporarilyRefusesCargo()

◆ MapNewGRFIndustryType()