OpenTTD

newgrf_object.h
Go to the documentation of this file.
1 /* $Id: newgrf_object.h 27984 2018-03-11 13:19:41Z frosch $ */
2
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
9
12 #ifndef NEWGRF_OBJECT_H
13 #define NEWGRF_OBJECT_H
14
15 #include "newgrf_callbacks.h"
16 #include "newgrf_spritegroup.h"
17 #include "newgrf_town.h"
18 #include "economy_func.h"
19 #include "date_type.h"
20 #include "object_type.h"
21 #include "newgrf_animation_type.h"
22 #include "newgrf_class.h"
23 #include "newgrf_commons.h"
24
26 enum ObjectFlags {
27 OBJECT_FLAG_NONE = 0,
28 OBJECT_FLAG_ONLY_IN_SCENEDIT = 1 << 0,
29 OBJECT_FLAG_CANNOT_REMOVE = 1 << 1,
30 OBJECT_FLAG_AUTOREMOVE = 1 << 2,
31 OBJECT_FLAG_BUILT_ON_WATER = 1 << 3,
32 OBJECT_FLAG_CLEAR_INCOME = 1 << 4,
33 OBJECT_FLAG_HAS_NO_FOUNDATION = 1 << 5,
34 OBJECT_FLAG_ANIMATION = 1 << 6,
35 OBJECT_FLAG_ONLY_IN_GAME = 1 << 7,
36 OBJECT_FLAG_2CC_COLOUR = 1 << 8,
37 OBJECT_FLAG_NOT_ON_LAND = 1 << 9,
38 OBJECT_FLAG_DRAW_WATER = 1 << 10,
39 OBJECT_FLAG_ALLOW_UNDER_BRIDGE = 1 << 11,
40 OBJECT_FLAG_ANIM_RANDOM_BITS = 1 << 12,
41 OBJECT_FLAG_SCALE_BY_WATER = 1 << 13,
42 };
43 DECLARE_ENUM_AS_BIT_SET(ObjectFlags)
44
45 void ResetObjects();
46
48 enum ObjectClassID {
49 OBJECT_CLASS_BEGIN = 0,
50 OBJECT_CLASS_MAX = 0xFF,
51 INVALID_OBJECT_CLASS = 0xFF,
52 };
54 DECLARE_POSTFIX_INCREMENT(ObjectClassID)
55
56
60 struct ObjectSpec {
61 /* 2 because of the "normal" and "buy" sprite stacks. */
62 GRFFilePropsBase<2> grf_prop;
63 ObjectClassID cls_id;
64 StringID name;
65
66 uint8 climate;
67 uint8 size;
68 uint8 build_cost_multiplier;
69 uint8 clear_cost_multiplier;
70 Date introduction_date;
71 Date end_of_life_date;
72 ObjectFlags flags;
73 AnimationInfo animation;
74 uint16 callback_mask;
75 uint8 height;
76 uint8 views;
77 uint8 generate_amount;
78 bool enabled;
79
84 Money GetBuildCost() const { return GetPrice(PR_BUILD_OBJECT, this->build_cost_multiplier, this->grf_prop.grffile, 0); }
85
90 Money GetClearCost() const { return GetPrice(PR_CLEAR_OBJECT, this->clear_cost_multiplier, this->grf_prop.grffile, 0); }
91
92 bool IsEverAvailable() const;
93 bool WasEverAvailable() const;
94 bool IsAvailable() const;
95 uint Index() const;
96
97 static const ObjectSpec *Get(ObjectType index);
98 static const ObjectSpec *GetByTile(TileIndex tile);
99 };
100
102 struct ObjectScopeResolver : public ScopeResolver {
103 struct Object *obj;
104 TileIndex tile;
105 uint8 view;
106
114 ObjectScopeResolver(ResolverObject &ro, Object *obj, TileIndex tile, uint8 view = 0)
115 : ScopeResolver(ro), obj(obj), tile(tile), view(view)
116 {
117 }
118
119 /* virtual */ uint32 GetRandomBits() const;
120 /* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
121 };
122
124 struct ObjectResolverObject : public ResolverObject {
125 ObjectScopeResolver object_scope;
126 TownScopeResolver *town_scope;
127
128 ObjectResolverObject(const ObjectSpec *spec, Object *o, TileIndex tile, uint8 view = 0,
129 CallbackID callback = CBID_NO_CALLBACK, uint32 param1 = 0, uint32 param2 = 0);
130 ~ObjectResolverObject();
131
132 /* virtual */ ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0)
133 {
134 switch (scope) {
135 case VSG_SCOPE_SELF:
136 return &this->object_scope;
137
138 case VSG_SCOPE_PARENT: {
139 TownScopeResolver *tsr = this->GetTown();
140 if (tsr != NULL) return tsr;
141 }
142 FALLTHROUGH;
143
144 default:
145 return ResolverObject::GetScope(scope, relative);
146 }
147 }
148
149 private:
150 TownScopeResolver *GetTown();
151 };
152
154 typedef NewGRFClass<ObjectSpec, ObjectClassID, OBJECT_CLASS_MAX> ObjectClass;
155
157 static const CargoID CT_PURCHASE_OBJECT = 1;
158
159 uint16 GetObjectCallback(CallbackID callback, uint32 param1, uint32 param2, const ObjectSpec *spec, Object *o, TileIndex tile, uint8 view = 0);
160
161 void DrawNewObjectTile(TileInfo *ti, const ObjectSpec *spec);
162 void DrawNewObjectTileInGUI(int x, int y, const ObjectSpec *spec, uint8 view);
163 void AnimateNewObjectTile(TileIndex tile);
164 void TriggerObjectTileAnimation(Object *o, TileIndex tile, ObjectAnimationTrigger trigger, const ObjectSpec *spec);
165 void TriggerObjectAnimation(Object *o, ObjectAnimationTrigger trigger, const ObjectSpec *spec);
166
167 #endif /* NEWGRF_OBJECT_H */
ScopeResolver
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope)...
Definition: newgrf_spritegroup.h:291
DECLARE_ENUM_AS_BIT_SET
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Definition: company_manager_face.h:31
OBJECT_CLASS_MAX
Maximum number of classes.
Definition: newgrf_object.h:50
ObjectFlags
ObjectFlags
Various object behaviours.
Definition: newgrf_object.h:26
OBJECT_FLAG_2CC_COLOUR
Object wants 2CC colour mapping.
Definition: newgrf_object.h:36
ObjectSpec::flags
ObjectFlags flags
Flags/settings related to the object.
Definition: newgrf_object.h:72
TileInfo
Tile information, used while rendering the tile.
Definition: tile_cmd.h:44
ObjectSpec::GetBuildCost
Money GetBuildCost() const
Get the cost for building a structure of this type.
Definition: newgrf_object.h:84
ScopeResolver::ro
ResolverObject & ro
Surrounding resolver object.
Definition: newgrf_spritegroup.h:292
ObjectSpec::build_cost_multiplier
uint8 build_cost_multiplier
Build cost multiplier per tile.
Definition: newgrf_object.h:68
VarSpriteGroupScope
VarSpriteGroupScope
Definition: newgrf_spritegroup.h:100
OBJECT_FLAG_NONE
Just nothing.
Definition: newgrf_object.h:27
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition: newgrf_spritegroup.h:310
ObjectSpec::grf_prop
GRFFilePropsBase< 2 > grf_prop
Properties related the the grf file.
Definition: newgrf_object.h:62
DrawNewObjectTile
void DrawNewObjectTile(TileInfo *ti, const ObjectSpec *spec)
Draw an object on the map.
Definition: newgrf_object.cpp:437
INVALID_OBJECT_CLASS
Class for the less fortunate.
Definition: newgrf_object.h:51
newgrf_animation_type.h
Definitions related to NewGRF animation.
OBJECT_FLAG_CANNOT_REMOVE
Object can not be removed.
Definition: newgrf_object.h:29
OBJECT_FLAG_DRAW_WATER
Object wants to be drawn on water.
Definition: newgrf_object.h:38
CBID_NO_CALLBACK
Set when using the callback resolve system, but not to resolve a callback.
Definition: newgrf_callbacks.h:24
ObjectSpec
Allow incrementing of ObjectClassID variables.
Definition: newgrf_object.h:60
ObjectSpec::end_of_life_date
Date end_of_life_date
When can&#39;t this object be built anymore.
Definition: newgrf_object.h:71
OBJECT_FLAG_AUTOREMOVE
Object get automatically removed (like "owned land").
Definition: newgrf_object.h:30
CT_PURCHASE_OBJECT
static const CargoID CT_PURCHASE_OBJECT
Mapping of purchase for objects.
Definition: newgrf_object.h:157
ResolverObject::GetScope
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
Definition: newgrf_spritegroup.cpp:142
AnimateNewObjectTile
void AnimateNewObjectTile(TileIndex tile)
Handle the animation of the object tile.
Definition: newgrf_object.cpp:516
ObjectSpec::introduction_date
Date introduction_date
From when can this object be built.
Definition: newgrf_object.h:70
ObjectClass
NewGRFClass< ObjectSpec, ObjectClassID, OBJECT_CLASS_MAX > ObjectClass
Struct containing information relating to object classes.
Definition: newgrf_object.h:154
newgrf_callbacks.h
Callbacks that NewGRFs could implement.
GetPrice
Money GetPrice(Price index, uint cost_factor, const GRFFile *grf_file, int shift)
Determine a certain price.
Definition: economy.cpp:958
ObjectScopeResolver
Object scope resolver.
Definition: newgrf_object.h:102
ObjectSpec::size
uint8 size
The size of this objects; low nibble for X, high nibble for Y.
Definition: newgrf_object.h:67
ObjectScopeResolver::ObjectScopeResolver
ObjectScopeResolver(ResolverObject &ro, Object *obj, TileIndex tile, uint8 view=0)
Constructor of an object scope resolver.
Definition: newgrf_object.h:114
ObjectSpec::height
uint8 height
The height of this structure, in heightlevels; max MAX_TILE_HEIGHT.
Definition: newgrf_object.h:75
ObjectResolverObject::object_scope
ObjectScopeResolver object_scope
The object scope resolver.
Definition: newgrf_object.h:125
NewGRFClass
Struct containing information relating to NewGRF classes for stations and airports.
Definition: newgrf_class.h:21
ObjectScopeResolver::view
uint8 view
The view of the object.
Definition: newgrf_object.h:105
ObjectSpec::enabled
bool enabled
Is this spec enabled?
Definition: newgrf_object.h:78
newgrf_spritegroup.h
Action 2 handling.
object_type.h
Types related to object tiles.
OBJECT_FLAG_ONLY_IN_GAME
Object can only be built in game.
Definition: newgrf_object.h:35
ObjectScopeResolver::obj
struct Object * obj
The object the callback is ran for.
Definition: newgrf_object.h:103
ObjectSpec::GetClearCost
Money GetClearCost() const
Get the cost for clearing a structure of this type.
Definition: newgrf_object.h:90
TriggerObjectTileAnimation
void TriggerObjectTileAnimation(Object *o, TileIndex tile, ObjectAnimationTrigger trigger, const ObjectSpec *spec)
Trigger the update of animation on a single tile.
Definition: newgrf_object.cpp:531
ObjectScopeResolver::tile
TileIndex tile
The tile related to the object.
Definition: newgrf_object.h:104
OBJECT_FLAG_ONLY_IN_SCENEDIT
Object can only be constructed in the scenario editor.
Definition: newgrf_object.h:28
TriggerObjectAnimation
void TriggerObjectAnimation(Object *o, ObjectAnimationTrigger trigger, const ObjectSpec *spec)
Trigger the update of animation on a whole object.
Definition: newgrf_object.cpp:544
ObjectSpec::animation
AnimationInfo animation
Information about the animation.
Definition: newgrf_object.h:73
TownScopeResolver
Scope resolver for a town.
Definition: newgrf_town.h:24
ObjectSpec::callback_mask
uint16 callback_mask
Bitmask of requested/allowed callbacks.
Definition: newgrf_object.h:74
Object
An object, such as transmitter, on the map.
Definition: object_base.h:25
ObjectSpec::views
uint8 views
The number of views.
Definition: newgrf_object.h:76
OBJECT_FLAG_CLEAR_INCOME
When object is cleared a positive income is generated instead of a cost.
Definition: newgrf_object.h:32
DrawNewObjectTileInGUI
void DrawNewObjectTileInGUI(int x, int y, const ObjectSpec *spec, uint8 view)
Draw representation of an object (tile) for GUI purposes.
Definition: newgrf_object.cpp:455
ObjectResolverObject::GetScope
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
Definition: newgrf_object.h:132
OBJECT_FLAG_NOT_ON_LAND
Object can not be on land, implicitly sets OBJECT_FLAG_BUILT_ON_WATER.
Definition: newgrf_object.h:37
VSG_SCOPE_SELF
Resolved object itself.
Definition: newgrf_spritegroup.h:103
ObjectType
uint16 ObjectType
Types of objects.
Definition: object_type.h:16
OBJECT_FLAG_ANIM_RANDOM_BITS
Object wants random bits in "next animation frame" callback.
Definition: newgrf_object.h:40
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
OBJECT_CLASS_BEGIN
The lowest valid value.
Definition: newgrf_object.h:49
OBJECT_FLAG_ANIMATION
Object has animated tiles.
Definition: newgrf_object.h:34
ObjectSpec::name
StringID name
The name for this object.
Definition: newgrf_object.h:64
GetObjectCallback
uint16 GetObjectCallback(CallbackID callback, uint32 param1, uint32 param2, const ObjectSpec *spec, Object *o, TileIndex tile, uint8 view=0)
Perform a callback for an object.
Definition: newgrf_object.cpp:399
newgrf_class.h
Header file for classes to be used by e.g.
ObjectSpec::clear_cost_multiplier
uint8 clear_cost_multiplier
Clear cost multiplier per tile.
Definition: newgrf_object.h:69
OBJECT_FLAG_SCALE_BY_WATER
Object count is roughly scaled by water amount at edges.
Definition: newgrf_object.h:41
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
ObjectResolverObject::town_scope
TownScopeResolver * town_scope
The town scope resolver (created on the first call).
Definition: newgrf_object.h:126
economy_func.h
Functions related to the economy.
VSG_SCOPE_PARENT
Related object of the resolved one.
Definition: newgrf_spritegroup.h:104
ObjectScopeResolver::GetVariable
uint32 GetVariable(byte variable, uint32 parameter, bool *available) const
Used by the resolver to get values for feature 0F deterministic spritegroups.
Definition: newgrf_object.cpp:234
GRFFilePropsBase< 2 >
ObjectSpec::generate_amount
uint8 generate_amount
Number of objects which are attempted to be generated per 256^2 map during world generation.
Definition: newgrf_object.h:77
ObjectAnimationTrigger
ObjectAnimationTrigger
Animation triggers for objects.
Definition: newgrf_animation_type.h:57
ObjectScopeResolver::GetRandomBits
uint32 GetRandomBits() const
Get a few random bits.
Definition: newgrf_object.cpp:131
date_type.h
Types related to the dates in OpenTTD.
newgrf_commons.h
This file simplyfies and embeds a common mechanism of loading/saving and mapping of grf entities...
AnimationInfo
Information about animation.
Definition: newgrf_animation_type.h:20
Date
int32 Date
The type to store our dates in.
Definition: date_type.h:16
ObjectResolverObject
A resolver object to be used with feature 0F spritegroups.
Definition: newgrf_object.h:124
GRFFilePropsBase::grffile
const struct GRFFile * grffile
grf file that introduced this entity
Definition: newgrf_commons.h:320
CallbackID
CallbackID
List of implemented NewGRF callbacks.
Definition: newgrf_callbacks.h:22
OBJECT_FLAG_BUILT_ON_WATER
Object can be built on water (not required).
Definition: newgrf_object.h:31
OBJECT_FLAG_ALLOW_UNDER_BRIDGE
Object can built under a bridge.
Definition: newgrf_object.h:39
newgrf_town.h
Functions to handle the town part of NewGRF towns.
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
DECLARE_POSTFIX_INCREMENT
#define DECLARE_POSTFIX_INCREMENT(type)
Some enums need to have allowed incrementing (i.e.
Definition: enum_type.hpp:16
ObjectSpec::cls_id
ObjectClassID cls_id
The class to which this spec belongs.
Definition: newgrf_object.h:63
ObjectSpec::climate
uint8 climate
In which climates is this object available?
Definition: newgrf_object.h:66
OverflowSafeInt< int64, INT64_MAX, INT64_MIN >
OBJECT_FLAG_HAS_NO_FOUNDATION
Do not display foundations when on a slope.
Definition: newgrf_object.h:33
ResetObjects
void ResetObjects()
This function initialize the spec arrays of objects.
Definition: newgrf_object.cpp:96
ObjectClassID
ObjectClassID
Class IDs for objects.
Definition: newgrf_object.h:48