Functions for NewGRF industries. More...

#include "newgrf_town.h"

Data Structures
struct	IndustriesScopeResolver
	Resolver for industry scopes. More...

struct	IndustriesResolverObject
	Resolver for industries. More...

Enumerations
enum	IndustryTrigger : uint8_t { INDUSTRY_TRIGGER_TILELOOP_PROCESS = 1 , INDUSTRY_TRIGGER_256_TICKS = 2 , INDUSTRY_TRIGGER_CARGO_DELIVERY = 4 }
	When should the industry(tile) be triggered for random bits? More...

enum	IndustryAvailabilityCallType : uint8_t { IACT_MAPGENERATION , IACT_RANDOMCREATION , IACT_USERCREATION , IACT_PROSPECTCREATION }
	From where has callback CBID_INDUSTRY_PROBABILITY been called. More...

Functions
uint16_t	GetIndustryCallback (CallbackID callback, uint32_t param1, uint32_t param2, Industry *industry, IndustryType type, TileIndex tile)
	Perform an industry callback.

uint32_t	GetIndustryIDAtOffset (TileIndex new_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.

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

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.

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

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

uint32_t	GetNearbyIndustryTileInformation (uint8_t parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8)
	Based on newhouses equivalent, but adapted for newindustries.

Detailed Description

Functions for NewGRF industries.

Definition in file newgrf_industries.h.

Enumeration Type Documentation

◆ IndustryAvailabilityCallType

enum IndustryAvailabilityCallType : uint8_t

From where has callback CBID_INDUSTRY_PROBABILITY been called.

Enumerator
IACT_MAPGENERATION	during random map generation
IACT_RANDOMCREATION	during creation of random ingame industry
IACT_USERCREATION	from the Fund/build window
IACT_PROSPECTCREATION	from the Fund/build using prospecting

Definition at line 81 of file newgrf_industries.h.

◆ IndustryTrigger

enum IndustryTrigger : uint8_t

When should the industry(tile) be triggered for random bits?

Enumerator
INDUSTRY_TRIGGER_TILELOOP_PROCESS	Triggered each tile loop.
INDUSTRY_TRIGGER_256_TICKS	Triggered (whole industry) each 256 ticks.
INDUSTRY_TRIGGER_CARGO_DELIVERY	Triggered on cargo delivery.

Definition at line 71 of file newgrf_industries.h.

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 540 of file newgrf_industries.cpp.

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

Referenced by CreateNewIndustryHelper().

◆ GetIndustryCallback()

uint16_t GetIndustryCallback	(	CallbackID	callback,
		uint32_t	param1,
		uint32_t	param2,
		Industry *	industry,
		IndustryType	type,
		TileIndex	tile
	)

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.

Returns: The callback result.

Definition at line 523 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 56 of file newgrf_industries.cpp.

References GetCleanIndustryGfx(), GetIndustryTileSpec(), IndustryTileSpec::grf_prop, GRFFilePropsBase< Tcnt >::grfid, INVALID_INDUSTRYTILE, GRFFilePropsBase< Tcnt >::local_id, NEW_INDUSTRYTILEOFFSET, GRFFileProps::override, GRFFilePropsBase< Tcnt >::spritegroup, 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 571 of file newgrf_industries.cpp.

References CALLBACK_FAILED, IndustrySpec::callback_mask, CBID_INDUSTRY_PROBABILITY, ErrorUnknownCallbackResult(), GetIndustryCallback(), GetIndustrySpec(), IndustrySpec::grf_prop, GRFFilePropsBase< Tcnt >::grffile, GRFFilePropsBase< Tcnt >::grfid, INVALID_TILE, Probability, and EnumBitSet< Tenum, Tstorage >::Test().

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

◆ GetNearbyIndustryTileInformation()

uint32_t GetNearbyIndustryTileInformation	(	uint8_t	parameter,
		TileIndex	tile,
		IndustryID	index,
		bool	signed_offsets,
		bool	grf_version8
	)

Based on newhouses equivalent, but adapted for newindustries.

Parameters

parameter	from callback. It's in fact a pair of coordinates
tile	TileIndex from which the callback was initiated
index	of the industry been queried for
signed_offsets	Are the x and y offset encoded in parameter signed?
grf_version8	True, if we are dealing with a new NewGRF which uses GRF version >= 8.