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 "variables.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.h"
#include "newgrf_cargo.h"
#include "newgrf_house.h"
#include "newgrf_sound.h"
#include "newgrf_station.h"
#include "industry.h"
#include "newgrf_canal.h"
#include "newgrf_commons.h"
#include "newgrf_townname.h"
#include "newgrf_industries.h"
#include "rev.h"
#include "fios.h"
#include "rail.h"
#include "strings_func.h"
#include "date_func.h"
#include "string_func.h"
#include "network/network.h"
#include <map>
#include "core/alloc_type.hpp"
#include "core/mem_func.hpp"
#include "smallmap_gui.h"
#include "table/strings.h"
#include "table/build_industry.h"

Go to the source code of this file.

Data Structures

class  OTTDByteReaderSignal
class  ByteReader
struct  GRFTempEngineData
struct  GRFLocation

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)

Enumerations

enum  GrfDataType { GDT_SOUND }
enum  { MAX_STATIONS = 256 }
enum  ChangeInfoResult { CIR_SUCCESS, CIR_UNHANDLED, CIR_UNKNOWN, CIR_INVALID_ID }

Functions

void CDECL grfmsg (int severity, const char *str,...)
 DEBUG() function dedicated to newGRF debugging messages Function is essentialy the same as DEBUG(grf, severity, .
static GRFFileGetFileByGRFID (uint32 grfid)
static GRFFileGetFileByFilename (const char *filename)
static void ClearTemporaryNewGRFData (GRFFile *gf)
 Reset all NewGRFData that was used only while processing data.
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 uint8 MapDOSColour (uint8 colour)
static void SetNewGRFOverride (uint32 source_grfid, uint32 target_grfid)
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)
static void MapSpriteMappingRecolour (PalSpriteID *grf_sprite)
 Map the colour modifiers of TTDPatch to those that Open is using.
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)
static ChangeInfoResult RailVehicleChangeInfo (uint engine, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult RoadVehicleChangeInfo (uint engine, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult ShipVehicleChangeInfo (uint engine, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult AircraftVehicleChangeInfo (uint engine, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult StationChangeInfo (uint stid, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult CanalChangeInfo (uint id, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult BridgeChangeInfo (uint brid, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult IgnoreTownHouseProperty (int prop, ByteReader *buf)
static ChangeInfoResult TownHouseChangeInfo (uint hid, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult GlobalVarChangeInfo (uint gvid, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult GlobalVarReserveInfo (uint gvid, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult CargoChangeInfo (uint cid, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult SoundEffectChangeInfo (uint sid, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult IgnoreIndustryTileProperty (int prop, ByteReader *buf)
static ChangeInfoResult IndustrytilesChangeInfo (uint indtid, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult IgnoreIndustryProperty (int prop, ByteReader *buf)
static bool ValidateIndustryLayout (const IndustryTileTable *layout, int size)
 Validate the industry layout; e.g.
static ChangeInfoResult IndustriesChangeInfo (uint indid, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult RailTypeChangeInfo (uint id, int numinfo, int prop, ByteReader *buf)
static ChangeInfoResult RailTypeReserveInfo (uint id, 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, uint16 num_sprites)
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 RailTypeMapSpriteGroup (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)
bool GetGlobalVariable (byte param, uint32 *value)
 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)
static void SafeGRFInhibit (ByteReader *buf)
static void GRFInhibit (ByteReader *buf)
static void FeatureTownName (ByteReader *buf)
static void DefineGotoLabel (ByteReader *buf)
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)
static void SkipAct12 (ByteReader *buf)
static void TranslateGRFStrings (ByteReader *buf)
static void GRFDataBlock (ByteReader *buf)
static void GRFUnsafe (ByteReader *buf)
static void InitializeGRFSpecial ()
static void ResetCustomStations ()
static void ResetCustomHouses ()
static void ResetCustomIndustries ()
static void ResetNewGRF ()
static void ResetNewGRFErrors ()
static void ResetNewGRFData ()
 Reset all NewGRF loaded data TODO.
static void BuildCargoTranslationMap ()
static void InitNewGRFFile (const GRFConfig *config, int sprite_offset)
static void CalculateRefitMasks ()
 Precalculate refit masks from cargo classes for all vehicles.
static void FinaliseHouseArray ()
 Add all new houses to the house array.
static void FinaliseIndustriesArray ()
 Add all new industries to the industry array.
static void DecodeSpecialSprite (byte *buf, uint num, GrfLoadingStage stage)
void LoadNewGRFFile (GRFConfig *config, uint file_index, GrfLoadingStage stage)
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 ()
static void AfterLoadGRFs ()
void LoadNewGRF (uint load_index, uint file_index)
bool HasGrfMiscBit (GrfMiscBit bit)

Variables

static int _skip_sprites
static uint _file_index
static SmallVector< GRFFile *, 16 > _grf_files
static GRFFile_cur_grffile
static SpriteID _cur_spriteid
static GrfLoadingStage _cur_stage
static uint32 _nfo_line
static GRFConfig_cur_grfconfig
static byte _misc_grf_features = 0
static uint32 _ttdpatch_flags [8]
GRFLoadedFeatures _loaded_newgrf_features
static byte _grf_data_blocks
static GrfDataType _grf_data_type
static GRFTempEngineData_gted
static uint32 _grm_engines [256]
static uint32 _grm_cargos [NUM_CARGO *2]
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 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

Enumerator:
CIR_SUCCESS 

Variable was parsed and read.

CIR_UNHANDLED 

Variable was parsed but unread.

CIR_UNKNOWN 

Variable is unknown.

CIR_INVALID_ID 

Attempt to modify an invalid ID.

Definition at line 473 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 6446 of file newgrf.cpp.

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

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 454 of file newgrf.cpp.

References grfmsg().

Referenced by RailVehicleChangeInfo().

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 4366 of file newgrf.cpp.

References ClearTemporaryNewGRFData(), GRFError::data, GRFConfig::error, GCS_DISABLED, GRFIdentifier::grfid, GRFConfig::name, and GRFConfig::status.

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 6138 of file newgrf.cpp.

References SmallVector< T, S >::Begin(), HouseSpec::building_flags, HouseSpec::enabled, SmallVector< T, S >::End(), HouseSpec::local_id, MAX_YEAR, HouseSpec::min_year, HouseSpec::population, and HouseOverrideManager::SetEntitySpec().

static void FinaliseIndustriesArray (  )  [static]
bool GetGlobalVariable ( byte  param,
uint32 *  value 
)

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.
Returns:
true iff the variable is known and the value is returned in 'value'.

Definition at line 4093 of file newgrf.cpp.

References _cur_year, _date, _settings_game, Clamp(), ConvertDateToYMD(), ConvertYMDToDate(), YearMonthDay::day, DAYS_TILL_ORIGINAL_BASE_YEAR, DifficultySettings::diff_level, GameSettings::difficulty, VehicleSettings::disable_elrails, GameSettings::game_creation, GB(), GetRailTypeInfo(), GetSnowLine(), GMB_TRAIN_WIDTH_32_PIXELS, HasBit(), GameCreationSettings::landscape, max(), YearMonthDay::month, ORIGINAL_BASE_YEAR, ORIGINAL_MAX_YEAR, RAILTYPE_ELECTRIC, RAILTYPE_MAGLEV, RAILTYPE_MONO, RAILTYPE_RAIL, VehicleSettings::road_side, SB(), SetBit(), GRFFile::traininfo_vehicle_pitch, GRFFile::traininfo_vehicle_width, GameSettings::vehicle, GRFConfig::windows_paletted, and YearMonthDay::year.

static Engine* GetNewEngine ( const GRFFile file,
VehicleType  type,
uint16  internal_id,
bool  static_access = false 
) [static]
static void GraphicsNew ( ByteReader buf  )  [static]

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

< Allow replacing any subset by specifiing an offset.

< unknown/not-implemented type

< How is this Action5 type processed?

< Load the sprites starting from this sprite.

< If the Action5 contains less sprites, the whole block will be ignored.

< If the Action5 contains more sprites, only the first max_sprites sprites will be used.

< Name for error messages.

Definition at line 3960 of file newgrf.cpp.

References ClrBit(), grfmsg(), HasBit(), lengthof, SanitizeSpriteOffset(), GRFLoadedFeatures::shore, SHORE_REPLACE_ACTION_5, SHORE_REPLACE_NONE, and SHORE_REPLACE_ONLY_NEW.

void CDECL grfmsg ( int  severity,
const char *  str,
  ... 
)

DEBUG() function dedicated to newGRF debugging messages Function is essentialy 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 233 of file newgrf.cpp.

References GRFConfig::filename.

Referenced by AddGenericCallback(), AddGRFString(), AllocateStationClass(), ConvertTTDBasePrice(), GetNewEngine(), GraphicsNew(), RailVehicleChangeInfo(), SanitizeSpriteOffset(), IndustryOverrideManager::SetEntitySpec(), HouseOverrideManager::SetEntitySpec(), ShipVehicleChangeInfo(), and TownHouseChangeInfo().

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 194 of file depot_gui.cpp.

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

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 290 of file newgrf.cpp.

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

Referenced by ChangeIndustryProduction().

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 429 of file newgrf.cpp.

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

static ChangeInfoResult RailVehicleChangeInfo ( 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 3939 of file newgrf.cpp.

References grfmsg(), and max().

Referenced by GraphicsNew().

static ChangeInfoResult ShipVehicleChangeInfo ( uint  engine,
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 2343 of file newgrf.cpp.

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


Variable Documentation

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

Definition at line 6053 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 6048 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 6031 of file newgrf.cpp.

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

Definition at line 6038 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 6041 of file newgrf.cpp.


Generated on Fri Apr 30 21:55:33 2010 for OpenTTD by  doxygen 1.6.1