OpenTTD
newgrf_object.h
Go to the documentation of this file.
1 /* $Id: newgrf_object.h 26085 2013-11-24 14:41:19Z 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 
42 };
44 
45 void ResetObjects();
46 
52 };
55 
56 
60 struct ObjectSpec {
61  /* 2 because of the "normal" and "buy" sprite stacks. */
65 
66  uint8 climate;
67  uint8 size;
74  uint16 callback_mask;
75  uint8 height;
76  uint8 views;
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 
103  struct Object *obj;
105  uint8 view;
106 
108 
109  /* virtual */ uint32 GetRandomBits() const;
110  /* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
111 };
112 
117 
118  ObjectResolverObject(const ObjectSpec *spec, Object *o, TileIndex tile, uint8 view = 0,
119  CallbackID callback = CBID_NO_CALLBACK, uint32 param1 = 0, uint32 param2 = 0);
121 
122  /* virtual */ ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0)
123  {
124  switch (scope) {
125  case VSG_SCOPE_SELF:
126  return &this->object_scope;
127 
128  case VSG_SCOPE_PARENT: {
129  TownScopeResolver *tsr = this->GetTown();
130  if (tsr != NULL) return tsr;
131  /* FALL-THROUGH */
132  }
133 
134  default: return ResolverObject::GetScope(scope, relative);
135  }
136  }
137 
138 private:
140 };
141 
144 
146 static const CargoID CT_PURCHASE_OBJECT = 1;
147 
148 uint16 GetObjectCallback(CallbackID callback, uint32 param1, uint32 param2, const ObjectSpec *spec, Object *o, TileIndex tile, uint8 view = 0);
149 
150 void DrawNewObjectTile(TileInfo *ti, const ObjectSpec *spec);
151 void DrawNewObjectTileInGUI(int x, int y, const ObjectSpec *spec, uint8 view);
154 void TriggerObjectAnimation(Object *o, ObjectAnimationTrigger trigger, const ObjectSpec *spec);
155 
156 #endif /* NEWGRF_OBJECT_H */