OpenTTD Source  1.10.0-RC1
newgrf_cargo.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "stdafx.h"
11 #include "debug.h"
12 #include "newgrf_spritegroup.h"
13 
14 #include "safeguards.h"
15 
18  const CargoSpec *cargospec;
19 
21 
22  const SpriteGroup *ResolveReal(const RealSpriteGroup *group) const override;
23 
24  GrfSpecFeature GetFeature() const override;
25  uint32 GetDebugID() const override;
26 };
27 
28 /* virtual */ const SpriteGroup *CargoResolverObject::ResolveReal(const RealSpriteGroup *group) const
29 {
30  /* Cargo action 2s should always have only 1 "loaded" state, but some
31  * times things don't follow the spec... */
32  if (group->num_loaded > 0) return group->loaded[0];
33  if (group->num_loading > 0) return group->loading[0];
34 
35  return nullptr;
36 }
37 
39 {
40  return GSF_CARGOES;
41 }
42 
44 {
45  return this->cargospec->label;
46 }
47 
56  : ResolverObject(cs->grffile, callback, callback_param1, callback_param2), cargospec(cs)
57 {
58  this->root_spritegroup = cs->group;
59 }
60 
67 {
68  CargoResolverObject object(cs);
69  const SpriteGroup *group = object.Resolve();
70  if (group == nullptr) return 0;
71 
72  return group->GetResult();
73 }
74 
75 
76 uint16 GetCargoCallback(CallbackID callback, uint32 param1, uint32 param2, const CargoSpec *cs)
77 {
78  CargoResolverObject object(cs, callback, param1, param2);
79  return object.ResolveCallback();
80 }
81 
91 CargoID GetCargoTranslation(uint8 cargo, const GRFFile *grffile, bool usebit)
92 {
93  /* Pre-version 7 uses the 'climate dependent' ID in callbacks and properties, i.e. cargo is the cargo ID */
94  if (grffile->grf_version < 7 && !usebit) return cargo;
95 
96  /* Other cases use (possibly translated) cargobits */
97 
98  if (grffile->cargo_list.size() > 0) {
99  /* ...and the cargo is in bounds, then get the cargo ID for
100  * the label */
101  if (cargo < grffile->cargo_list.size()) return GetCargoIDByLabel(grffile->cargo_list[cargo]);
102  } else {
103  /* Else the cargo value is a 'climate independent' 'bitnum' */
104  return GetCargoIDByBitnum(cargo);
105  }
106  return CT_INVALID;
107 }
SpriteID GetCustomCargoSprite(const CargoSpec *cs)
Get the custom sprite for the given cargo type.
CargoID GetCargoIDByLabel(CargoLabel cl)
Get the cargo ID by cargo label.
Definition: cargotype.cpp:86
Functions related to debugging.
CargoID GetCargoTranslation(uint8 cargo, const GRFFile *grffile, bool usebit)
Translate a GRF-local cargo slot/bitnum into a CargoID.
Interface for SpriteGroup-s to access the gamestate.
Specification of a cargo type.
Definition: cargotype.h:55
Set when using the callback resolve system, but not to resolve a callback.
byte num_loaded
Number of loaded groups.
uint32 callback_param1
First parameter (var 10) of the callback.
const SpriteGroup * root_spritegroup
Root SpriteGroup to use for resolving.
Invalid cargo type.
Definition: cargo_type.h:68
GrfSpecFeature
Definition: newgrf.h:66
uint32 callback_param2
Second parameter (var 18) of the callback.
virtual const SpriteGroup * Resolve(ResolverObject &object) const
Base sprite group resolver.
Action 2 handling.
const SpriteGroup ** loaded
List of loaded groups (can be SpriteIDs or Callback results)
const SpriteGroup * ResolveReal(const RealSpriteGroup *group) const override
Get the real sprites of the grf.
Definition of base types and functions in a cross-platform compatible way.
A number of safeguards to prevent using unsafe methods.
CargoLabel label
Unique label of the cargo type.
Definition: cargotype.h:57
Resolver of cargo.
const SpriteGroup ** loading
List of loading groups (can be SpriteIDs or Callback results)
uint32 GetDebugID() const override
Get an identifier for the item being resolved.
byte num_loading
Number of loading groups.
const GRFFile * grffile
GRFFile the resolved SpriteGroup belongs to.
CargoID GetCargoIDByBitnum(uint8 bitnum)
Find the CargoID of a &#39;bitnum&#39; value.
Definition: cargotype.cpp:103
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
CallbackID callback
Callback being resolved.
CallbackID
List of implemented NewGRF callbacks.
std::vector< CargoLabel > cargo_list
Cargo translation table (local ID -> label)
Definition: newgrf.h:126
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
GrfSpecFeature GetFeature() const override
Get the feature number being resolved for.
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:105
CargoResolverObject(const CargoSpec *cs, CallbackID callback=CBID_NO_CALLBACK, uint32 callback_param1=0, uint32 callback_param2=0)
Constructor of the cargo resolver.