Data Structures | Typedefs | Enumerations | Functions | Variables

newgrf.cpp File Reference

Base of all NewGRF support. More...

#include "stdafx.h"
#include <stdarg.h>
#include "debug.h"
#include "fileio_func.h"
#include "engine_func.h"
#include "engine_base.h"
#include "bridge.h"
#include "town.h"
#include "newgrf_engine.h"
#include "newgrf_text.h"
#include "fontcache.h"
#include "currency.h"
#include "landscape.h"
#include "newgrf_cargo.h"
#include "newgrf_house.h"
#include "newgrf_sound.h"
#include "newgrf_station.h"
#include "industrytype.h"
#include "newgrf_canal.h"
#include "newgrf_townname.h"
#include "newgrf_industries.h"
#include "newgrf_airporttiles.h"
#include "newgrf_airport.h"
#include "newgrf_object.h"
#include "rev.h"
#include "fios.h"
#include "strings_func.h"
#include "date_func.h"
#include "string_func.h"
#include "network/network.h"
#include <map>
#include "smallmap_gui.h"
#include "genworld.h"
#include "error.h"
#include "vehicle_func.h"
#include "language.h"
#include "vehicle_base.h"
#include "table/strings.h"
#include "table/build_industry.h"

Go to the source code of this file.

Data Structures

struct  GrfProcessingState
 Temporary data during loading of GRFs. More...
struct  GrfProcessingState::SpriteSet
 Definition of a single Action1 spriteset. More...
class  OTTDByteReaderSignal
class  ByteReader
 Class to read from a NewGRF file. More...
struct  GRFTempEngineData
 Temporary engine data used when loading only. More...
struct  GRFLocation
struct  Action5Type
 Information about a single action 5 type. More...
struct  AllowedSubtags
 Data structure to store the allowed id/type combinations for action 14. More...

Typedefs

typedef void(* SpecialSpriteHandler )(ByteReader *buf)
typedef std::map< GRFLocation,
byte * > 
GRFLineToSpriteOverride
typedef std::map< StringID
*, uint32 > 
StringIDToGRFIDMapping
typedef ChangeInfoResult(* VCI_Handler )(uint engine, int numinfo, int prop, ByteReader *buf)
typedef bool(* DataHandler )(size_t, ByteReader *)
 Type of callback function for binary nodes.
typedef bool(* TextHandler )(byte, const char *str)
 Type of callback function for text nodes.
typedef bool(* BranchHandler )(ByteReader *)
 Type of callback function for branch nodes.

Enumerations

enum  GrfDataType { GDT_SOUND }
enum  ChangeInfoResult {
  CIR_SUCCESS, CIR_DISABLED, CIR_UNHANDLED, CIR_UNKNOWN,
  CIR_INVALID_ID
}
 

Possible return values for the FeatureChangeInfo functions.

More...
enum  Action5BlockType { A5BLOCK_FIXED, A5BLOCK_ALLOW_OFFSET, A5BLOCK_INVALID }
 

The type of action 5 type.

More...

Functions

void CDECL grfmsg (int severity, const char *str,...)
 DEBUG() function dedicated to newGRF debugging messages Function is essentially the same as DEBUG(grf, severity, ...) with the addition of file:line information when parsing grf files.
static GRFFileGetFileByGRFID (uint32 grfid)
 Obtain a NewGRF file by its grfID.
static GRFFileGetFileByFilename (const char *filename)
 Obtain a NewGRF file by its filename.
static void ClearTemporaryNewGRFData (GRFFile *gf)
 Reset all NewGRFData that was used only while processing data.
static GRFErrorDisableGrf (StringID message=STR_NULL, GRFConfig *config=NULL)
 Disable a GRF.
StringID MapGRFStringID (uint32 grfid, StringID str)
 Used when setting an object's property to map to the GRF's strings while taking in consideration the "drift" between TTDPatch string system and OpenTTD's one.
static void SetNewGRFOverride (uint32 source_grfid, uint32 target_grfid)
 Set the override for a NewGRF.
static EngineGetNewEngine (const GRFFile *file, VehicleType type, uint16 internal_id, bool static_access=false)
 Returns the engine associated to a certain internal_id, resp.
EngineID GetNewEngineID (const GRFFile *file, VehicleType type, uint16 internal_id)
 Return the ID of a new engine.
static void MapSpriteMappingRecolour (PalSpriteID *grf_sprite)
 Map the colour modifiers of TTDPatch to those that Open is using.
static TileLayoutFlags ReadSpriteLayoutSprite (ByteReader *buf, bool read_flags, bool invert_action1_flag, bool use_cur_spritesets, int feature, PalSpriteID *grf_sprite, uint16 *max_sprite_offset=NULL, uint16 *max_palette_offset=NULL)
 Read a sprite and a palette from the GRF and convert them into a format suitable to OpenTTD.
static void ReadSpriteLayoutRegisters (ByteReader *buf, TileLayoutFlags flags, bool is_parent, NewGRFSpriteLayout *dts, uint index)
 Preprocess the TileLayoutFlags and read register modifiers from the GRF.
static bool ReadSpriteLayout (ByteReader *buf, uint num_building_sprites, bool use_cur_spritesets, byte feature, bool allow_var10, bool no_z_position, NewGRFSpriteLayout *dts)
 Read a spritelayout from the GRF.
static void ConvertTTDBasePrice (uint32 base_pointer, const char *error_location, Price *index)
 Converts TTD(P) Base Price pointers into the enum used by OTTD See http://wiki.ttdpatch.net/tiki-index.php?page=BaseCosts.
static ChangeInfoResult CommonVehicleChangeInfo (EngineInfo *ei, int prop, ByteReader *buf)
 Define properties common to all vehicles.
static ChangeInfoResult RailVehicleChangeInfo (uint engine, int numinfo, int prop, ByteReader *buf)
 Define properties for rail vehicles.
static ChangeInfoResult RoadVehicleChangeInfo (uint engine, int numinfo, int prop, ByteReader *buf)
 Define properties for road vehicles.
static ChangeInfoResult ShipVehicleChangeInfo (uint engine, int numinfo, int prop, ByteReader *buf)
 Define properties for ships.
static ChangeInfoResult AircraftVehicleChangeInfo (uint engine, int numinfo, int prop, ByteReader *buf)
 Define properties for aircraft.
static ChangeInfoResult StationChangeInfo (uint stid, int numinfo, int prop, ByteReader *buf)
 Define properties for stations.
static ChangeInfoResult CanalChangeInfo (uint id, int numinfo, int prop, ByteReader *buf)
 Define properties for water features.
static ChangeInfoResult BridgeChangeInfo (uint brid, int numinfo, int prop, ByteReader *buf)
 Define properties for bridges.
static ChangeInfoResult IgnoreTownHouseProperty (int prop, ByteReader *buf)
 Ignore a house property.
static ChangeInfoResult TownHouseChangeInfo (uint hid, int numinfo, int prop, ByteReader *buf)
 Define properties for houses.
static ChangeInfoResult GlobalVarChangeInfo (uint gvid, int numinfo, int prop, ByteReader *buf)
 Define properties for global variables.
