newgrf_object.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#ifndef NEWGRF_OBJECT_H
#define NEWGRF_OBJECT_H
 
#include "newgrf_callbacks.h"
#include "newgrf_spritegroup.h"
#include "newgrf_town.h"
#include "economy_func.h"
#include "timer/timer_game_calendar.h"
#include "object_type.h"
#include "newgrf_animation_type.h"
#include "newgrf_class.h"
#include "newgrf_commons.h"
 
enum ObjectFlags : uint16_t {
  OBJECT_FLAG_NONE               =       0, 
  OBJECT_FLAG_ONLY_IN_SCENEDIT   = 1 <<  0, 
  OBJECT_FLAG_CANNOT_REMOVE      = 1 <<  1, 
  OBJECT_FLAG_AUTOREMOVE         = 1 <<  2, 
  OBJECT_FLAG_BUILT_ON_WATER     = 1 <<  3, 
  OBJECT_FLAG_CLEAR_INCOME       = 1 <<  4, 
  OBJECT_FLAG_HAS_NO_FOUNDATION  = 1 <<  5, 
  OBJECT_FLAG_ANIMATION          = 1 <<  6, 
  OBJECT_FLAG_ONLY_IN_GAME       = 1 <<  7, 
  OBJECT_FLAG_2CC_COLOUR         = 1 <<  8, 
  OBJECT_FLAG_NOT_ON_LAND        = 1 <<  9, 
  OBJECT_FLAG_DRAW_WATER         = 1 << 10, 
  OBJECT_FLAG_ALLOW_UNDER_BRIDGE = 1 << 11, 
  OBJECT_FLAG_ANIM_RANDOM_BITS   = 1 << 12, 
  OBJECT_FLAG_SCALE_BY_WATER     = 1 << 13, 
};
DECLARE_ENUM_AS_BIT_SET(ObjectFlags)
 
static const uint8_t OBJECT_SIZE_1X1 = 0x11; 
 
void ResetObjects();
 
enum ObjectClassID : uint16_t {
  OBJECT_CLASS_BEGIN = 0, 
  OBJECT_CLASS_MAX = UINT16_MAX, 
  INVALID_OBJECT_CLASS = UINT16_MAX, 
};
DECLARE_POSTFIX_INCREMENT(ObjectClassID)
 
 
struct ObjectSpec : NewGRFSpecBase<ObjectClassID> {
  /* 2 because of the "normal" and "buy" sprite stacks. */
  GRFFilePropsBase<2> grf_prop; 
  AnimationInfo animation;      
  StringID name;                
 
  uint8_t climate;                
  uint8_t size;                   
  uint8_t build_cost_multiplier;  
  uint8_t clear_cost_multiplier;  
  TimerGameCalendar::Date introduction_date; 
  TimerGameCalendar::Date end_of_life_date;  
  ObjectFlags flags;            
  uint16_t callback_mask;         
  uint8_t height;                 
  uint8_t views;                  
  uint8_t generate_amount;        
 
  bool IsEnabled() const { return this->views > 0; }
 
  Money GetBuildCost() const { return GetPrice(PR_BUILD_OBJECT, this->build_cost_multiplier, this->grf_prop.grffile, 0); }
 
  Money GetClearCost() const { return GetPrice(PR_CLEAR_OBJECT, this->clear_cost_multiplier, this->grf_prop.grffile, 0); }
 
  bool IsEverAvailable() const;
  bool WasEverAvailable() const;
  bool IsAvailable() const;
  uint Index() const;
 
  static const std::vector<ObjectSpec> &Specs();
  static size_t Count();
  static const ObjectSpec *Get(ObjectType index);
  static const ObjectSpec *GetByTile(TileIndex tile);
 
  static void BindToClasses();
};
 
struct ObjectScopeResolver : public ScopeResolver {
  struct Object *obj;     
  const ObjectSpec *spec; 
  TileIndex tile;         
  uint8_t view;             
 
  ObjectScopeResolver(ResolverObject &ro, Object *obj, const ObjectSpec *spec, TileIndex tile, uint8_t view = 0)
    : ScopeResolver(ro), obj(obj), spec(spec), tile(tile), view(view)
  {
  }
 
  uint32_t GetRandomBits() const override;
  uint32_t GetVariable(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override;
};
 
struct ObjectResolverObject : public ResolverObject {
  ObjectScopeResolver object_scope; 
  std::optional<TownScopeResolver> town_scope = std::nullopt; 
 
  ObjectResolverObject(const ObjectSpec *spec, Object *o, TileIndex tile, uint8_t view = 0,
      CallbackID callback = CBID_NO_CALLBACK, uint32_t param1 = 0, uint32_t param2 = 0);
 
  ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, uint8_t relative = 0) override
  {
    switch (scope) {
      case VSG_SCOPE_SELF:
        return &this->object_scope;
 
      case VSG_SCOPE_PARENT: {
        TownScopeResolver *tsr = this->GetTown();
        if (tsr != nullptr) return tsr;
        [[fallthrough]];
      }
 
      default:
        return ResolverObject::GetScope(scope, relative);
    }
  }
 
  GrfSpecFeature GetFeature() const override;
  uint32_t GetDebugID() const override;
 
private:
  TownScopeResolver *GetTown();
};
 
using ObjectClass = NewGRFClass<ObjectSpec, ObjectClassID, OBJECT_CLASS_MAX>;
 
static const size_t OBJECT_SPRITE_GROUP_DEFAULT = 0;
static const size_t OBJECT_SPRITE_GROUP_PURCHASE = 1;
 
uint16_t GetObjectCallback(CallbackID callback, uint32_t param1, uint32_t param2, const ObjectSpec *spec, Object *o, TileIndex tile, uint8_t view = 0);
 
void DrawNewObjectTile(TileInfo *ti, const ObjectSpec *spec);
void DrawNewObjectTileInGUI(int x, int y, const ObjectSpec *spec, uint8_t view);
void AnimateNewObjectTile(TileIndex tile);
void TriggerObjectTileAnimation(Object *o, TileIndex tile, ObjectAnimationTrigger trigger, const ObjectSpec *spec);
void TriggerObjectAnimation(Object *o, ObjectAnimationTrigger trigger, const ObjectSpec *spec);
 
#endif /* NEWGRF_OBJECT_H */