OpenTTD
Functions | Variables
newgrf_industries.cpp File Reference

Handling of NewGRF industries. More...

#include "stdafx.h"
#include "debug.h"
#include "industry.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 "table/strings.h"
#include "safeguards.h"

Go to the source code of this file.

Functions

IndustryType MapNewGRFIndustryType (IndustryType grf_type, uint32 grf_id)
 Map the GRF local type to an industry type. More...
 
uint32 GetIndustryIDAtOffset (TileIndex tile, const Industry *i, uint32 cur_grfid)
 Make an analysis of a tile and check for its belonging to the same industry, and/or the same grf file. More...
 
static uint32 GetClosestIndustry (TileIndex tile, IndustryType type, const Industry *current)
 
static uint32 GetCountAndDistanceOfClosestInstance (byte param_setID, byte 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. More...
 
static const GRFFileGetGrffile (IndustryType type)
 Get the grf file associated with the given industry type. More...
 
uint16 GetIndustryCallback (CallbackID callback, uint32 param1, uint32 param2, Industry *industry, IndustryType type, TileIndex tile)
 Perform an industry callback. More...
 
CommandCost CheckIfCallBackAllowsCreation (TileIndex tile, IndustryType type, uint layout, uint32 seed, uint16 initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type)
 Check that the industry callback allows creation of the industry. More...
 
uint32 GetIndustryProbabilityCallback (IndustryType type, IndustryAvailabilityCallType creation_type, uint32 default_prob)
 Check with callback CBID_INDUSTRY_PROBABILITY whether the industry can be built. More...
 
static int32 DerefIndProd (int field, bool use_register)
 
void IndustryProductionCallback (Industry *ind, int reason)
 Get the industry production callback and apply it to the industry. More...
 
bool IndustryTemporarilyRefusesCargo (Industry *ind, CargoID cargo_type)
 Check whether an industry temporarily refuses to accept a certain cargo. More...
 

Variables

IndustryOverrideManager _industry_mngr (NEW_INDUSTRYOFFSET, NUM_INDUSTRYTYPES, INVALID_INDUSTRYTYPE)
 
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,
uint  layout,
uint32  seed,
uint16  initial_random_bits,
Owner  founder,
IndustryAvailabilityCallType  creation_type 
)

Check that the industry callback allows creation of the industry.

Parameters
tileTile to build the industry.
typeType of industry to build.
layoutLayout number.
seedSeed for the random generator.
initial_random_bitsThe random bits the industry is going to have after construction.
founderIndustry founder
creation_typeThe circumstances the industry is created under.
Returns
Succeeded or failed command.

Definition at line 487 of file newgrf_industries.cpp.

References GetIndustrySpec(), and Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index.

◆ GetCountAndDistanceOfClosestInstance()

static uint32 GetCountAndDistanceOfClosestInstance ( byte  param_setID,
byte  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
param_setIDparameter given to the callback, which is the set id, or the local id, in our terminology
layout_filteron what layout do we filter?
town_filterDo we filter on the same town as the current industry?
currentIndustry 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 116 of file newgrf_industries.cpp.

References GetRegister().

◆ GetGrffile()

static const GRFFile* GetGrffile ( IndustryType  type)
static

Get the grf file associated with the given industry type.

Parameters
typeIndustry type to query.
Returns
The associated GRF file, if any.

Definition at line 409 of file newgrf_industries.cpp.

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

◆ GetIndustryCallback()

uint16 GetIndustryCallback ( CallbackID  callback,
uint32  param1,
uint32  param2,
Industry industry,
IndustryType  type,
TileIndex  tile 
)

Perform an industry callback.

Parameters
callbackThe callback to perform.
param1The first parameter.
param2The second parameter.
industryThe industry to do the callback for.
typeThe type of industry to do the callback for.
tileThe tile associated with the callback.
Returns
The callback result.

Definition at line 470 of file newgrf_industries.cpp.

Referenced by ChangeIndustryProduction(), GetCargoSuffix(), and GetIndustryProbabilityCallback().

◆ GetIndustryIDAtOffset()

uint32 GetIndustryIDAtOffset ( TileIndex  tile,
const Industry i,
uint32  cur_grfid 
)

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

Parameters
tileTileIndex of the tile to query
iIndustry to which to compare the tile to
cur_grfidGRFID 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< Tcnt >::grffile, INVALID_INDUSTRYTILE, GRFFilePropsBase< Tcnt >::local_id, NEW_INDUSTRYTILEOFFSET, GRFFileProps::override, GRFFilePropsBase< Tcnt >::spritegroup, and Industry::TileBelongsToIndustry().

◆ GetIndustryProbabilityCallback()

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

Check with callback CBID_INDUSTRY_PROBABILITY whether the industry can be built.

Parameters
typeIndustry type to check.
creation_typeReason 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 518 of file newgrf_industries.cpp.

References CALLBACK_FAILED, IndustrySpec::callback_mask, CBID_INDUSTRY_PROBABILITY, CBM_IND_PROBABILITY, ErrorUnknownCallbackResult(), GetIndustryCallback(), GetIndustrySpec(), IndustrySpec::grf_prop, GRFFilePropsBase< Tcnt >::grffile, HasBit(), and INVALID_TILE.

Referenced by GetIndustryGamePlayProbability(), and BuildIndustryWindow::OnTick().

◆ IndustryProductionCallback()

void IndustryProductionCallback ( Industry ind,
int  reason 
)

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

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

Definition at line 551 of file newgrf_industries.cpp.

References IndustrySpec::behaviour, GetIndustrySpec(), INDUSTRYBEH_PRODCALLBACK_RANDOM, Industry::location, OrthogonalTileArea::tile, and Industry::type.

Referenced by TriggerIndustryProduction().

◆ IndustryTemporarilyRefusesCargo()

bool IndustryTemporarilyRefusesCargo ( Industry ind,
CargoID  cargo_type 
)

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

Parameters
indThe industry to query.
cargo_typeThe 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 603 of file newgrf_industries.cpp.

Referenced by CanCargoServiceIndustry(), and DeliverGoodsToIndustry().

◆ MapNewGRFIndustryType()

IndustryType MapNewGRFIndustryType ( IndustryType  grf_type,
uint32  grf_id 
)

Map the GRF local type to an industry type.

Parameters
grf_typeThe GRF local type.
grf_idThe GRF of the local type.
Returns
The industry type in the global scope.

Definition at line 41 of file newgrf_industries.cpp.