static ChangeInfoResult GlobalVarReserveInfo (uint gvid, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult CargoChangeInfo (uint cid, int numinfo, int prop, ByteReader *buf)
 Define properties for cargoes.
static ChangeInfoResult SoundEffectChangeInfo (uint sid, int numinfo, int prop, ByteReader *buf)
 Define properties for sound effects.
static ChangeInfoResult IgnoreIndustryTileProperty (int prop, ByteReader *buf)
 Ignore an industry tile property.
static ChangeInfoResult IndustrytilesChangeInfo (uint indtid, int numinfo, int prop, ByteReader *buf)
 Define properties for industry tiles.
static ChangeInfoResult IgnoreIndustryProperty (int prop, ByteReader *buf)
 Ignore an industry property.
static bool ValidateIndustryLayout (const IndustryTileTable *layout, int size)
 Validate the industry layout; e.g.
static void CleanIndustryTileTable (IndustrySpec *ind)
 Clean the tile table of the IndustrySpec if it's needed.
static ChangeInfoResult IndustriesChangeInfo (uint indid, int numinfo, int prop, ByteReader *buf)
 Define properties for industries.
static void DuplicateTileTable (AirportSpec *as)
 Create a copy of the tile table so it can be freed later without problems.
static ChangeInfoResult AirportChangeInfo (uint airport, int numinfo, int prop, ByteReader *buf)
 Define properties for airports.
static ChangeInfoResult IgnoreObjectProperty (uint prop, ByteReader *buf)
 Ignore properties for objects.
static ChangeInfoResult ObjectChangeInfo (uint id, int numinfo, int prop, ByteReader *buf)
 Define properties for objects.
static ChangeInfoResult RailTypeChangeInfo (uint id, int numinfo, int prop, ByteReader *buf)
 Define properties for railtypes.
static ChangeInfoResult RailTypeReserveInfo (uint id, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult AirportTilesChangeInfo (uint airtid, int numinfo, int prop, ByteReader *buf)
static bool HandleChangeInfoResult (const char *caller, ChangeInfoResult cir, uint8 feature, uint8 property)
static void FeatureChangeInfo (ByteReader *buf)
static void SafeChangeInfo (ByteReader *buf)
static void ReserveChangeInfo (ByteReader *buf)
static void NewSpriteSet (ByteReader *buf)
static void SkipAct1 (ByteReader *buf)
static const SpriteGroupGetGroupFromGroupID (byte setid, byte type, uint16 groupid)
static const SpriteGroupCreateGroupFromGroupID (byte feature, byte setid, byte type, uint16 spriteid)
 Helper function to either create a callback or a result sprite group.
static void NewSpriteGroup (ByteReader *buf)
static CargoID TranslateCargo (uint8 feature, uint8 ctype)
static bool IsValidGroupID (uint16 groupid, const char *function)
static void VehicleMapSpriteGroup (ByteReader *buf, byte feature, uint8 idcount)
static void CanalMapSpriteGroup (ByteReader *buf, uint8 idcount)
static void StationMapSpriteGroup (ByteReader *buf, uint8 idcount)
static void TownHouseMapSpriteGroup (ByteReader *buf, uint8 idcount)
static void IndustryMapSpriteGroup (ByteReader *buf, uint8 idcount)
static void IndustrytileMapSpriteGroup (ByteReader *buf, uint8 idcount)
static void CargoMapSpriteGroup (ByteReader *buf, uint8 idcount)
static void ObjectMapSpriteGroup (ByteReader *buf, uint8 idcount)
static void RailTypeMapSpriteGroup (ByteReader *buf, uint8 idcount)
static void AirportMapSpriteGroup (ByteReader *buf, uint8 idcount)
static void AirportTileMapSpriteGroup (ByteReader *buf, uint8 idcount)
static void FeatureMapSpriteGroup (ByteReader *buf)
static void FeatureNewName (ByteReader *buf)
static uint16 SanitizeSpriteOffset (uint16 &num, uint16 offset, int max_sprites, const char *name)
 Sanitize incoming sprite offsets for Action 5 graphics replacements.
static void GraphicsNew (ByteReader *buf)
static void SkipAct5 (ByteReader *buf)
void CheckForMissingSprites ()
 Check whether we are (obviously) missing some of the extra (Action 0x05) sprites that we like to use.
bool GetGlobalVariable (byte param, uint32 *value, const GRFFile *grffile)
 Reads a variable common to VarAction2 and Action7/9/D.
static uint32 GetParamVal (byte param, uint32 *cond_val)
static void CfgApply (ByteReader *buf)
static void DisableStaticNewGRFInfluencingNonStaticNewGRFs (GRFConfig *c)
 Disable a static NewGRF when it is influencing another (non-static) NewGRF as this could cause desyncs.
static void SkipIf (ByteReader *buf)
static void ScanInfo (ByteReader *buf)
static void GRFInfo (ByteReader *buf)
static void SpriteReplace (ByteReader *buf)
static void SkipActA (ByteReader *buf)
static void GRFLoadError (ByteReader *buf)
static void GRFComment (ByteReader *buf)
static void SafeParamSet (ByteReader *buf)
static uint32 GetPatchVariable (uint8 param)
static uint32 PerformGRM (uint32 *grm, uint16 num_ids, uint16 count, uint8 op, uint8 target, const char *type)
static void ParamSet (ByteReader *buf)
 Action 0x0D: Set parameter.
static void SafeGRFInhibit (ByteReader *buf)
static void GRFInhibit (ByteReader *buf)
static void FeatureTownName (ByteReader *buf)
 Action 0x0F - Define Town names.
static void DefineGotoLabel (ByteReader *buf)
 Action 0x10 - Define goto label.
static void GRFSound (ByteReader *buf)
static void SkipAct11 (ByteReader *buf)
static void ImportGRFSound (ByteReader *buf)
static void GRFImportBlock (ByteReader *buf)
static void LoadGRFSound (ByteReader *buf)
static void LoadFontGlyph (ByteReader *buf)
 Action 0x12.
static void SkipAct12 (ByteReader *buf)
 Action 0x12 (SKIP).
static void TranslateGRFStrings (ByteReader *buf)
 Action 0x13.
static bool ChangeGRFName (byte langid, const char *str)
 Callback function for 'INFO'->'NAME' to add a translation to the newgrf name.
static bool ChangeGRFDescription (byte langid, const char *str)
 Callback function for 'INFO'->'DESC' to add a translation to the newgrf description.
static bool ChangeGRFURL (byte langid, const char *str)
 Callback function for 'INFO'->'URL_' to set the newgrf url.
static bool ChangeGRFNumUsedParams (size_t len, ByteReader *buf)
 Callback function for 'INFO'->'NPAR' to set the number of valid parameters.
static bool ChangeGRFPalette (size_t len, ByteReader *buf)
 Callback function for 'INFO'->'PALS' to set the number of valid parameters.
static bool ChangeGRFBlitter (size_t len, ByteReader *buf)
 Callback function for 'INFO'->'BLTR' to set the blitter info.
static bool ChangeGRFVersion (size_t len, ByteReader *buf)
 Callback function for 'INFO'->'VRSN' to the version of the NewGRF.
static bool ChangeGRFMinVersion (size_t len, ByteReader *buf)
 Callback function for 'INFO'->'MINV' to the minimum compatible version of the NewGRF.
static bool ChangeGRFParamName (byte langid, const char *str)
 Callback function for 'INFO'->'PARAM'->param_num->'NAME' to set the name of a parameter.
static bool ChangeGRFParamDescription (byte langid, const char *str)
 Callback function for 'INFO'->'PARAM'->param_num->'DESC' to set the description of a parameter.
static bool ChangeGRFParamType (size_t len, ByteReader *buf)
 Callback function for 'INFO'->'PARAM'->param_num->'TYPE' to set the typeof a parameter.
static bool ChangeGRFParamLimits (size_t len, ByteReader *buf)
 Callback function for 'INFO'->'PARAM'->param_num->'LIMI' to set the min/max value of a parameter.
static bool ChangeGRFParamMask (size_t len, ByteReader *buf)
 Callback function for 'INFO'->'PARAM'->param_num->'MASK' to set the parameter and bits to use.
static bool ChangeGRFParamDefault (size_t len, ByteReader *buf)
 Callback function for 'INFO'->'PARAM'->param_num->'DFLT' to set the default value.
static bool SkipUnknownInfo (ByteReader *buf, byte type)
 Try to skip the current node and all subnodes (if it's a branch node).
static bool HandleNodes (ByteReader *buf, AllowedSubtags *tags)
static bool ChangeGRFParamValueNames (ByteReader *buf)
 Callback function for 'INFO'->'PARA'->param_num->'VALU' to set the names of some parameter values (type uint/enum) or the names of some bits (type bitmask).
static bool HandleParameterInfo (ByteReader *buf)
 Callback function for 'INFO'->'PARA' to set extra information about the parameters.
static bool HandleNode (byte type, uint32 id, ByteReader *buf, AllowedSubtags subtags[])
 Handle the nodes of an Action14.
static bool HandleNodes (ByteReader *buf, AllowedSubtags subtags[])
 Handle the contents of a 'C' choice of an Action14.
static void StaticGRFInfo (ByteReader *buf)
 Handle Action 0x14.
static void GRFDataBlock (ByteReader *buf)
 'Action 0xFF'
static void GRFUnsafe (ByteReader *buf)
 Set the current NewGRF as unsafe for static use.
static void InitializeGRFSpecial ()
 Initialize the TTDPatch flags.
static void ResetCustomStations ()
 Reset and clear all NewGRF stations.
static void ResetCustomHouses ()
 Reset and clear all NewGRF houses.
static void ResetCustomAirports ()
 Reset and clear all NewGRF airports.
static void ResetCustomIndustries ()
 Reset and clear all NewGRF industries.
static void ResetCustomObjects ()
 Reset and clear all NewObjects.
static void ResetNewGRF ()
 Reset and clear all NewGRFs.
static void ResetNewGRFErrors ()
 Clear all NewGRF errors.
void ResetNewGRFData ()
 Reset all NewGRF loaded data TODO.
void ResetPersistentNewGRFData ()
 Reset NewGRF data which is stored persistently in savegames.
static void BuildCargoTranslationMap ()
 Construct the Cargo Mapping.
static void InitNewGRFFile (const GRFConfig *config)
 Prepare loading a NewGRF file with its config.
static void CalculateRefitMasks ()
 Precalculate refit masks from cargo classes for all vehicles.
static void FinaliseCanals ()
 Set to use the correct action0 properties for each canal feature.
static void FinaliseEngineArray ()
 Check for invalid engines.
static void FinaliseCargoArray ()
 Check for invalid cargoes.
static bool IsHouseSpecValid (HouseSpec *hs, const HouseSpec *next1, const HouseSpec *next2, const HouseSpec *next3, const char *filename)
 Check if a given housespec is valid and disable it if it's not.
static void EnsureEarlyHouse (HouseZones bitmask)
 Make sure there is at least one house available in the year 0 for the given climate / housezone combination.
static void FinaliseHouseArray ()
 Add all new houses to the house array.
static void FinaliseIndustriesArray ()
 Add all new industries to the industry array.
static void FinaliseObjectsArray ()
 Add all new objects to the object array.
static void FinaliseAirportsArray ()
 Add all new airports to the airport array.
static void DecodeSpecialSprite (byte *buf, uint num, GrfLoadingStage stage)
void LoadNewGRFFile (GRFConfig *config, uint file_index, GrfLoadingStage stage, Subdirectory subdir)
 Load a particular NewGRF.
static void ActivateOldShore ()
 Relocates the old shore sprites at new positions.
static void FinalisePriceBaseMultipliers ()
 Decide whether price base multipliers of grfs shall apply globally or only to the grf specifying them.
void InitDepotWindowBlockSizes ()
 Set the size of the blocks in the window so we can be sure that they are big enough for the vehicle sprites in the current game.
void InitGRFTownGeneratorNames ()
 Allocate memory for the NewGRF town names.
static void AfterLoadGRFs ()
 Finish loading NewGRFs and execute needed post-processing.
void LoadNewGRF (uint load_index, uint file_index)
 Load all the NewGRFs.

Variables

static SmallVector< GRFFile *, 16 > _grf_files
 List of all loaded GRF files.
byte _misc_grf_features = 0
 Miscellaneous GRF features, set by Action 0x0D, parameter 0x9E.
static uint32 _ttdpatch_flags [8]
 32 * 8 = 256 flags.
GRFLoadedFeatures _loaded_newgrf_features
 Indicates which are the newgrf features currently loaded ingame.
static const uint MAX_SPRITEGROUP = UINT8_MAX
 Maximum GRF-local ID for a spritegroup.
static GrfProcessingState _cur
static const uint MAX_STATIONS = 256
static GRFTempEngineData_gted
 Temporary engine data used during NewGRF loading.
static uint32 _grm_engines [256]
 Contains the GRF ID of the owner of a vehicle if it has been reserved.
static uint32 _grm_cargoes [NUM_CARGO *2]
 Contains the GRF ID of the owner of a cargo if it has been reserved.
static std::map< GRFLocation,
SpriteID
_grm_sprites
static GRFLineToSpriteOverride _grf_line_to_action6_sprite_override
static StringIDToGRFIDMapping _string_to_grf_mapping
static std::map< uint32, uint32 > _grf_id_overrides
static const Action5Type _action5_types []
 The information about action 5 types.
static GRFParameterInfo_cur_parameter
 The parameter which info is currently changed by the newgrf.
AllowedSubtags _tags_parameters []
 Action14 parameter tags.
AllowedSubtags _tags_info []
 Action14 tags for the INFO node.
AllowedSubtags _tags_root []
 Action14 root tags.
static const CargoLabel _default_refitmasks_rail []
 List of what cargo labels are refittable for the given the vehicle-type.
static const CargoLabel _default_refitmasks_road []
static const CargoLabel _default_refitmasks_ships []
static const CargoLabel _default_refitmasks_aircraft []
static const CargoLabel *const _default_refitmasks []

Detailed Description

Base of all NewGRF support.

Definition in file newgrf.cpp.


Enumeration Type Documentation

The type of action 5 type.

Enumerator:
A5BLOCK_FIXED 

Only allow replacing a whole block of sprites. (TTDP compatible).

A5BLOCK_ALLOW_OFFSET 

Allow replacing any subset by specifiing an offset.

A5BLOCK_INVALID 

unknown/not-implemented type

Definition at line 5374 of file newgrf.cpp.

Possible return values for the FeatureChangeInfo functions.

Enumerator:
CIR_SUCCESS 

Variable was parsed and read.

CIR_DISABLED 

GRF was disabled due to error.

CIR_UNHANDLED 

Variable was parsed but unread.

CIR_UNKNOWN 

Variable is unknown.

CIR_INVALID_ID 

Attempt to modify an invalid ID.

Definition at line 853 of file newgrf.cpp.


Function Documentation

static void ActivateOldShore (  )  [static]

Relocates the old shore sprites at new positions.

1. If shore sprites are neither loaded by Action5 nor ActionA, the extra sprites from openttd(w/d).grf are used. (SHORE_REPLACE_ONLY_NEW) 2. If a newgrf replaces some shore sprites by ActionA. The (maybe also replaced) grass tiles are used for corner shores. (SHORE_REPLACE_ACTION_A) 3. If a newgrf replaces shore sprites by Action5 any shore replacement by ActionA has no effect. (SHORE_REPLACE_ACTION_5)

Definition at line 8745 of file newgrf.cpp.

References GRFLoadedFeatures::shore, SHORE_REPLACE_ACTION_5, SHORE_REPLACE_ACTION_A, SHORE_REPLACE_NONE, and SPR_SHORE_BASE.

Referenced by AfterLoadGRFs().

static ChangeInfoResult AircraftVehicleChangeInfo ( uint  engine,
int  numinfo,
int  prop,
ByteReader buf 
) [static]
static ChangeInfoResult AirportChangeInfo ( uint  airport,
int  numinfo,
int  prop,
ByteReader buf 
) [static]
static ChangeInfoResult BridgeChangeInfo ( uint  brid,
int  numinfo,
int  prop,
ByteReader buf 
) [static]

Define properties for bridges.

Parameters:
brid BridgeID of the bridge.
numinfo Number of subsequent bridgeIDs to change the property for.
prop The property to change.
buf The property value.
Returns:
ChangeInfoResult.

Definition at line 1951 of file newgrf.cpp.

References _bridge, BridgeSpec::avail_year, Clamp(), BridgeSpec::flags, GetGRFStringID(), GrfProcessingState::grffile, grfmsg(), MapSpriteMappingRecolour(), BridgeSpec::material, MAX_BRIDGES, BridgeSpec::max_length, MAX_YEAR, BridgeSpec::min_length, MIN_YEAR, ORIGINAL_BASE_YEAR, PalSpriteID::pal, BridgeSpec::price, BridgeSpec::speed, PalSpriteID::sprite, BridgeSpec::sprite_table, and BridgeSpec::transport_name.

static void BuildCargoTranslationMap (  )  [static]

Construct the Cargo Mapping.

Note:
This is the reverse of a cargo translation table

Definition at line 7991 of file newgrf.cpp.

References CargoSpec::bitnum, CargoSpec::Get(), GrfProcessingState::grffile, CargoSpec::IsValid(), and CargoSpec::label.

Referenced by LoadNewGRF().

static void CalculateRefitMasks (  )  [static]
static ChangeInfoResult CanalChangeInfo ( uint  id,
int  numinfo,
int  prop,
ByteReader buf 
) [static]

Define properties for water features.

Parameters:
id Type of the first water feature.
numinfo Number of subsequent water feature ids to change the property for.
prop The property to change.
buf The property value.
Returns:
ChangeInfoResult.

Definition at line 1913 of file newgrf.cpp.

References CanalProperties::callback_mask, GRFFile::canal_local_properties, CanalProperties::flags, GrfProcessingState::grffile, and grfmsg().

static ChangeInfoResult CargoChangeInfo ( uint  cid,
int  numinfo,
int  prop,
ByteReader buf 
) [static]

Define properties for cargoes.

Parameters:
cid Local ID of the cargo.
numinfo Number of subsequent IDs to change the property for.
prop The property to change.
buf The property value.
Returns:
ChangeInfoResult.

Definition at line 2680 of file newgrf.cpp.

References _cargo_mask, CargoSpec::abbrev, CargoSpec::bitnum, BSWAP32(), CargoSpec::callback_mask, CargoSpec::classes, ClrBit(), CargoSpec::Get(), GrfProcessingState::grffile, CargoSpec::grffile, grfmsg(), CargoSpec::is_freight, CargoSpec::IsValid(), CargoSpec::label, CargoSpec::multiplier, CargoSpec::multipliertowngrowth, CargoSpec::name, CargoSpec::name_single, NUM_CARGO, CargoSpec::quantifier, SetBit(), CargoSpec::sprite, CargoSpec::town_effect, CargoSpec::units_volume, and CargoSpec::weight.

static bool ChangeGRFBlitter ( size_t  len,
ByteReader buf 
) [static]

Callback function for 'INFO'->'BLTR' to set the blitter info.

Definition at line 7148 of file newgrf.cpp.

References GrfProcessingState::grfconfig, grfmsg(), and GRFConfig::palette.

static bool ChangeGRFDescription ( byte  langid,
const char *  str 
) [static]

Callback function for 'INFO'->'DESC' to add a translation to the newgrf description.

Definition at line 7096 of file newgrf.cpp.

References AddGRFTextToList(), GrfProcessingState::grfconfig, GRFIdentifier::grfid, GRFConfig::ident, GRFConfig::info, and GRFTextWrapper::text.

static bool ChangeGRFMinVersion ( size_t  len,
ByteReader buf 
) [static]

Callback function for 'INFO'->'MINV' to the minimum compatible version of the NewGRF.

Definition at line 7183 of file newgrf.cpp.

References GrfProcessingState::grfconfig, grfmsg(), GRFConfig::min_loadable_version, and GRFConfig::version.

static bool ChangeGRFName ( byte  langid,
const char *  str 
) [static]

Callback function for 'INFO'->'NAME' to add a translation to the newgrf name.

Definition at line 7089 of file newgrf.cpp.

References AddGRFTextToList(), GrfProcessingState::grfconfig, GRFIdentifier::grfid, GRFConfig::ident, GRFConfig::name, and GRFTextWrapper::text.

static bool ChangeGRFNumUsedParams ( size_t  len,
ByteReader buf 
) [static]

Callback function for 'INFO'->'NPAR' to set the number of valid parameters.

Definition at line 7110 of file newgrf.cpp.

References GrfProcessingState::grfconfig, grfmsg(), lengthof, min(), GRFConfig::num_valid_params, and GRFConfig::param.

static bool ChangeGRFPalette ( size_t  len,
ByteReader buf 
) [static]

Callback function for 'INFO'->'PALS' to set the number of valid parameters.

Definition at line 7122 of file newgrf.cpp.

References GrfProcessingState::grfconfig, grfmsg(), GRFP_GRF_UNSET, and GRFConfig::palette.

static bool ChangeGRFParamDefault ( size_t  len,
ByteReader buf 
) [static]

Callback function for 'INFO'->'PARAM'->param_num->'DFLT' to set the default value.

Definition at line 7273 of file newgrf.cpp.

References GRFParameterInfo::def_value, GrfProcessingState::grfconfig, grfmsg(), and GRFConfig::has_param_defaults.

static bool ChangeGRFParamDescription ( byte  langid,
const char *  str 
) [static]

Callback function for 'INFO'->'PARAM'->param_num->'DESC' to set the description of a parameter.

Definition at line 7212 of file newgrf.cpp.

References AddGRFTextToList(), GRFParameterInfo::desc, GrfProcessingState::grfconfig, GRFIdentifier::grfid, and GRFConfig::ident.

static bool ChangeGRFParamLimits ( size_t  len,
ByteReader buf 
) [static]

Callback function for 'INFO'->'PARAM'->param_num->'LIMI' to set the min/max value of a parameter.

Definition at line 7236 of file newgrf.cpp.

References grfmsg(), GRFParameterInfo::max_value, GRFParameterInfo::min_value, PTYPE_UINT_ENUM, and GRFParameterInfo::type.

static bool ChangeGRFParamMask ( size_t  len,
ByteReader buf 
) [static]

Callback function for 'INFO'->'PARAM'->param_num->'MASK' to set the parameter and bits to use.

Definition at line 7252 of file newgrf.cpp.

References GRFParameterInfo::first_bit, GrfProcessingState::grfconfig, grfmsg(), lengthof, min(), GRFParameterInfo::num_bit, GRFConfig::param, and GRFParameterInfo::param_nr.

static bool ChangeGRFParamName ( byte  langid,
const char *  str 
) [static]

Callback function for 'INFO'->'PARAM'->param_num->'NAME' to set the name of a parameter.

Definition at line 7205 of file newgrf.cpp.

References AddGRFTextToList(), GrfProcessingState::grfconfig, GRFIdentifier::grfid, GRFConfig::ident, and GRFParameterInfo::name.

static bool ChangeGRFParamType ( size_t  len,
ByteReader buf 
) [static]

Callback function for 'INFO'->'PARAM'->param_num->'TYPE' to set the typeof a parameter.

Definition at line 7219 of file newgrf.cpp.

References grfmsg(), PTYPE_END, and GRFParameterInfo::type.

static bool ChangeGRFParamValueNames ( ByteReader buf  )  [static]

Callback function for 'INFO'->'PARA'->param_num->'VALU' to set the names of some parameter values (type uint/enum) or the names of some bits (type bitmask).

In both cases the format is the same: Each subnode should be a text node with the value/bit number as id.

Definition at line 7377 of file newgrf.cpp.

References AddGRFTextToList(), SmallVector< T, S >::End(), SmallMap< T, U, S >::Find(), GrfProcessingState::grfconfig, GRFIdentifier::grfid, grfmsg(), GRFConfig::ident, SmallMap< T, U, S >::Insert(), GRFParameterInfo::max_value, SkipUnknownInfo(), and GRFParameterInfo::value_names.

static bool ChangeGRFURL ( byte  langid,
const char *  str 
) [static]

Callback function for 'INFO'->'URL_' to set the newgrf url.

Definition at line 7103 of file newgrf.cpp.

References AddGRFTextToList(), GrfProcessingState::grfconfig, GRFIdentifier::grfid, GRFConfig::ident, GRFTextWrapper::text, and GRFConfig::url.

static bool ChangeGRFVersion ( size_t  len,
ByteReader buf 
) [static]

Callback function for 'INFO'->'VRSN' to the version of the NewGRF.

Definition at line 7170 of file newgrf.cpp.

References GrfProcessingState::grfconfig, grfmsg(), GRFConfig::min_loadable_version, and GRFConfig::version.

void CheckForMissingSprites (  ) 

Check whether we are (obviously) missing some of the extra (Action 0x05) sprites that we like to use.

When missing sprites are found a warning will be shown.

Definition at line 5508 of file newgrf.cpp.

References A5BLOCK_INVALID, Action5Type::block_type, DEBUG, INVALID_STRING_ID, lengthof, Action5Type::max_sprites, Action5Type::name, ShowErrorMessage(), Action5Type::sprite_base, and WL_CRITICAL.

Referenced by LoadIntroGame().

static void CleanIndustryTileTable ( IndustrySpec ind  )  [static]

Clean the tile table of the IndustrySpec if it's needed.

Definition at line 3131 of file newgrf.cpp.

References CLEAN_TILELAYOUT, IndustrySpec::cleanup_flag, free(), HasBit(), IndustrySpec::num_table, and IndustrySpec::table.

Referenced by IndustriesChangeInfo(), and ResetCustomIndustries().

static ChangeInfoResult CommonVehicleChangeInfo ( EngineInfo ei,
int  prop,
ByteReader buf 
) [static]

Define properties common to all vehicles.

Parameters:
ei Engine info.
prop The property to change.
buf The property value.
Returns:
ChangeInfoResult.

Definition at line 870 of file newgrf.cpp.

References EngineInfo::base_intro, EngineInfo::base_life, EngineInfo::climates, EngineInfo::lifelength, and PROP_VEHICLE_LOAD_AMOUNT.

Referenced by AircraftVehicleChangeInfo(), RailVehicleChangeInfo(), RoadVehicleChangeInfo(), and ShipVehicleChangeInfo().

static void ConvertTTDBasePrice ( uint32  base_pointer,
const char *  error_location,
Price index 
) [static]

Converts TTD(P) Base Price pointers into the enum used by OTTD See http://wiki.ttdpatch.net/tiki-index.php?page=BaseCosts.

Parameters:
base_pointer TTD(P) Base Price Pointer
error_location Function name for grf error messages
index If base_pointer is valid, index is assigned to the matching price; else it is left unchanged

< Position of first base price

< Size of each base price record

Definition at line 833 of file newgrf.cpp.

References grfmsg().

Referenced by RailVehicleChangeInfo(), and RoadVehicleChangeInfo().

static const SpriteGroup* CreateGroupFromGroupID ( byte  feature,
byte  setid,
byte  type,
uint16  spriteid 
) [static]

Helper function to either create a callback or a result sprite group.

Parameters:
feature GrfSpecFeature to define spritegroup for.
setid SetID of the currently being parsed Action2. (only for debug output)
type Type of the currently being parsed Action2. (only for debug output)
spriteid Raw value from the GRF for the new spritegroup; describes either the return value or the referenced spritegroup.
Returns:
Created spritegroup.

Definition at line 4383 of file newgrf.cpp.

References Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem<&_spritegroup_pool >::CanAllocateItem(), GrfProcessingState::GetNumEnts(), GrfProcessingState::GetSprite(), GrfProcessingState::grffile, grfmsg(), HasBit(), GrfProcessingState::IsValidSpriteSet(), and GrfProcessingState::spriteid.

static GRFError* DisableGrf ( StringID  message = STR_NULL,
GRFConfig config = NULL 
) [static]

Disable a GRF.

Parameters:
message Error message or STR_NULL.
config GRFConfig to disable, NULL for current.
Returns:
Error message of the GRF for further customisation.

Definition at line 404 of file newgrf.cpp.

References ClearTemporaryNewGRFData(), GetFileByGRFID(), GrfProcessingState::grfconfig, GrfProcessingState::grffile, GrfProcessingState::nfo_line, and GrfProcessingState::skip_sprites.

Referenced by DisableStaticNewGRFInfluencingNonStaticNewGRFs(), FeatureTownName(), LoadNewGRFFile(), ParamSet(), ReadSpriteLayout(), ReadSpriteLayoutRegisters(), ReadSpriteLayoutSprite(), and TranslateGRFStrings().

static void DisableStaticNewGRFInfluencingNonStaticNewGRFs ( GRFConfig c  )  [static]

Disable a static NewGRF when it is influencing another (non-static) NewGRF as this could cause desyncs.

We could just tell the NewGRF querying that the file doesn't exist, but that might give unwanted results. Disabling the NewGRF gives the best result as no NewGRF author can complain about that.

Parameters:
c The NewGRF to disable.

Definition at line 5823 of file newgrf.cpp.

References GRFError::data, DisableGrf(), error(), GRFConfig::GetName(), and GrfProcessingState::grfconfig.

Referenced by ParamSet().

static void DuplicateTileTable ( AirportSpec as  )  [static]

Create a copy of the tile table so it can be freed later without problems.

Parameters:
as The AirportSpec to copy the arrays of.

Definition at line 3467 of file newgrf.cpp.

References AirportSpec::depot_table, MemCpyT(), AirportSpec::nof_depots, AirportSpec::num_table, and AirportSpec::table.

Referenced by AirportChangeInfo().

static void EnsureEarlyHouse ( HouseZones  bitmask  )  [static]

Make sure there is at least one house available in the year 0 for the given climate / housezone combination.

Parameters:
bitmask The climate and housezone to check for. Exactly one climate bit and one housezone bit should be set.

Definition at line 8349 of file newgrf.cpp.

References HouseSpec::building_availability, HouseSpec::enabled, MAX_YEAR, and HouseSpec::min_year.

Referenced by FinaliseHouseArray().

static void FinaliseAirportsArray (  )  [static]

Add all new airports to the airport array.

Airport properties can be set at any time in the GRF file, so we can only add a airport spec to the airport array after the file has finished loading.

Definition at line 8539 of file newgrf.cpp.

References SmallVector< T, S >::Begin(), SmallVector< T, S >::End(), and NUM_AIRPORTTILES.

Referenced by AfterLoadGRFs().

static void FinaliseHouseArray (  )  [static]

Add all new houses to the house array.

House properties can be set at any time in the GRF file, so we can only add a house spec to the house array after the file has finished loading. We also need to check the dates, due to the TTDPatch behaviour described below that we need to emulate.

Definition at line 8376 of file newgrf.cpp.

References _settings_game, SmallVector< T, S >::Begin(), HouseSpec::building_flags, SmallVector< T, S >::End(), EnsureEarlyHouse(), GameSettings::game_creation, HZ_SUBARTC_ABOVE, HZ_ZON1, HZ_ZON5, IsHouseSpecValid(), GameCreationSettings::landscape, and HouseOverrideManager::SetEntitySpec().

Referenced by AfterLoadGRFs().

static void FinaliseIndustriesArray (  )  [static]
static void FinaliseObjectsArray (  )  [static]

Add all new objects to the object array.

Object properties can be set at any time in the GRF file, so we can only add an object spec to the object array after the file has finished loading.

Definition at line 8519 of file newgrf.cpp.

References _object_mngr, SmallVector< T, S >::Begin(), ObjectSpec::enabled, SmallVector< T, S >::End(), NUM_OBJECTS, and ObjectOverrideManager::SetEntitySpec().

Referenced by AfterLoadGRFs().

static void FinalisePriceBaseMultipliers (  )  [static]

Decide whether price base multipliers of grfs shall apply globally or only to the grf specifying them.

Features, to which '_grf_id_overrides' applies. Currently vehicle features only.

Definition at line 8782 of file newgrf.cpp.

References AllocaM, SmallVector< T, S >::Begin(), DEBUG, SmallVector< T, S >::End(), PriceBaseSpec::fallback_price, SmallVector< T, S >::FindIndex(), GetFileByGRFID(), PriceBaseSpec::grf_feature, GRFFile::grf_features, HasBit(), SmallVector< T, S >::Length(), GRFFile::price_base_multipliers, and SetPriceBaseMultiplier().

Referenced by AfterLoadGRFs().

static GRFFile* GetFileByFilename ( const char *  filename  )  [static]

Obtain a NewGRF file by its filename.

Parameters:
filename The filename to obtain the file for.
Returns:
The file.

Definition at line 377 of file newgrf.cpp.

References SmallVector< T, S >::Begin(), and SmallVector< T, S >::End().

Referenced by InitNewGRFFile(), and LoadNewGRFFile().

static GRFFile* GetFileByGRFID ( uint32  grfid  )  [static]

Obtain a NewGRF file by its grfID.

Parameters:
grfid The grfID to obtain the file for
Returns:
The file.

Definition at line 363 of file newgrf.cpp.

References SmallVector< T, S >::Begin(), and SmallVector< T, S >::End().

Referenced by DisableGrf(), FinalisePriceBaseMultipliers(), LanguageMap::GetLanguageMap(), GetNewEngine(), LoadNewGRF(), and ParamSet().

bool GetGlobalVariable ( byte  param,
uint32 *  value,
const GRFFile grffile 
)

Reads a variable common to VarAction2 and Action7/9/D.

Returns VarAction2 variable 'param' resp. Action7/9/D variable '0x80 + param'. If a variable is not accessible from all four actions, it is handled in the action specific functions.

Parameters:
param variable number (as for VarAction2, for Action7/9/D you have to subtract 0x80 first).
value returns the value of the variable.
grffile NewGRF querying the variable
Returns:
true iff the variable is known and the value is returned in 'value'.

Definition at line 5543 of file newgrf.cpp.

References _cur_year, _date, _date_fract, _misc_grf_features, _settings_game, _tick_counter, Clamp(), ConvertDateToYMD(), ConvertYMDToDate(), YearMonthDay::day, DAYS_TILL_ORIGINAL_BASE_YEAR, DifficultySettings::diff_level, GameSettings::difficulty, VehicleSettings::disable_elrails, GameSettings::game_creation, GetRailTypeInfo(), GetSnowLine(), GMB_TRAIN_WIDTH_32_PIXELS, GrfProcessingState::grfconfig, GrfProcessingState::grffile, HasBit(), IsLeapYear(), GameCreationSettings::landscape, max(), MAX_TILE_HEIGHT, YearMonthDay::month, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR, GRFConfig::palette, RAILTYPE_ELECTRIC, RAILTYPE_MAGLEV, RAILTYPE_MONO, RAILTYPE_RAIL, VehicleSettings::road_side, SB(), SetBit(), TILE_HEIGHT, GRFFile::traininfo_vehicle_pitch, GRFFile::traininfo_vehicle_width, GameSettings::vehicle, and YearMonthDay::year.

static Engine* GetNewEngine ( const GRFFile file,
VehicleType  type,
uint16  internal_id,
bool  static_access = false 
) [static]
EngineID GetNewEngineID ( const GRFFile file,
VehicleType  type,
uint16  internal_id 
)

Return the ID of a new engine.

Parameters:
file The NewGRF file providing the engine.
type The Vehicle type.
internal_id NewGRF-internal ID of the engine.
Returns:
The new EngineID.
Note:
depending on the dynamic_engine setting and a possible override property the grfID may be unique or overwriting or partially re-defining properties of an existing engine.

Definition at line 576 of file newgrf.cpp.

References _settings_game, VehicleSettings::dynamic_engines, EngineOverrideManager::GetID(), and GameSettings::vehicle.

Referenced by GetNextArticulatedPart().

static ChangeInfoResult GlobalVarChangeInfo ( uint  gvid,
int  numinfo,
int  prop,
ByteReader buf 
) [static]
void CDECL grfmsg ( int  severity,
const char *  str,
  ... 
)

DEBUG() function dedicated to newGRF debugging messages Function is essentially the same as DEBUG(grf, severity, ...) with the addition of file:line information when parsing grf files.

NOTE: for the above reason(s) grfmsg() should ONLY be used for loading/parsing grf files, not for runtime debug messages as there is no file information available during that time.

Parameters:
severity debugging severity level, see debug.h
str message in printf() format

Definition at line 346 of file newgrf.cpp.

References DEBUG, GRFConfig::filename, GrfProcessingState::grfconfig, and GrfProcessingState::nfo_line.

Referenced by AddGenericCallback(), AddGRFString(), AirportChangeInfo(), BridgeChangeInfo(), CanalChangeInfo(), CargoChangeInfo(), ChangeGRFBlitter(), ChangeGRFMinVersion(), ChangeGRFNumUsedParams(), ChangeGRFPalette(), ChangeGRFParamDefault(), ChangeGRFParamLimits(), ChangeGRFParamMask(), ChangeGRFParamType(), ChangeGRFParamValueNames(), ChangeGRFVersion(), ConvertTTDBasePrice(), CreateGroupFromGroupID(), DEFINE_NEWGRF_CLASS_METHOD(), DefineGotoLabel(), FeatureTownName(), UnmappedChoiceList::Flush(), GetNewEngine(), GlobalVarChangeInfo(), GRFDataBlock(), HandleNode(), HandleParameterInfo(), IndustriesChangeInfo(), IndustrytilesChangeInfo(), LoadFontGlyph(), LoadNewGRFFile(), ObjectChangeInfo(), ParamSet(), RailTypeChangeInfo(), RailVehicleChangeInfo(), ReadSpriteLayout(), ReadSpriteLayoutRegisters(), ReadSpriteLayoutSprite(), RoadVehicleChangeInfo(), SanitizeSpriteOffset(), ObjectOverrideManager::SetEntitySpec(), IndustryOverrideManager::SetEntitySpec(), HouseOverrideManager::SetEntitySpec(), SetNewGRFOverride(), ShipVehicleChangeInfo(), SkipAct12(), SoundEffectChangeInfo(), StationChangeInfo(), TownHouseChangeInfo(), TranslateGRFStrings(), and TranslateTTDPatchCodes().

static void GRFUnsafe ( ByteReader buf  )  [static]

Set the current NewGRF as unsafe for static use.

Parameters:
buf Unused.
Note:
Used during safety scan on unsafe actions.

Definition at line 7613 of file newgrf.cpp.

References GRFConfig::flags, GCF_UNSAFE, GrfProcessingState::grfconfig, SetBit(), and GrfProcessingState::skip_sprites.

static bool HandleNode ( byte  type,
uint32  id,
ByteReader buf,
AllowedSubtags  subtags[] 
) [static]

Handle the nodes of an Action14.

Parameters:
type Type of node.
id ID.
buf Buffer.
subtags Allowed subtags.
Returns:
Whether all tags could be handled.

Definition at line 7519 of file newgrf.cpp.

References BSWAP32(), AllowedSubtags::call_handler, AllowedSubtags::data, grfmsg(), HandleNodes(), AllowedSubtags::id, SkipUnknownInfo(), AllowedSubtags::text, and AllowedSubtags::type.

Referenced by HandleNodes().

static bool HandleNodes ( ByteReader buf,
AllowedSubtags  subtags[] 
) [static]

Handle the contents of a 'C' choice of an Action14.

Parameters:
buf Buffer.
subtags List of subtags.
Returns:
Whether the nodes could all be handled.

Definition at line 7557 of file newgrf.cpp.

References HandleNode().

Referenced by HandleNode(), HandleParameterInfo(), and StaticGRFInfo().

static bool HandleParameterInfo ( ByteReader buf  )  [static]

Callback function for 'INFO'->'PARA' to set extra information about the parameters.

Each subnode of 'INFO'->'PARA' should be a branch node with the parameter number as id. The first parameter has id 0. The maximum parameter that can be changed is set by 'INFO'->'NPAR' which defaults to 80.

Definition at line 7424 of file newgrf.cpp.

References SmallVector< T, S >::Append(), GrfProcessingState::grfconfig, grfmsg(), HandleNodes(), SmallVector< T, S >::Length(), GRFConfig::num_valid_params, GRFConfig::param_info, and SkipUnknownInfo().

static ChangeInfoResult IgnoreIndustryProperty ( int  prop,
ByteReader buf 
) [static]

Ignore an industry property.

Parameters:
prop The property to ignore.
buf The property value.
Returns:
ChangeInfoResult.

Definition at line 3032 of file newgrf.cpp.

Referenced by IndustriesChangeInfo().

static ChangeInfoResult IgnoreIndustryTileProperty ( int  prop,
ByteReader buf 
) [static]

Ignore an industry tile property.

Parameters:
prop The property to ignore.
buf The property value.
Returns:
ChangeInfoResult.

Definition at line 2878 of file newgrf.cpp.

Referenced by IndustrytilesChangeInfo().

static ChangeInfoResult IgnoreObjectProperty ( uint  prop,
ByteReader buf 
) [static]

Ignore properties for objects.

Parameters:
prop The property to ignore.
buf The property value.
Returns:
ChangeInfoResult.

Definition at line 3669 of file newgrf.cpp.

Referenced by ObjectChangeInfo().

static ChangeInfoResult IgnoreTownHouseProperty ( int  prop,
ByteReader buf 
) [static]

Ignore a house property.

Parameters:
prop Property to read.
buf Property value.
Returns:
ChangeInfoResult.

Definition at line 2061 of file newgrf.cpp.

Referenced by TownHouseChangeInfo().

static ChangeInfoResult IndustriesChangeInfo ( uint  indid,
int  numinfo,
int  prop,
ByteReader buf 
) [static]
static ChangeInfoResult IndustrytilesChangeInfo ( uint  indtid,
int  numinfo,
int  prop,
ByteReader buf 
) [static]

Define properties for industry tiles.

Parameters:
indtid Local ID of the industry tile.
numinfo Number of subsequent industry tile IDs to change the property for.
prop The property to change.
buf The property value.
Returns:
ChangeInfoResult.

Definition at line 2914 of file newgrf.cpp.

References IndustryTileSpec::acceptance, IndustryTileSpec::accepts_cargo, OverrideManagerBase::Add(), OverrideManagerBase::AddEntityID(), IndustryTileSpec::animation, IndustryTileSpec::callback_mask, AnimationInfo::frames, GB(), GrfProcessingState::grffile, grfmsg(), IgnoreIndustryTileProperty(), INDUSTRYTILE_NOANIM, NEW_INDUSTRYTILEOFFSET, NUM_INDUSTRYTILES, IndustryTileSpec::slopes_refused, IndustryTileSpec::special_flags, AnimationInfo::speed, AnimationInfo::status, and AnimationInfo::triggers.

void InitDepotWindowBlockSizes (  ) 

Set the size of the blocks in the window so we can be sure that they are big enough for the vehicle sprites in the current game.

Note:
Calling this function once for each game is enough.

Definition at line 185 of file depot_gui.cpp.

References GetVehicleHeight(), VEH_AIRCRAFT, VEH_ROAD, VEH_SHIP, and VEH_TRAIN.

Referenced by AfterLoadGRFs().

void InitGRFTownGeneratorNames (  ) 

Allocate memory for the NewGRF town names.

Definition at line 67 of file settings_gui.cpp.

References _grf_names, _nb_grf_names, free(), and INVALID_STRING_ID.

Referenced by AfterLoadGRFs().

static void InitNewGRFFile ( const GRFConfig config  )  [static]

Prepare loading a NewGRF file with its config.

Parameters:
config The NewGRF configuration struct with name, id, parameters and alike.

Definition at line 8018 of file newgrf.cpp.

References SmallVector< T, S >::Append(), GRFConfig::filename, GetFileByFilename(), GrfProcessingState::grffile, GRFIdentifier::grfid, GRFConfig::ident, INVALID_RAILTYPE, lengthof, MemCpyT(), GRFConfig::num_params, GRFConfig::param, GRFFile::param_end, GRFFile::price_base_multipliers, GRFFile::traininfo_vehicle_pitch, and GRFFile::traininfo_vehicle_width.

Referenced by LoadNewGRF().

static bool IsHouseSpecValid ( HouseSpec hs,
const HouseSpec next1,
const HouseSpec next2,
const HouseSpec next3,
const char *  filename 
) [static]

Check if a given housespec is valid and disable it if it's not.

The housespecs that follow it are used to check the validity of multitile houses.

Parameters:
hs The housespec to check.
next1 The housespec that follows hs.
next2 The housespec that follows next1.
next3 The housespec that follows next2.
filename The filename of the newgrf this house was defined in.
Returns:
Whether the given housespec is valid.

Definition at line 8303 of file newgrf.cpp.

References HouseSpec::building_availability, HouseSpec::building_flags, DEBUG, HouseSpec::enabled, HouseSpec::grf_prop, HZ_CLIMALL, HZ_ZONALL, GRFFilePropsBase< Tcnt >::local_id, and HouseSpec::population.

Referenced by FinaliseHouseArray().

void LoadNewGRF ( uint  load_index,
uint  file_index 
)
void LoadNewGRFFile ( GRFConfig config,
uint  file_index,
GrfLoadingStage  stage,
Subdirectory  subdir 
)
StringID MapGRFStringID ( uint32  grfid,
StringID  str 
)

Used when setting an object's property to map to the GRF's strings while taking in consideration the "drift" between TTDPatch string system and OpenTTD's one.

Parameters:
grfid Id of the grf file.
str StringID that we want to have the equivalent in OoenTTD.
Returns:
The properly adjusted StringID.

Definition at line 438 of file newgrf.cpp.

References GB(), GetGRFStringID(), and TTDPStringIDToOTTDStringIDMapping().

Referenced by AfterLoadGRFs(), ChangeIndustryProduction(), and TranslateTTDPatchCodes().

static void MapSpriteMappingRecolour ( PalSpriteID grf_sprite  )  [static]

Map the colour modifiers of TTDPatch to those that Open is using.

Parameters:
grf_sprite Pointer to the structure been modified.

Definition at line 592 of file newgrf.cpp.

References ClrBit(), HasBit(), PalSpriteID::pal, PALETTE_MODIFIER_COLOUR, PALETTE_MODIFIER_TRANSPARENT, SetBit(), PalSpriteID::sprite, and SPRITE_MODIFIER_OPAQUE.

Referenced by BridgeChangeInfo(), and ReadSpriteLayoutSprite().

static ChangeInfoResult ObjectChangeInfo ( uint  id,
int  numinfo,
int  prop,
ByteReader buf 
) [static]
static ChangeInfoResult RailTypeChangeInfo ( uint  id,
int  numinfo,
int  prop,
ByteReader buf 
) [static]
static ChangeInfoResult RailVehicleChangeInfo ( uint  engine,
int  numinfo,
int  prop,
ByteReader buf 
) [static]

Define properties for rail vehicles.

Parameters:
engine :ocal ID of the first vehicle.
numinfo Number of subsequent IDs to change the property for.
prop The property to change.
buf The property value.
Returns:
ChangeInfoResult.

Definition at line 913 of file newgrf.cpp.

References _cargo_mask, RailVehicleInfo::ai_passenger_only, RailVehicleInfo::air_drag, EngineInfo::base_intro, EngineInfo::callback_mask, RailVehicleInfo::capacity, EngineInfo::cargo_age_period, CommonVehicleChangeInfo(), ConvertTTDBasePrice(), RailVehicleInfo::cost_factor, CT_INVALID, GRFTempEngineData::ctt_exclude_mask, GRFTempEngineData::ctt_include_mask, EC_ELECTRIC, EF_USES_2CC, RailVehicleInfo::engclass, GetNewEngine(), GrfProcessingState::grffile, grfmsg(), GRFLoadedFeatures::has_2CC, HasBit(), Pool< Titem, Tindex, Tgrowth_step, Tmax_size, Tpool_type, Tcache, Tzero >::PoolItem< Tpool >::index, RailVehicleInfo::max_speed, EngineInfo::misc_flags, NUM_CARGO, RailVehicleInfo::pow_wag_power, RailVehicleInfo::pow_wag_weight, RailVehicleInfo::power, GRFTempEngineData::prop27_set, PROP_TRAIN_CARGO_AGE_PERIOD, PROP_TRAIN_CARGO_CAPACITY, PROP_TRAIN_COST_FACTOR, PROP_TRAIN_POWER, PROP_TRAIN_RUNNING_COST_FACTOR, PROP_TRAIN_SHORTEN_FACTOR, PROP_TRAIN_SPEED, PROP_TRAIN_TRACTIVE_EFFORT, PROP_TRAIN_USER_DATA, PROP_TRAIN_WEIGHT, RAILVEH_WAGON, GRFTempEngineData::refitmask_grf, GRFTempEngineData::refitmask_valid, EngineInfo::retire_early, RailVehicleInfo::running_cost, SB(), SetBit(), RailVehicleInfo::shorten_factor, RailVehicleInfo::tractive_effort, RailVehicleInfo::user_def_data, VE_DEFAULT, VE_DISABLE_EFFECT, VE_TYPE_COUNT, VE_TYPE_START, VEH_TRAIN, RailVehicleInfo::visual_effect, and RailVehicleInfo::weight.

static bool ReadSpriteLayout ( ByteReader buf,
uint  num_building_sprites,
bool  use_cur_spritesets,
byte  feature,
bool  allow_var10,
bool  no_z_position,
NewGRFSpriteLayout dts 
) [static]

Read a spritelayout from the GRF.

Parameters:
buf Input
num_building_sprites Number of building sprites to read
use_cur_spritesets Whether to use currently referenceable action 1 sets.
feature GrfSpecFeature to use spritesets from.
allow_var10 Whether the spritelayout may specifiy var10 values for resolving multiple action-1-2-3 chains
no_z_position Whether bounding boxes have no Z offset
dts Layout container to output into
Returns:
True on error (GRF was disabled).

Definition at line 734 of file newgrf.cpp.

References AllocaM, NewGRFSpriteLayout::Allocate(), NewGRFSpriteLayout::AllocateRegisters(), ClrBit(), NewGRFSpriteLayout::consistent_max_offset, DrawTileSeqStruct::delta_x, DrawTileSeqStruct::delta_z, DisableGrf(), grfmsg(), DrawTileSprites::ground, HasBit(), DrawTileSeqStruct::IsParentSprite(), TileLayoutRegisters::max_palette_offset, TileLayoutRegisters::max_sprite_offset, MemSetT(), ReadSpriteLayoutRegisters(), ReadSpriteLayoutSprite(), DrawTileSprites::seq, GrfProcessingState::skip_sprites, and TLF_NON_GROUND_FLAGS.

Referenced by StationChangeInfo().

static void ReadSpriteLayoutRegisters ( ByteReader buf,
TileLayoutFlags  flags,
bool  is_parent,
NewGRFSpriteLayout dts,
uint  index 
) [static]

Preprocess the TileLayoutFlags and read register modifiers from the GRF.

Parameters:
buf Input stream.
flags TileLayoutFlags to process.
is_parent Whether the sprite is a parentsprite with a bounding box.
dts Sprite layout to insert data into.
index Sprite index to process; 0 for ground sprite.

Definition at line 681 of file newgrf.cpp.

References NewGRFSpriteLayout::AllocateRegisters(), TileLayoutRegisters::child, DisableGrf(), TileLayoutRegisters::dodraw, TileLayoutRegisters::flags, grfmsg(), TileLayoutRegisters::palette, TileLayoutRegisters::palette_var10, TileLayoutRegisters::parent, TileLayoutRegisters::sprite, TileLayoutRegisters::sprite_var10, TLF_BB_XY_OFFSET, TLF_BB_Z_OFFSET, TLF_CHILD_X_OFFSET, TLF_CHILD_Y_OFFSET, TLF_DODRAW, TLF_DRAWING_FLAGS, TLF_PALETTE, TLF_PALETTE_VAR10, TLF_SPRITE, TLF_SPRITE_VAR10, and TLR_MAX_VAR10.

Referenced by ReadSpriteLayout().

static TileLayoutFlags ReadSpriteLayoutSprite ( ByteReader buf,
bool  read_flags,
bool  invert_action1_flag,
bool  use_cur_spritesets,
int  feature,
PalSpriteID grf_sprite,
uint16 *  max_sprite_offset = NULL,
uint16 *  max_palette_offset = NULL 
) [static]

Read a sprite and a palette from the GRF and convert them into a format suitable to OpenTTD.

Parameters:
buf Input stream.
read_flags Whether to read TileLayoutFlags.
invert_action1_flag Set to true, if palette bit 15 means 'not from action 1'.
use_cur_spritesets Whether to use currently referenceable action 1 sets.
feature GrfSpecFeature to use spritesets from.
[out] grf_sprite Read sprite and palette.
[out] max_sprite_offset Optionally returns the number of sprites in the spriteset of the sprite. (0 if no spritset)
[out] max_palette_offset Optionally returns the number of sprites in the spriteset of the palette. (0 if no spritset)
Returns:
Read TileLayoutFlags.

Definition at line 623 of file newgrf.cpp.

References ClrBit(), DisableGrf(), GB(), GrfProcessingState::GetNumEnts(), GrfProcessingState::GetSprite(), grfmsg(), HasBit(), GrfProcessingState::IsValidSpriteSet(), MapSpriteMappingRecolour(), PalSpriteID::pal, SB(), SetBit(), PalSpriteID::sprite, SPRITE_MODIFIER_CUSTOM_SPRITE, SPRITE_WIDTH, TLF_CUSTOM_PALETTE, TLF_PALETTE_REG_FLAGS, TLF_PALETTE_VAR10, TLF_SPRITE_REG_FLAGS, and TLF_SPRITE_VAR10.

Referenced by ReadSpriteLayout(), and StationChangeInfo().

static ChangeInfoResult RoadVehicleChangeInfo ( uint  engine,
int  numinfo,
int  prop,
ByteReader buf 
) [static]
static uint16 SanitizeSpriteOffset ( uint16 &  num,
uint16  offset,
int  max_sprites,
const char *  name 
) [static]

Sanitize incoming sprite offsets for Action 5 graphics replacements.

Parameters:
num The number of sprites to load.
offset Offset from the base.
max_sprites The maximum number of sprites that can be loaded in this action 5.
name Used for error warnings.
Returns:
The number of sprites that is going to be skipped.

Definition at line 5352 of file newgrf.cpp.

References grfmsg(), and max().

static void SetNewGRFOverride ( uint32  source_grfid,
uint32  target_grfid 
) [static]

Set the override for a NewGRF.

Parameters:
source_grfid The grfID which wants to override another NewGRF.
target_grfid The grfID which is being overridden.

Definition at line 467 of file newgrf.cpp.

References BSWAP32(), and grfmsg().

Referenced by LoadNewGRF().

static ChangeInfoResult ShipVehicleChangeInfo ( uint  engine,
int  numinfo,
int  prop,
ByteReader buf 
) [static]
static bool SkipUnknownInfo ( ByteReader buf,
byte  type 
) [static]

Try to skip the current node and all subnodes (if it's a branch node).

Parameters:
buf Buffer.
type The node type to skip.
Returns:
True if we could skip the node, false if an error occured.

Definition at line 7479 of file newgrf.cpp.

Referenced by ChangeGRFParamValueNames(), HandleNode(), and HandleParameterInfo().

static ChangeInfoResult SoundEffectChangeInfo ( uint  sid,
int  numinfo,
int  prop,
ByteReader buf 
) [static]

Define properties for sound effects.

Parameters:
sid Local ID of the sound.
numinfo Number of subsequent IDs to change the property for.
prop The property to change.
buf The property value.
Returns:
ChangeInfoResult.

Definition at line 2823 of file newgrf.cpp.

References GrfProcessingState::grffile, grfmsg(), and ORIGINAL_SAMPLE_COUNT.

static void StaticGRFInfo ( ByteReader buf  )  [static]

Handle Action 0x14.

Parameters:
buf Buffer.

Definition at line 7572 of file newgrf.cpp.

References HandleNodes().

static ChangeInfoResult StationChangeInfo ( uint  stid,
int  numinfo,
int  prop,
ByteReader buf 
) [static]
static ChangeInfoResult TownHouseChangeInfo ( uint  hid,
int  numinfo,
int  prop,
ByteReader buf 
) [static]
static bool ValidateIndustryLayout ( const IndustryTileTable layout,
int  size 
) [static]

Validate the industry layout; e.g.

to prevent duplicate tiles.

Parameters:
layout The layout to check.
size The size of the layout.
Returns:
True if the layout is deemed valid.

Definition at line 3117 of file newgrf.cpp.

References TileIndexDiffC::x, and TileIndexDiffC::y.

Referenced by IndustriesChangeInfo().


Variable Documentation

const Action5Type _action5_types[] [static]
Initial value:
 {
  
   { A5BLOCK_INVALID,      0,                            0, 0,                                           "Type 0x00"                },
   { A5BLOCK_INVALID,      0,                            0, 0,                                           "Type 0x01"                },
   { A5BLOCK_INVALID,      0,                            0, 0,                                           "Type 0x02"                },
   { A5BLOCK_INVALID,      0,                            0, 0,                                           "Type 0x03"                },
   { A5BLOCK_ALLOW_OFFSET, SPR_SIGNALS_BASE,             1, PRESIGNAL_SEMAPHORE_AND_PBS_SPRITE_COUNT,    "Signal graphics"          },
   { A5BLOCK_ALLOW_OFFSET, SPR_ELRAIL_BASE,              1, ELRAIL_SPRITE_COUNT,                         "Catenary graphics"        },
   { A5BLOCK_ALLOW_OFFSET, SPR_SLOPES_BASE,              1, NORMAL_AND_HALFTILE_FOUNDATION_SPRITE_COUNT, "Foundation graphics"      },
   { A5BLOCK_INVALID,      0,                           75, 0,                                           "TTDP GUI graphics"        }, 
   { A5BLOCK_ALLOW_OFFSET, SPR_CANALS_BASE,              1, CANALS_SPRITE_COUNT,                         "Canal graphics"           },
   { A5BLOCK_ALLOW_OFFSET, SPR_ONEWAY_BASE,              1, ONEWAY_SPRITE_COUNT,                         "One way road graphics"    },
   { A5BLOCK_ALLOW_OFFSET, SPR_2CCMAP_BASE,              1, TWOCCMAP_SPRITE_COUNT,                       "2CC colour maps"          },
   { A5BLOCK_ALLOW_OFFSET, SPR_TRAMWAY_BASE,             1, TRAMWAY_SPRITE_COUNT,                        "Tramway graphics"         },
   { A5BLOCK_INVALID,      0,                          133, 0,                                           "Snowy temperate tree"     }, 
   { A5BLOCK_FIXED,        SPR_SHORE_BASE,              16, SPR_SHORE_SPRITE_COUNT,                      "Shore graphics"           },
   { A5BLOCK_INVALID,      0,                            0, 0,                                           "New Signals graphics"     }, 
   { A5BLOCK_ALLOW_OFFSET, SPR_TRACKS_FOR_SLOPES_BASE,   1, TRACKS_FOR_SLOPES_SPRITE_COUNT,              "Sloped rail track"        },
   { A5BLOCK_ALLOW_OFFSET, SPR_AIRPORTX_BASE,            1, AIRPORTX_SPRITE_COUNT,                       "Airport graphics"         },
   { A5BLOCK_ALLOW_OFFSET, SPR_ROADSTOP_BASE,            1, ROADSTOP_SPRITE_COUNT,                       "Road stop graphics"       },
   { A5BLOCK_ALLOW_OFFSET, SPR_AQUEDUCT_BASE,            1, AQUEDUCT_SPRITE_COUNT,                       "Aqueduct graphics"        },
   { A5BLOCK_ALLOW_OFFSET, SPR_AUTORAIL_BASE,            1, AUTORAIL_SPRITE_COUNT,                       "Autorail graphics"        },
   { A5BLOCK_ALLOW_OFFSET, SPR_FLAGS_BASE,               1, FLAGS_SPRITE_COUNT,                          "Flag graphics"            },
   { A5BLOCK_ALLOW_OFFSET, SPR_OPENTTD_BASE,             1, OPENTTD_SPRITE_COUNT,                        "OpenTTD GUI graphics"     },
   { A5BLOCK_ALLOW_OFFSET, SPR_AIRPORT_PREVIEW_BASE,     1, SPR_AIRPORT_PREVIEW_COUNT,                   "Airport preview graphics" },
}

The information about action 5 types.

Definition at line 5389 of file newgrf.cpp.

const CargoLabel* const _default_refitmasks[] [static]
Initial value:
 {
  _default_refitmasks_rail,
  _default_refitmasks_road,
  _default_refitmasks_ships,
  _default_refitmasks_aircraft,
}

Definition at line 8089 of file newgrf.cpp.

const CargoLabel _default_refitmasks_aircraft[] [static]
Initial value:
 {
  'PASS', 'MAIL', 'GOOD', 'VALU', 'GOLD', 'DIAM', 'FOOD', 'FRUT', 'SUGR',
  'TOYS', 'BATT', 'SWET', 'TOFF', 'COLA', 'CTCD', 'BUBL', 'PLST', 'FZDR',
  0 }

Definition at line 8084 of file newgrf.cpp.

Initial value:
 {
  'PASS', 'COAL', 'MAIL', 'LVST', 'GOOD', 'GRAI', 'WHEA', 'MAIZ', 'WOOD',
  'IORE', 'STEL', 'VALU', 'GOLD', 'DIAM', 'PAPR', 'FOOD', 'FRUT', 'CORE',
  'WATR', 'SUGR', 'TOYS', 'BATT', 'SWET', 'TOFF', 'COLA', 'CTCD', 'BUBL',
  'PLST', 'FZDR',
  0 }

List of what cargo labels are refittable for the given the vehicle-type.

Only currently active labels are applied.

Definition at line 8067 of file newgrf.cpp.

const CargoLabel _default_refitmasks_road[] [static]
Initial value:
 {
  0 }

Definition at line 8074 of file newgrf.cpp.

const CargoLabel _default_refitmasks_ships[] [static]
Initial value:
 {
  'COAL', 'MAIL', 'LVST', 'GOOD', 'GRAI', 'WHEA', 'MAIZ', 'WOOD', 'IORE',
  'STEL', 'VALU', 'GOLD', 'DIAM', 'PAPR', 'FOOD', 'FRUT', 'CORE', 'WATR',
  'RUBR', 'SUGR', 'TOYS', 'BATT', 'SWET', 'TOFF', 'COLA', 'CTCD', 'BUBL',
  'PLST', 'FZDR',
  0 }

Definition at line 8077 of file newgrf.cpp.

uint32 _grm_engines[256] [static]

Contains the GRF ID of the owner of a vehicle if it has been reserved.

GRM for vehicles is only used if dynamic engine allocation is disabled, so 256 is the number of original engines.

Definition at line 310 of file newgrf.cpp.

Referenced by ParamSet(), and ResetNewGRFData().

Initial value:

Action14 root tags.

Definition at line 7467 of file newgrf.cpp.

uint32 _ttdpatch_flags[8] [static]

32 * 8 = 256 flags.

Apparently TTDPatch uses this many..

Definition at line 71 of file newgrf.cpp.

Referenced by InitializeGRFSpecial().