OpenTTD Source: src/newgrf_object.h Source File

OpenTTD Source 15.3

newgrf_object.h
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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
10#ifndef NEWGRF_OBJECT_H
11#define NEWGRF_OBJECT_H
12
13#include "newgrf_callbacks.h"
14#include "newgrf_spritegroup.h"
15#include "newgrf_town.h"
16#include "economy_func.h"
17#include "timer/timer_game_calendar.h"
18#include "object_type.h"
19#include "newgrf_animation_type.h"
20#include "newgrf_badge_type.h"
21#include "newgrf_class.h"
22#include "newgrf_commons.h"
23
25 enum class ObjectFlag : uint8_t {
26 OnlyInScenedit = 0,
27 CannotRemove = 1,
28 Autoremove = 2,
29 BuiltOnWater = 3,
30 ClearIncome = 4,
31 HasNoFoundation = 5,
32 Animation = 6,
33 OnlyInGame = 7,
34 Uses2CC = 8,
35 NotOnLand = 9,
36 DrawWater = 10,
37 AllowUnderBridge = 11,
38 AnimRandomBits = 12,
39 ScaleByWater = 13,
40};
41using ObjectFlags = EnumBitSet<ObjectFlag, uint16_t>;
42
43 static const uint8_t OBJECT_SIZE_1X1 = 0x11;
44
45void ResetObjects();
46
48 enum ObjectClassID : uint16_t {
49 OBJECT_CLASS_BEGIN = 0,
50 OBJECT_CLASS_MAX = UINT16_MAX,
51 INVALID_OBJECT_CLASS = UINT16_MAX,
52};
54 DECLARE_INCREMENT_DECREMENT_OPERATORS(ObjectClassID)
55
56
60struct ObjectSpec : NewGRFSpecBase<ObjectClassID> {
61 StandardGRFFileProps grf_prop;
62 /* Animation speed default differs from other features */
63 AnimationInfo<ObjectAnimationTriggers> animation{0, AnimationStatus::NoAnimation, 0, {}};
64 StringID name;
65
66 LandscapeTypes climate;
67 uint8_t size;
68 uint8_t build_cost_multiplier;
69 uint8_t clear_cost_multiplier;
70 TimerGameCalendar::Date introduction_date;
71 TimerGameCalendar::Date end_of_life_date;
72 ObjectFlags flags;
73 ObjectCallbackMasks callback_mask;
74 uint8_t height;
75 uint8_t views;
76 uint8_t generate_amount;
77 std::vector<BadgeID> badges;
78
83 bool IsEnabled() const { return this->views > 0; }
84
89 Money GetBuildCost() const { return GetPrice(PR_BUILD_OBJECT, this->build_cost_multiplier, this->grf_prop.grffile, 0); }
90
95 Money GetClearCost() const { return GetPrice(PR_CLEAR_OBJECT, this->clear_cost_multiplier, this->grf_prop.grffile, 0); }
96
97 bool IsEverAvailable() const;
98 bool WasEverAvailable() const;
99 bool IsAvailable() const;
100 uint Index() const;
101
102 static const std::vector<ObjectSpec> &Specs();
103 static size_t Count();
104 static const ObjectSpec *Get(ObjectType index);
105 static const ObjectSpec *GetByTile(TileIndex tile);
106
107 static void BindToClasses();
108};
109
111 struct ObjectScopeResolver : public ScopeResolver {
112 struct Object *obj;
113 const ObjectSpec *spec;
114 TileIndex tile;
115 uint8_t view;
116
124 ObjectScopeResolver(ResolverObject &ro, Object *obj, const ObjectSpec *spec, TileIndex tile, uint8_t view = 0)
125 : ScopeResolver(ro), obj(obj), spec(spec), tile(tile), view(view)
126 {
127 }
128
129 uint32_t GetRandomBits() const override;
130 uint32_t GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override;
131};
132
134 struct ObjectResolverObject : public ResolverObject {
135 ObjectScopeResolver object_scope;
136 std::optional<TownScopeResolver> town_scope = std::nullopt;
137
138 ObjectResolverObject(const ObjectSpec *spec, Object *o, TileIndex tile, uint8_t view = 0,
139 CallbackID callback = CBID_NO_CALLBACK, uint32_t param1 = 0, uint32_t param2 = 0);
140
141 ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, uint8_t relative = 0) override
142 {
143 switch (scope) {
144 case VSG_SCOPE_SELF:
145 return &this->object_scope;
146
147 case VSG_SCOPE_PARENT: {
148 TownScopeResolver *tsr = this->GetTown();
149 if (tsr != nullptr) return tsr;
150 [[fallthrough]];
151 }
152
153 default:
154 return ResolverObject::GetScope(scope, relative);
155 }
156 }
157
158 GrfSpecFeature GetFeature() const override;
159 uint32_t GetDebugID() const override;
160
161private:
162 TownScopeResolver *GetTown();
163};
164
166 using ObjectClass = NewGRFClass<ObjectSpec, ObjectClassID, OBJECT_CLASS_MAX>;
167
168uint16_t GetObjectCallback(CallbackID callback, uint32_t param1, uint32_t param2, const ObjectSpec *spec, Object *o, TileIndex tile, std::span<int32_t> regs100 = {}, uint8_t view = 0);
169
170void DrawNewObjectTile(TileInfo *ti, const ObjectSpec *spec);
171void DrawNewObjectTileInGUI(int x, int y, const ObjectSpec *spec, uint8_t view);
172void AnimateNewObjectTile(TileIndex tile);
173bool TriggerObjectTileAnimation(Object *o, TileIndex tile, ObjectAnimationTrigger trigger, const ObjectSpec *spec);
174bool TriggerObjectAnimation(Object *o, ObjectAnimationTrigger trigger, const ObjectSpec *spec);
175
176#endif /* NEWGRF_OBJECT_H */
EnumBitSet< ObjectFlag, uint16_t >
NewGRFClass
Struct containing information relating to NewGRF classes for stations and airports.
Definition newgrf_class.h:26
OverflowSafeInt< int64_t >
GetPrice
Money GetPrice(Price index, uint cost_factor, const GRFFile *grf_file, int shift)
Determine a certain price.
Definition economy.cpp:949
economy_func.h
Functions related to the economy.
DECLARE_INCREMENT_DECREMENT_OPERATORS
#define DECLARE_INCREMENT_DECREMENT_OPERATORS(enum_type)
For some enums it is useful to have pre/post increment/decrement operators.
Definition enum_type.hpp:63
GrfSpecFeature
GrfSpecFeature
Definition newgrf.h:68
newgrf_animation_type.h
Definitions related to NewGRF animation.
AnimationStatus::NoAnimation
@ NoAnimation
There is no animation.
newgrf_badge_type.h
Types related to NewGRF badges.
newgrf_callbacks.h
Callbacks that NewGRFs could implement.
CallbackID
CallbackID
List of implemented NewGRF callbacks.
Definition newgrf_callbacks.h:22
CBID_NO_CALLBACK
@ CBID_NO_CALLBACK
Set when using the callback resolve system, but not to resolve a callback.
Definition newgrf_callbacks.h:24
newgrf_class.h
Header file for classes to be used by e.g.
newgrf_commons.h
This file simplifies and embeds a common mechanism of loading/saving and mapping of grf entities.
OBJECT_SIZE_1X1
static const uint8_t OBJECT_SIZE_1X1
The value of a NewGRF's size property when the object is 1x1 tiles: low nibble for X,...
Definition newgrf_object.h:43
ResetObjects
void ResetObjects()
This function initialize the spec arrays of objects.
Definition newgrf_object.cpp:125
DrawNewObjectTileInGUI
void DrawNewObjectTileInGUI(int x, int y, const ObjectSpec *spec, uint8_t view)
Draw representation of an object (tile) for GUI purposes.
Definition newgrf_object.cpp:492
GetObjectCallback
uint16_t GetObjectCallback(CallbackID callback, uint32_t param1, uint32_t param2, const ObjectSpec *spec, Object *o, TileIndex tile, std::span< int32_t > regs100={}, uint8_t view=0)
Perform a callback for an object.
Definition newgrf_object.cpp:435
ObjectFlag
ObjectFlag
Various object behaviours.
Definition newgrf_object.h:25
ObjectFlag::AnimRandomBits
@ AnimRandomBits
Object wants random bits in "next animation frame" callback.
ObjectFlag::Autoremove
@ Autoremove
Object get automatically removed (like "owned land").
ObjectFlag::CannotRemove
@ CannotRemove
Object can not be removed.
ObjectFlag::AllowUnderBridge
@ AllowUnderBridge
Object can built under a bridge.
ObjectFlag::OnlyInScenedit
@ OnlyInScenedit
Object can only be constructed in the scenario editor.
ObjectFlag::BuiltOnWater
@ BuiltOnWater
Object can be built on water (not required).
ObjectFlag::OnlyInGame
@ OnlyInGame
Object can only be built in game.
ObjectFlag::DrawWater
@ DrawWater
Object wants to be drawn on water.
ObjectFlag::HasNoFoundation
@ HasNoFoundation
Do not display foundations when on a slope.
ObjectFlag::Uses2CC
@ Uses2CC
Object wants 2CC colour mapping.
ObjectFlag::NotOnLand
@ NotOnLand
Object can not be on land, implicitly sets ObjectFlag::BuiltOnWater.
ObjectFlag::ScaleByWater
@ ScaleByWater
Object count is roughly scaled by water amount at edges.
ObjectFlag::Animation
@ Animation
Object has animated tiles.
ObjectFlag::ClearIncome
@ ClearIncome
When object is cleared a positive income is generated instead of a cost.
DrawNewObjectTile
void DrawNewObjectTile(TileInfo *ti, const ObjectSpec *spec)
Draw an object on the map.
Definition newgrf_object.cpp:472
TriggerObjectAnimation
bool TriggerObjectAnimation(Object *o, ObjectAnimationTrigger trigger, const ObjectSpec *spec)
Trigger the update of animation on a whole object.
Definition newgrf_object.cpp:587
TriggerObjectTileAnimation
bool TriggerObjectTileAnimation(Object *o, TileIndex tile, ObjectAnimationTrigger trigger, const ObjectSpec *spec)
Trigger the update of animation on a single tile.
Definition newgrf_object.cpp:576
ObjectClassID
ObjectClassID
Class IDs for objects.
Definition newgrf_object.h:48
INVALID_OBJECT_CLASS
@ INVALID_OBJECT_CLASS
Class for the less fortunate.
Definition newgrf_object.h:51
OBJECT_CLASS_BEGIN
@ OBJECT_CLASS_BEGIN
The lowest valid value.
Definition newgrf_object.h:49
OBJECT_CLASS_MAX
@ OBJECT_CLASS_MAX
Maximum number of classes.
Definition newgrf_object.h:50
AnimateNewObjectTile
void AnimateNewObjectTile(TileIndex tile)
Handle the animation of the object tile.
Definition newgrf_object.cpp:553
newgrf_spritegroup.h
Action 2 handling.
VarSpriteGroupScope
VarSpriteGroupScope
Definition newgrf_spritegroup.h:82
VSG_SCOPE_SELF
@ VSG_SCOPE_SELF
Resolved object itself.
Definition newgrf_spritegroup.h:85
VSG_SCOPE_PARENT
@ VSG_SCOPE_PARENT
Related object of the resolved one.
Definition newgrf_spritegroup.h:86
newgrf_town.h
Functions to handle the town part of NewGRF towns.
object_type.h
Types related to object tiles.
ObjectType
uint16_t ObjectType
Types of objects.
Definition object_type.h:16
ObjectAnimationTrigger
ObjectAnimationTrigger
Animation triggers for objects.
Definition object_type.h:36
CargoSortType::Count
@ Count
by amount of cargo
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:19
AnimationInfo
Information about animation.
Definition newgrf_animation_type.h:21
GRFFilePropsBase::grffile
const struct GRFFile * grffile
grf file that introduced this entity
Definition newgrf_commons.h:318
NewGRFSpecBase
Definition newgrf_class.h:17
ObjectResolverObject
A resolver object to be used with feature 0F spritegroups.
Definition newgrf_object.h:134
ObjectResolverObject::object_scope
ObjectScopeResolver object_scope
The object scope resolver.
Definition newgrf_object.h:135
ObjectResolverObject::town_scope
std::optional< TownScopeResolver > town_scope
The town scope resolver (created on the first call).
Definition newgrf_object.h:136
ObjectResolverObject::GetTown
TownScopeResolver * GetTown()
Get the town resolver scope that belongs to this object resolver.
Definition newgrf_object.cpp:398
ObjectResolverObject::GetFeature
GrfSpecFeature GetFeature() const override
Get the feature number being resolved for.
Definition newgrf_object.cpp:413
ObjectResolverObject::GetScope
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0) override
Get a resolver for the scope.
Definition newgrf_object.h:141
ObjectResolverObject::GetDebugID
uint32_t GetDebugID() const override
Get an identifier for the item being resolved.
Definition newgrf_object.cpp:418
ObjectScopeResolver
Object scope resolver.
Definition newgrf_object.h:111
ObjectScopeResolver::GetVariable
uint32_t GetVariable(uint8_t variable, uint32_t parameter, bool &available) const override
Used by the resolver to get values for feature 0F deterministic spritegroups.
Definition newgrf_object.cpp:262
ObjectScopeResolver::tile
TileIndex tile
The tile related to the object.
Definition newgrf_object.h:114
ObjectScopeResolver::view
uint8_t view
The view of the object.
Definition newgrf_object.h:115
ObjectScopeResolver::GetRandomBits
uint32_t GetRandomBits() const override
Get a few random bits.
Definition newgrf_object.cpp:159
ObjectScopeResolver::spec
const ObjectSpec * spec
Specification of the object type.
Definition newgrf_object.h:113
ObjectScopeResolver::ObjectScopeResolver
ObjectScopeResolver(ResolverObject &ro, Object *obj, const ObjectSpec *spec, TileIndex tile, uint8_t view=0)
Constructor of an object scope resolver.
Definition newgrf_object.h:124
ObjectScopeResolver::obj
struct Object * obj
The object the callback is ran for.
Definition newgrf_object.h:112
ObjectSpec
Allow incrementing of ObjectClassID variables.
Definition newgrf_object.h:60
ObjectSpec::IsEnabled
bool IsEnabled() const
Test if this object is enabled.
Definition newgrf_object.h:83
ObjectSpec::introduction_date
TimerGameCalendar::Date introduction_date
From when can this object be built.
Definition newgrf_object.h:70
ObjectSpec::grf_prop
StandardGRFFileProps grf_prop
Properties related the the grf file.
Definition newgrf_object.h:61
ObjectSpec::climate
LandscapeTypes climate
In which climates is this object available?
Definition newgrf_object.h:66
ObjectSpec::name
StringID name
The name for this object.
Definition newgrf_object.h:64
ObjectSpec::GetClearCost
Money GetClearCost() const
Get the cost for clearing a structure of this type.
Definition newgrf_object.h:95
ObjectSpec::size
uint8_t size
The size of this objects; low nibble for X, high nibble for Y.
Definition newgrf_object.h:67
ObjectSpec::generate_amount
uint8_t generate_amount
Number of objects which are attempted to be generated per 256^2 map during world generation.
Definition newgrf_object.h:76
ObjectSpec::callback_mask
ObjectCallbackMasks callback_mask
Bitmask of requested/allowed callbacks.
Definition newgrf_object.h:73
ObjectSpec::flags
ObjectFlags flags
Flags/settings related to the object.
Definition newgrf_object.h:72
ObjectSpec::height
uint8_t height
The height of this structure, in heightlevels; max MAX_TILE_HEIGHT.
Definition newgrf_object.h:74
ObjectSpec::clear_cost_multiplier
uint8_t clear_cost_multiplier
Clear cost multiplier per tile.
Definition newgrf_object.h:69
ObjectSpec::GetBuildCost
Money GetBuildCost() const
Get the cost for building a structure of this type.
Definition newgrf_object.h:89
ObjectSpec::views
uint8_t views
The number of views.
Definition newgrf_object.h:75
ObjectSpec::end_of_life_date
TimerGameCalendar::Date end_of_life_date
When can't this object be built anymore.
Definition newgrf_object.h:71
ObjectSpec::build_cost_multiplier
uint8_t build_cost_multiplier
Build cost multiplier per tile.
Definition newgrf_object.h:68
Object
An object, such as transmitter, on the map.
Definition object_base.h:23
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition newgrf_spritegroup.h:288
ResolverObject::callback
CallbackID callback
Callback being resolved.
Definition newgrf_spritegroup.h:340
ResolverObject::GetScope
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0)
Get a resolver for the scope.
Definition newgrf_spritegroup.cpp:133
ScopeResolver
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope).
Definition newgrf_spritegroup.h:269
ScopeResolver::ro
ResolverObject & ro
Surrounding resolver object.
Definition newgrf_spritegroup.h:270
StandardGRFFileProps
Container for standard sprite groups.
Definition newgrf_commons.h:379
StrongType::Typedef
Templated helper to make a type-safe 'typedef' representing a single POD value.
Definition strong_typedef_type.hpp:130
TileInfo
Tile information, used while rendering the tile.
Definition tile_cmd.h:30
TownScopeResolver
Scope resolver for a town.
Definition newgrf_town.h:22
timer_game_calendar.h
Definition of the game-calendar-timer.