src/newgrf_object.h

   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
   8 /** @file newgrf_object.h Functions related to NewGRF objects. */
   9
  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_class.h"
  21 #include "newgrf_commons.h"
  22
  23 /** Various object behaviours. */
  24 enum ObjectFlags : uint16_t {
  25         OBJECT_FLAG_NONE               =       0, ///< Just nothing.
  26         OBJECT_FLAG_ONLY_IN_SCENEDIT   = 1 <<  0, ///< Object can only be constructed in the scenario editor.
  27         OBJECT_FLAG_CANNOT_REMOVE      = 1 <<  1, ///< Object can not be removed.
  28         OBJECT_FLAG_AUTOREMOVE         = 1 <<  2, ///< Object get automatically removed (like "owned land").
  29         OBJECT_FLAG_BUILT_ON_WATER     = 1 <<  3, ///< Object can be built on water (not required).
  30         OBJECT_FLAG_CLEAR_INCOME       = 1 <<  4, ///< When object is cleared a positive income is generated instead of a cost.
  31         OBJECT_FLAG_HAS_NO_FOUNDATION  = 1 <<  5, ///< Do not display foundations when on a slope.
  32         OBJECT_FLAG_ANIMATION          = 1 <<  6, ///< Object has animated tiles.
  33         OBJECT_FLAG_ONLY_IN_GAME       = 1 <<  7, ///< Object can only be built in game.
  34         OBJECT_FLAG_2CC_COLOUR         = 1 <<  8, ///< Object wants 2CC colour mapping.
  35         OBJECT_FLAG_NOT_ON_LAND        = 1 <<  9, ///< Object can not be on land, implicitly sets #OBJECT_FLAG_BUILT_ON_WATER.
  36         OBJECT_FLAG_DRAW_WATER         = 1 << 10, ///< Object wants to be drawn on water.
  37         OBJECT_FLAG_ALLOW_UNDER_BRIDGE = 1 << 11, ///< Object can built under a bridge.
  38         OBJECT_FLAG_ANIM_RANDOM_BITS   = 1 << 12, ///< Object wants random bits in "next animation frame" callback.
  39         OBJECT_FLAG_SCALE_BY_WATER     = 1 << 13, ///< Object count is roughly scaled by water amount at edges.
  40 };
  41 DECLARE_ENUM_AS_BIT_SET(ObjectFlags)
  42
  43 static const uint8_t OBJECT_SIZE_1X1 = 0x11; ///< The value of a NewGRF's size property when the object is 1x1 tiles: low nibble for X, high nibble for Y.
  44
  45 void ResetObjects();
  46
  47 /** Class IDs for objects. */
  48 enum ObjectClassID : uint16_t {
  49         OBJECT_CLASS_BEGIN = 0, ///< The lowest valid value
  50         OBJECT_CLASS_MAX = UINT16_MAX, ///< Maximum number of classes.
  51         INVALID_OBJECT_CLASS = UINT16_MAX, ///< Class for the less fortunate.
  52 };
  53 /** Allow incrementing of ObjectClassID variables */
  54 DECLARE_POSTFIX_INCREMENT(ObjectClassID)
  55
  56 /** An object that isn't use for transport, industries or houses.
  57  * @note If you change this struct, adopt the initialization of
  58  * default objects in table/object_land.h
  59  */
  60 struct ObjectSpec : NewGRFSpecBase<ObjectClassID> {
  61         /* 2 because of the "normal" and "buy" sprite stacks. */
  62         GRFFilePropsBase<2> grf_prop; ///< Properties related the the grf file
  63         AnimationInfo animation;      ///< Information about the animation.
  64         StringID name;                ///< The name for this object.
  65
  66         uint8_t climate;                ///< In which climates is this object available?
  67         uint8_t size;                   ///< The size of this objects; low nibble for X, high nibble for Y.
  68         uint8_t build_cost_multiplier;  ///< Build cost multiplier per tile.
  69         uint8_t clear_cost_multiplier;  ///< Clear cost multiplier per tile.
  70         TimerGameCalendar::Date introduction_date; ///< From when can this object be built.
  71         TimerGameCalendar::Date end_of_life_date;  ///< When can't this object be built anymore.
  72         ObjectFlags flags;            ///< Flags/settings related to the object.
  73         uint16_t callback_mask;         ///< Bitmask of requested/allowed callbacks.
  74         uint8_t height;                 ///< The height of this structure, in heightlevels; max MAX_TILE_HEIGHT.
  75         uint8_t views;                  ///< The number of views.
  76         uint8_t generate_amount;        ///< Number of objects which are attempted to be generated per 256^2 map during world generation.
  77
  78         /**
  79          * Test if this object is enabled.
  80          * @return True iff this object is enabled.
  81          */
  82         bool IsEnabled() const { return this->views > 0; }
  83
  84         /**
  85          * Get the cost for building a structure of this type.
  86          * @return The cost for building.
  87          */
  88         Money GetBuildCost() const { return GetPrice(PR_BUILD_OBJECT, this->build_cost_multiplier, this->grf_prop.grffile, 0); }
  89
  90         /**
  91          * Get the cost for clearing a structure of this type.
  92          * @return The cost for clearing.
  93          */
  94         Money GetClearCost() const { return GetPrice(PR_CLEAR_OBJECT, this->clear_cost_multiplier, this->grf_prop.grffile, 0); }
  95
  96         bool IsEverAvailable() const;
  97         bool WasEverAvailable() const;
  98         bool IsAvailable() const;
  99         uint Index() const;
 100
 101         static const std::vector<ObjectSpec> &Specs();
 102         static size_t Count();
 103         static const ObjectSpec *Get(ObjectType index);
 104         static const ObjectSpec *GetByTile(TileIndex tile);
 105
 106         static void BindToClasses();
 107 };
 108
 109 /** Object scope resolver. */
 110 struct ObjectScopeResolver : public ScopeResolver {
 111         struct Object *obj;     ///< The object the callback is ran for.
 112         const ObjectSpec *spec; ///< Specification of the object type.
 113         TileIndex tile;         ///< The tile related to the object.
 114         uint8_t view;             ///< The view of the object.
 115
 116         /**
 117          * Constructor of an object scope resolver.
 118          * @param ro Surrounding resolver.
 119          * @param obj Object being resolved.
 120          * @param tile %Tile of the object.
 121          * @param view View of the object.
 122          */
 123         ObjectScopeResolver(ResolverObject &ro, Object *obj, const ObjectSpec *spec, TileIndex tile, uint8_t view = 0)
 124                 : ScopeResolver(ro), obj(obj), spec(spec), tile(tile), view(view)
 125         {
 126         }
 127
 128         uint32_t GetRandomBits() const override;
 129         uint32_t GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override;
 130 };
 131
 132 /** A resolver object to be used with feature 0F spritegroups. */
 133 struct ObjectResolverObject : public ResolverObject {
 134         ObjectScopeResolver object_scope; ///< The object scope resolver.
 135         std::optional<TownScopeResolver> town_scope = std::nullopt; ///< The town scope resolver (created on the first call).
 136
 137         ObjectResolverObject(const ObjectSpec *spec, Object *o, TileIndex tile, uint8_t view = 0,
 138                         CallbackID callback = CBID_NO_CALLBACK, uint32_t param1 = 0, uint32_t param2 = 0);
 139
 140         ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, uint8_t relative = 0) override
 141         {
 142                 switch (scope) {
 143                         case VSG_SCOPE_SELF:
 144                                 return &this->object_scope;
 145
 146                         case VSG_SCOPE_PARENT: {
 147                                 TownScopeResolver *tsr = this->GetTown();
 148                                 if (tsr != nullptr) return tsr;
 149                                 [[fallthrough]];
 150                         }
 151
 152                         default:
 153                                 return ResolverObject::GetScope(scope, relative);
 154                 }
 155         }
 156
 157         GrfSpecFeature GetFeature() const override;
 158         uint32_t GetDebugID() const override;
 159
 160 private:
 161         TownScopeResolver *GetTown();
 162 };
 163
 164 /** Class containing information relating to object classes. */
 165 using ObjectClass = NewGRFClass<ObjectSpec, ObjectClassID, OBJECT_CLASS_MAX>;
 166
 167 static const size_t OBJECT_SPRITE_GROUP_DEFAULT = 0;
 168 static const size_t OBJECT_SPRITE_GROUP_PURCHASE = 1;
 169
 170 uint16_t GetObjectCallback(CallbackID callback, uint32_t param1, uint32_t param2, const ObjectSpec *spec, Object *o, TileIndex tile, uint8_t view = 0);
 171
 172 void DrawNewObjectTile(TileInfo *ti, const ObjectSpec *spec);
 173 void DrawNewObjectTileInGUI(int x, int y, const ObjectSpec *spec, uint8_t view);
 174 void AnimateNewObjectTile(TileIndex tile);
 175 void TriggerObjectTileAnimation(Object *o, TileIndex tile, ObjectAnimationTrigger trigger, const ObjectSpec *spec);
 176 void TriggerObjectAnimation(Object *o, ObjectAnimationTrigger trigger, const ObjectSpec *spec);
 177
 178 #endif /* NEWGRF_OBJECT_H */