OpenTTD

newgrf_object.cpp
Go to the documentation of this file.
1 /* $Id: newgrf_object.cpp 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 #include "stdafx.h"
13 #include "company_base.h"
14 #include "company_func.h"
15 #include "debug.h"
16 #include "genworld.h"
17 #include "newgrf_class_func.h"
18 #include "newgrf_object.h"
19 #include "newgrf_sound.h"
20 #include "object_base.h"
21 #include "object_map.h"
22 #include "tile_cmd.h"
23 #include "town.h"
24 #include "water.h"
25 #include "newgrf_animation_base.h"
26
27 #include "safeguards.h"
28
30 ObjectOverrideManager _object_mngr(NEW_OBJECT_OFFSET, NUM_OBJECTS, INVALID_OBJECT_TYPE);
31
32 extern const ObjectSpec _original_objects[NEW_OBJECT_OFFSET];
34 ObjectSpec _object_specs[NUM_OBJECTS];
35
41 /* static */ const ObjectSpec *ObjectSpec::Get(ObjectType index)
42 {
43 assert(index < NUM_OBJECTS);
44 return &_object_specs[index];
45 }
46
52 /* static */ const ObjectSpec *ObjectSpec::GetByTile(TileIndex tile)
53 {
54 return ObjectSpec::Get(GetObjectType(tile));
55 }
56
61 bool ObjectSpec::IsEverAvailable() const
62 {
63 return this->enabled && HasBit(this->climate, _settings_game.game_creation.landscape) &&
64 (this->flags & ((_game_mode != GM_EDITOR && !_generating_world) ? OBJECT_FLAG_ONLY_IN_SCENEDIT : OBJECT_FLAG_ONLY_IN_GAME)) == 0;
65 }
66
71 bool ObjectSpec::WasEverAvailable() const
72 {
73 return this->IsEverAvailable() && _date > this->introduction_date;
74 }
75
80 bool ObjectSpec::IsAvailable() const
81 {
82 return this->WasEverAvailable() &&
83 (_date < this->end_of_life_date || this->end_of_life_date < this->introduction_date + 365);
84 }
85
90 uint ObjectSpec::Index() const
91 {
92 return this - _object_specs;
93 }
94
96 void ResetObjects()
97 {
98 /* Clean the pool. */
99 MemSetT(_object_specs, 0, lengthof(_object_specs));
100
101 /* And add our originals. */
102 MemCpyT(_object_specs, _original_objects, lengthof(_original_objects));
103
104 for (uint16 i = 0; i < lengthof(_original_objects); i++) {
105 _object_specs[i].grf_prop.local_id = i;
106 }
107 }
108
109 template <typename Tspec, typename Tid, Tid Tmax>
110 /* static */ void NewGRFClass<Tspec, Tid, Tmax>::InsertDefaults()
111 {
112 ObjectClassID cls = ObjectClass::Allocate('LTHS');
113 ObjectClass::Get(cls)->name = STR_OBJECT_CLASS_LTHS;
114 _object_specs[OBJECT_LIGHTHOUSE].cls_id = cls;
115 ObjectClass::Assign(&_object_specs[OBJECT_LIGHTHOUSE]);
116
117 cls = ObjectClass::Allocate('TRNS');
118 ObjectClass::Get(cls)->name = STR_OBJECT_CLASS_TRNS;
119 _object_specs[OBJECT_TRANSMITTER].cls_id = cls;
120 ObjectClass::Assign(&_object_specs[OBJECT_TRANSMITTER]);
121 }
122
123 template <typename Tspec, typename Tid, Tid Tmax>
124 bool NewGRFClass<Tspec, Tid, Tmax>::IsUIAvailable(uint index) const
125 {
126 return this->GetSpec(index)->IsEverAvailable();
127 }
128
129 INSTANTIATE_NEWGRF_CLASS_METHODS(ObjectClass, ObjectSpec, ObjectClassID, OBJECT_CLASS_MAX)
130
131 /* virtual */ uint32 ObjectScopeResolver::GetRandomBits() const
132 {
133 return IsValidTile(this->tile) && IsTileType(this->tile, MP_OBJECT) ? GetObjectRandomBits(this->tile) : 0;
134 }
135
142 static uint32 GetObjectIDAtOffset(TileIndex tile, uint32 cur_grfid)
143 {
144 if (!IsTileType(tile, MP_OBJECT)) {
145 return 0xFFFF;
146 }
147
148 const Object *o = Object::GetByTile(tile);
149 const ObjectSpec *spec = ObjectSpec::Get(o->type);
150
151 /* Default objects have no associated NewGRF file */
152 if (spec->grf_prop.grffile == NULL) {
153 return 0xFFFE; // Defined in another grf file
154 }
155
156 if (spec->grf_prop.grffile->grfid == cur_grfid) { // same object, same grf ?
157 return spec->grf_prop.local_id | o->view << 16;
158 }
159
160 return 0xFFFE; // Defined in another grf file
161 }
162
171 static uint32 GetNearbyObjectTileInformation(byte parameter, TileIndex tile, ObjectID index, bool grf_version8)
172 {
173 if (parameter != 0) tile = GetNearbyTile(parameter, tile); // only perform if it is required
174 bool is_same_object = (IsTileType(tile, MP_OBJECT) && GetObjectIndex(tile) == index);
175
176 return GetNearbyTileInformation(tile, grf_version8) | (is_same_object ? 1 : 0) << 8;
177 }
178
186 static uint32 GetClosestObject(TileIndex tile, ObjectType type, const Object *current)
187 {
188 uint32 best_dist = UINT32_MAX;
189 const Object *o;
190 FOR_ALL_OBJECTS(o) {
191 if (o->type != type || o == current) continue;
192
193 best_dist = min(best_dist, DistanceManhattan(tile, o->location.tile));
194 }
195
196 return best_dist;
197 }
198
207 static uint32 GetCountAndDistanceOfClosestInstance(byte local_id, uint32 grfid, TileIndex tile, const Object *current)
208 {
209 uint32 grf_id = GetRegister(0x100); // Get the GRFID of the definition to look for in register 100h
210 uint32 idx;
211
212 /* Determine what will be the object type to look for */
213 switch (grf_id) {
214 case 0: // this is a default object type
215 idx = local_id;
216 break;
217
218 case 0xFFFFFFFF: // current grf
219 grf_id = grfid;
220 FALLTHROUGH;
221
222 default: // use the grfid specified in register 100h
223 idx = _object_mngr.GetID(local_id, grf_id);
224 break;
225 }
226
227 /* If the object type is invalid, there is none and the closest is far away. */
228 if (idx >= NUM_OBJECTS) return 0 | 0xFFFF;
229
230 return Object::GetTypeCount(idx) << 16 | min(GetClosestObject(tile, idx, current), 0xFFFF);
231 }
232
234 /* virtual */ uint32 ObjectScopeResolver::GetVariable(byte variable, uint32 parameter, bool *available) const
235 {
236 /* We get the town from the object, or we calculate the closest
237 * town if we need to when there's no object. */
238 const Town *t = NULL;
239
240 if (this->obj == NULL) {
241 switch (variable) {
242 /* Allow these when there's no object. */
243 case 0x41:
244 case 0x60:
245 case 0x61:
246 case 0x62:
247 case 0x64:
248 break;
249
250 /* Allow these, but find the closest town. */
251 case 0x45:
252 case 0x46:
253 if (!IsValidTile(this->tile)) goto unhandled;
254 t = ClosestTownFromTile(this->tile, UINT_MAX);
255 break;
256
257 /* Construction date */
258 case 0x42: return _date;
259
260 /* Object founder information */
261 case 0x44: return _current_company;
262
263 /* Object view */
264 case 0x48: return this->view;
265
266 /*
267 * Disallow the rest:
268 * 0x40: Relative position is passed as parameter during construction.
269 * 0x43: Animation counter is only for actual tiles.
270 * 0x47: Object colour is only valid when its built.
271 * 0x63: Animation counter of nearby tile, see above.
272 */
273 default:
274 goto unhandled;
275 }
276
277 /* If there's an invalid tile, then we don't have enough information at all. */
278 if (!IsValidTile(this->tile)) goto unhandled;
279 } else {
280 t = this->obj->town;
281 }
282
283 switch (variable) {
284 /* Relative position. */
285 case 0x40: {
286 uint offset = this->tile - this->obj->location.tile;
287 uint offset_x = TileX(offset);
288 uint offset_y = TileY(offset);
289 return offset_y << 20 | offset_x << 16 | offset_y << 8 | offset_x;
290 }
291
292 /* Tile information. */
293 case 0x41: return GetTileSlope(this->tile) << 8 | GetTerrainType(this->tile);
294
295 /* Construction date */
296 case 0x42: return this->obj->build_date;
297
298 /* Animation counter */
299 case 0x43: return GetAnimationFrame(this->tile);
300
301 /* Object founder information */
302 case 0x44: return GetTileOwner(this->tile);
303
304 /* Get town zone and Manhattan distance of closest town */
305 case 0x45: return GetTownRadiusGroup(t, this->tile) << 16 | min(DistanceManhattan(this->tile, t->xy), 0xFFFF);
306
307 /* Get square of Euclidian distance of closes town */
308 case 0x46: return GetTownRadiusGroup(t, this->tile) << 16 | min(DistanceSquare(this->tile, t->xy), 0xFFFF);
309
310 /* Object colour */
311 case 0x47: return this->obj->colour;
312
313 /* Object view */
314 case 0x48: return this->obj->view;
315
316 /* Get object ID at offset param */
317 case 0x60: return GetObjectIDAtOffset(GetNearbyTile(parameter, this->tile), this->ro.grffile->grfid);
318
319 /* Get random tile bits at offset param */
320 case 0x61: {
321 TileIndex tile = GetNearbyTile(parameter, this->tile);
322 return (IsTileType(tile, MP_OBJECT) && Object::GetByTile(tile) == this->obj) ? GetObjectRandomBits(tile) : 0;
323 }
324
325 /* Land info of nearby tiles */
326 case 0x62: return GetNearbyObjectTileInformation(parameter, this->tile, this->obj == NULL ? INVALID_OBJECT : this->obj->index, this->ro.grffile->grf_version >= 8);
327
328 /* Animation counter of nearby tile */
329 case 0x63: {
330 TileIndex tile = GetNearbyTile(parameter, this->tile);
331 return (IsTileType(tile, MP_OBJECT) && Object::GetByTile(tile) == this->obj) ? GetAnimationFrame(tile) : 0;
332 }
333
334 /* Count of object, distance of closest instance */
335 case 0x64: return GetCountAndDistanceOfClosestInstance(parameter, this->ro.grffile->grfid, this->tile, this->obj);
336 }
337
338 unhandled:
339 DEBUG(grf, 1, "Unhandled object variable 0x%X", variable);
340
341 *available = false;
342 return UINT_MAX;
343 }
344
354 ObjectResolverObject::ObjectResolverObject(const ObjectSpec *spec, Object *obj, TileIndex tile, uint8 view,
355 CallbackID callback, uint32 param1, uint32 param2)
356 : ResolverObject(spec->grf_prop.grffile, callback, param1, param2), object_scope(*this, obj, tile, view)
357 {
358 this->town_scope = NULL;
359 this->root_spritegroup = (obj == NULL && spec->grf_prop.spritegroup[CT_PURCHASE_OBJECT] != NULL) ?
360 spec->grf_prop.spritegroup[CT_PURCHASE_OBJECT] : spec->grf_prop.spritegroup[0];
361 }
362
363 ObjectResolverObject::~ObjectResolverObject()
364 {
365 delete this->town_scope;
366 }
367
373 TownScopeResolver *ObjectResolverObject::GetTown()
374 {
375 if (this->town_scope == NULL) {
376 Town *t;
377 if (this->object_scope.obj != NULL) {
378 t = this->object_scope.obj->town;
379 } else {
380 t = ClosestTownFromTile(this->object_scope.tile, UINT_MAX);
381 }
382 if (t == NULL) return NULL;
383 this->town_scope = new TownScopeResolver(*this, t, this->object_scope.obj == NULL);
384 }
385 return this->town_scope;
386 }
387
399 uint16 GetObjectCallback(CallbackID callback, uint32 param1, uint32 param2, const ObjectSpec *spec, Object *o, TileIndex tile, uint8 view)
400 {
401 ObjectResolverObject object(spec, o, tile, view, callback, param1, param2);
402 return object.ResolveCallback();
403 }
404
411 static void DrawTileLayout(const TileInfo *ti, const TileLayoutSpriteGroup *group, const ObjectSpec *spec)
412 {
413 const DrawTileSprites *dts = group->ProcessRegisters(NULL);
414 PaletteID palette = ((spec->flags & OBJECT_FLAG_2CC_COLOUR) ? SPR_2CCMAP_BASE : PALETTE_RECOLOUR_START) + Object::GetByTile(ti->tile)->colour;
415
416 SpriteID image = dts->ground.sprite;
417 PaletteID pal = dts->ground.pal;
418
419 if (GB(image, 0, SPRITE_WIDTH) != 0) {
420 /* If the ground sprite is the default flat water sprite, draw also canal/river borders
421 * Do not do this if the tile's WaterClass is 'land'. */
422 if ((image == SPR_FLAT_WATER_TILE || spec->flags & OBJECT_FLAG_DRAW_WATER) && IsTileOnWater(ti->tile)) {
423 DrawWaterClassGround(ti);
424 } else {
425 DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, palette));
426 }
427 }
428
429 DrawNewGRFTileSeq(ti, dts, TO_STRUCTURES, 0, palette);
430 }
431
437 void DrawNewObjectTile(TileInfo *ti, const ObjectSpec *spec)
438 {
439 Object *o = Object::GetByTile(ti->tile);
440 ObjectResolverObject object(spec, o, ti->tile);
441
442 const SpriteGroup *group = object.Resolve();
443 if (group == NULL || group->type != SGT_TILELAYOUT) return;
444
445 DrawTileLayout(ti, (const TileLayoutSpriteGroup *)group, spec);
446 }
447
455 void DrawNewObjectTileInGUI(int x, int y, const ObjectSpec *spec, uint8 view)
456 {
457 ObjectResolverObject object(spec, NULL, INVALID_TILE, view);
458 const SpriteGroup *group = object.Resolve();
459 if (group == NULL || group->type != SGT_TILELAYOUT) return;
460
461 const DrawTileSprites *dts = ((const TileLayoutSpriteGroup *)group)->ProcessRegisters(NULL);
462
463 PaletteID palette;
464 if (Company::IsValidID(_local_company)) {
465 /* Get the colours of our company! */
466 if (spec->flags & OBJECT_FLAG_2CC_COLOUR) {
467 const Livery *l = Company::Get(_local_company)->livery;
468 palette = SPR_2CCMAP_BASE + l->colour1 + l->colour2 * 16;
469 } else {
470 palette = COMPANY_SPRITE_COLOUR(_local_company);
471 }
472 } else {
473 /* There's no company, so just take the base palette. */
474 palette = (spec->flags & OBJECT_FLAG_2CC_COLOUR) ? SPR_2CCMAP_BASE : PALETTE_RECOLOUR_START;
475 }
476
477 SpriteID image = dts->ground.sprite;
478 PaletteID pal = dts->ground.pal;
479
480 if (GB(image, 0, SPRITE_WIDTH) != 0) {
481 DrawSprite(image, GroundSpritePaletteTransform(image, pal, palette), x, y);
482 }
483
484 DrawNewGRFTileSeqInGUI(x, y, dts, 0, palette);
485 }
486
498 uint16 StubGetObjectCallback(CallbackID callback, uint32 param1, uint32 param2, const ObjectSpec *spec, Object *o, TileIndex tile, int extra_data)
499 {
500 return GetObjectCallback(callback, param1, param2, spec, o, tile);
501 }
502
504 struct ObjectAnimationBase : public AnimationBase<ObjectAnimationBase, ObjectSpec, Object, int, StubGetObjectCallback> {
505 static const CallbackID cb_animation_speed = CBID_OBJECT_ANIMATION_SPEED;
506 static const CallbackID cb_animation_next_frame = CBID_OBJECT_ANIMATION_NEXT_FRAME;
507
508 static const ObjectCallbackMask cbm_animation_speed = CBM_OBJ_ANIMATION_SPEED;
509 static const ObjectCallbackMask cbm_animation_next_frame = CBM_OBJ_ANIMATION_NEXT_FRAME;
510 };
511
516 void AnimateNewObjectTile(TileIndex tile)
517 {
518 const ObjectSpec *spec = ObjectSpec::GetByTile(tile);
519 if (spec == NULL || !(spec->flags & OBJECT_FLAG_ANIMATION)) return;
520
521 ObjectAnimationBase::AnimateTile(spec, Object::GetByTile(tile), tile, (spec->flags & OBJECT_FLAG_ANIM_RANDOM_BITS) != 0);
522 }
523
531 void TriggerObjectTileAnimation(Object *o, TileIndex tile, ObjectAnimationTrigger trigger, const ObjectSpec *spec)
532 {
533 if (!HasBit(spec->animation.triggers, trigger)) return;
534
535 ObjectAnimationBase::ChangeAnimationFrame(CBID_OBJECT_ANIMATION_START_STOP, spec, o, tile, Random(), trigger);
536 }
537
544 void TriggerObjectAnimation(Object *o, ObjectAnimationTrigger trigger, const ObjectSpec *spec)
545 {
546 if (!HasBit(spec->animation.triggers, trigger)) return;
547
548 TILE_AREA_LOOP(tile, o->location) {
549 TriggerObjectTileAnimation(o, tile, trigger, spec);
550 }
551 }
newgrf_class_func.h
Implementation of the NewGRF class&#39; functions.
PaletteID
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:20
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:77
company_base.h
Definition of stuff that is very close to a company, like the company struct itself.
ObjectOverrideManager
Definition: newgrf_commons.h:279
OBJECT_CLASS_MAX
Maximum number of classes.
Definition: newgrf_object.h:50
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
DrawNewObjectTile
void DrawNewObjectTile(TileInfo *ti, const ObjectSpec *spec)
Draw an object on the map.
Definition: newgrf_object.cpp:437
NUM_OBJECTS
static const ObjectType NUM_OBJECTS
Number of supported objects overall.
Definition: object_type.h:27
TileInfo
Tile information, used while rendering the tile.
Definition: tile_cmd.h:44
OBJECT_TRANSMITTER
static const ObjectType OBJECT_TRANSMITTER
The large antenna.
Definition: object_type.h:18
ObjectSpec::IsAvailable
bool IsAvailable() const
Check whether the object is available at this time.
Definition: newgrf_object.cpp:80
GameCreationSettings::landscape
byte landscape
the landscape we&#39;re currently in
Definition: settings_type.h:288
CBM_OBJ_ANIMATION_NEXT_FRAME
decides next animation frame
Definition: newgrf_callbacks.h:385
AnimationInfo::triggers
uint16 triggers
The triggers that trigger animation.
Definition: newgrf_animation_type.h:24
CBM_OBJ_ANIMATION_SPEED
decides animation speed
Definition: newgrf_callbacks.h:386
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
Pool::PoolItem<&_company_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:246
Object::town
Town * town
Town the object is built in.
Definition: object_base.h:27
GetAnimationFrame
static byte GetAnimationFrame(TileIndex t)
Get the current animation frame.
Definition: tile_map.h:243
debug.h
Functions related to debugging.
DrawNewGRFTileSeq
static void DrawNewGRFTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, uint32 stage, PaletteID default_palette)
Draw NewGRF industrytile or house sprite layout.
Definition: sprite.h:126
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition: newgrf_spritegroup.h:310
GetTerrainType
uint32 GetTerrainType(TileIndex tile, TileContext context)
Function used by houses (and soon industries) to get information on type of "terrain" the tile it is ...
Definition: newgrf_commons.cpp:350
ObjectResolverObject::GetTown
TownScopeResolver * GetTown()
Get the town resolver scope that belongs to this object resolver.
Definition: newgrf_object.cpp:373
ObjectSpec::grf_prop
GRFFilePropsBase< 2 > grf_prop
Properties related the the grf file.
Definition: newgrf_object.h:62
GetObjectRandomBits
static byte GetObjectRandomBits(TileIndex t)
Get the random bits of this tile.
Definition: object_map.h:61
ObjectSpec::IsEverAvailable
bool IsEverAvailable() const
Check whether the object might be available at some point in this game with the current game mode...
Definition: newgrf_object.cpp:61
DrawNewGRFTileSeqInGUI
static void DrawNewGRFTileSeqInGUI(int x, int y, const DrawTileSprites *dts, uint32 stage, PaletteID default_palette)
Draw NewGRF object in GUI.
Definition: sprite.h:135
GetCountAndDistanceOfClosestInstance
static uint32 GetCountAndDistanceOfClosestInstance(byte local_id, uint32 grfid, TileIndex tile, const Object *current)
Implementation of var 65.
Definition: newgrf_object.cpp:207
TileX
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:207
Object::colour
byte colour
Colour of the object, for display purpose.
Definition: object_base.h:30
OBJECT_FLAG_DRAW_WATER
Object wants to be drawn on water.
Definition: newgrf_object.h:38
INSTANTIATE_NEWGRF_CLASS_METHODS
#define INSTANTIATE_NEWGRF_CLASS_METHODS(name, Tspec, Tid, Tmax)
Force instantiation of the methods so we don&#39;t get linker errors.
Definition: newgrf_class_func.h:218
CBID_OBJECT_ANIMATION_NEXT_FRAME
Determine the next animation frame for a house.
Definition: newgrf_callbacks.h:259
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
CT_PURCHASE_OBJECT
static const CargoID CT_PURCHASE_OBJECT
Mapping of purchase for objects.
Definition: newgrf_object.h:157
DrawTileLayout
static void DrawTileLayout(const TileInfo *ti, const TileLayoutSpriteGroup *group, const ObjectSpec *spec)
Draw an group of sprites on the map.
Definition: newgrf_object.cpp:411
ObjectSpec::WasEverAvailable
bool WasEverAvailable() const
Check whether the object was available at some point in the past or present in this game with the cur...
Definition: newgrf_object.cpp:71
genworld.h
Functions related to world/map generation.
MP_OBJECT
Contains objects such as transmitters and owned land.
Definition: tile_type.h:53
ObjectSpec::introduction_date
Date introduction_date
From when can this object be built.
Definition: newgrf_object.h:70
AnimationBase< ObjectAnimationBase, ObjectSpec, Object, int, StubGetObjectCallback >::ChangeAnimationFrame
static void ChangeAnimationFrame(CallbackID cb, const ObjectSpec *spec, Object *obj, TileIndex tile, uint32 random_bits, uint32 trigger, int extra_data=0)
Check a callback to determine what the next animation step is and execute that step.
Definition: newgrf_animation_base.h:120
NewGRFClass::IsUIAvailable
bool IsUIAvailable(uint index) const
Check whether the spec will be available to the user at some point in time.
Definition: newgrf_airport.cpp:80
INVALID_OBJECT
static const ObjectID INVALID_OBJECT
An invalid object.
Definition: object_type.h:36
AnimationBase< ObjectAnimationBase, ObjectSpec, Object, int, StubGetObjectCallback >::AnimateTile
static void AnimateTile(const ObjectSpec *spec, Object *obj, TileIndex tile, bool random_animation, int extra_data=0)
Animate a single tile.
Definition: newgrf_animation_base.h:41
ObjectScopeResolver
Object scope resolver.
Definition: newgrf_object.h:102
ObjectSpec::Get
static const ObjectSpec * Get(ObjectType index)
Get the specification associated with a specific ObjectType.
Definition: newgrf_object.cpp:41
_object_specs
ObjectSpec _object_specs[NUM_OBJECTS]
All the object specifications.
Definition: newgrf_object.cpp:34
_local_company
CompanyByte _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
newgrf_object.h
Functions related to NewGRF objects.
ResolverObject::root_spritegroup
const SpriteGroup * root_spritegroup
Root SpriteGroup to use for resolving.
Definition: newgrf_spritegroup.h:339
GetTileSlope
Slope GetTileSlope(TileIndex tile, int *h)
Return the slope of a given tile inside the map.
Definition: tile_map.cpp:115
ObjectCallbackMask
ObjectCallbackMask
Callback masks for objects.
Definition: newgrf_callbacks.h:383
IsValidTile
static bool IsValidTile(TileIndex tile)
Checks if a tile is valid.
Definition: tile_map.h:154
OverrideManagerBase::GetID
virtual uint16 GetID(uint8 grf_local_id, uint32 grfid) const
Return the ID (if ever available) of a previously inserted entity.
Definition: newgrf_commons.cpp:104
object_base.h
Base for all objects.
ClosestTownFromTile
Town * ClosestTownFromTile(TileIndex tile, uint threshold)
Return the town closest (in distance or ownership) to a given tile, within a given threshold...
Definition: town_cmd.cpp:3239
ResetObjects
void ResetObjects()
This function initialize the spec arrays of objects.
Definition: newgrf_object.cpp:96
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
GetRegister
static uint32 GetRegister(uint i)
Gets the value of a so-called newgrf "register".
Definition: newgrf_spritegroup.h:30
SpriteGroup::Resolve
virtual const SpriteGroup * Resolve(ResolverObject &object) const
Base sprite group resolver.
Definition: newgrf_spritegroup.h:62
ObjectSpec::enabled
bool enabled
Is this spec enabled?
Definition: newgrf_object.h:78
Town::xy
TileIndex xy
town center tile
Definition: town.h:56
GetNearbyTile
TileIndex GetNearbyTile(byte parameter, TileIndex tile, bool signed_offsets, Axis axis)
Get the tile at the given offset.
Definition: newgrf_commons.cpp:425
IsTileType
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a give tiletype.
Definition: tile_map.h:143
TileLayoutSpriteGroup::ProcessRegisters
const DrawTileSprites * ProcessRegisters(uint8 *stage) const
Process registers and the construction stage into the sprite layout.
Definition: newgrf_spritegroup.cpp:314
AnimateNewObjectTile
void AnimateNewObjectTile(TileIndex tile)
Handle the animation of the object tile.
Definition: newgrf_object.cpp:516
TileInfo::tile
TileIndex tile
Tile index.
Definition: tile_cmd.h:48
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
DrawTileSprites
Ground palette sprite of a tile, together with its sprite layout.
Definition: sprite.h:60
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
ObjectScopeResolver::tile
TileIndex tile
The tile related to the object.
Definition: newgrf_object.h:104
GetTileOwner
static Owner GetTileOwner(TileIndex tile)
Returns the owner of a tile.
Definition: tile_map.h:171
OBJECT_FLAG_ONLY_IN_SCENEDIT
Object can only be constructed in the scenario editor.
Definition: newgrf_object.h:28
ObjectSpec::animation
AnimationInfo animation
Information about the animation.
Definition: newgrf_object.h:73
ObjectSpec::Index
uint Index() const
Gets the index of this spec.
Definition: newgrf_object.cpp:90
TILE_AREA_LOOP
#define TILE_AREA_LOOP(var, ta)
A loop which iterates over the tiles of a TileArea.
Definition: tilearea_type.h:232
stdafx.h
Definition of base types and functions in a cross-platform compatible way.
newgrf_animation_base.h
Function implementations related to NewGRF animation.
object_map.h
Map accessors for object tiles.
CBID_OBJECT_ANIMATION_SPEED
Called to indicate how long the current animation frame should last.
Definition: newgrf_callbacks.h:265
safeguards.h
A number of safeguards to prevent using unsafe methods.
TownScopeResolver
Scope resolver for a town.
Definition: newgrf_town.h:24
SpriteGroup
Definition: newgrf_spritegroup.h:58
GroundSpritePaletteTransform
static PaletteID GroundSpritePaletteTransform(SpriteID image, PaletteID pal, PaletteID default_pal)
Applies PALETTE_MODIFIER_COLOUR to a palette entry of a ground sprite.
Definition: sprite.h:170
GetObjectCallback
uint16 GetObjectCallback(CallbackID callback, uint32 param1, uint32 param2, const ObjectSpec *spec, Object *o, TileIndex tile, uint8 view)
Perform a callback for an object.
Definition: newgrf_object.cpp:399
_object_mngr
ObjectOverrideManager _object_mngr(NEW_OBJECT_OFFSET, NUM_OBJECTS, INVALID_OBJECT_TYPE)
The override manager for our objects.
Object
An object, such as transmitter, on the map.
Definition: object_base.h:25
NEW_OBJECT_OFFSET
static const ObjectType NEW_OBJECT_OFFSET
Offset for new objects.
Definition: object_type.h:26
Livery
Information about a particular livery.
Definition: livery.h:76
GetObjectIDAtOffset
static uint32 GetObjectIDAtOffset(TileIndex tile, uint32 cur_grfid)
Make an analysis of a tile and get the object type.
Definition: newgrf_object.cpp:142
TriggerObjectAnimation
void TriggerObjectAnimation(Object *o, ObjectAnimationTrigger trigger, const ObjectSpec *spec)
Trigger the update of animation on a whole object.
Definition: newgrf_object.cpp:544
GetNearbyObjectTileInformation
static uint32 GetNearbyObjectTileInformation(byte parameter, TileIndex tile, ObjectID index, bool grf_version8)
Based on newhouses equivalent, but adapted for newobjects.
Definition: newgrf_object.cpp:171
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
min
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:42
SPRITE_WIDTH
number of bits for the sprite number
Definition: sprites.h:1494
GetTownRadiusGroup
HouseZonesBits GetTownRadiusGroup(const Town *t, TileIndex tile)
Returns the bit corresponding to the town zone of the specified tile.
Definition: town_cmd.cpp:1998
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
ObjectResolverObject::ObjectResolverObject
ObjectResolverObject(const ObjectSpec *spec, Object *o, TileIndex tile, uint8 view=0, CallbackID callback=CBID_NO_CALLBACK, uint32 param1=0, uint32 param2=0)
Constructor of the object resolver.
Definition: newgrf_object.cpp:354
GetClosestObject
static uint32 GetClosestObject(TileIndex tile, ObjectType type, const Object *current)
Get the closest object of a given type.
Definition: newgrf_object.cpp:186
Livery::colour2
byte colour2
Second colour, for vehicles with 2CC support.
Definition: livery.h:79
GRFFilePropsBase::spritegroup
const struct SpriteGroup * spritegroup[Tcnt]
pointer to the different sprites of the entity
Definition: newgrf_commons.h:321
OBJECT_FLAG_ANIMATION
Object has animated tiles.
Definition: newgrf_object.h:34
StubGetObjectCallback
uint16 StubGetObjectCallback(CallbackID callback, uint32 param1, uint32 param2, const ObjectSpec *spec, Object *o, TileIndex tile, int extra_data)
Perform a callback for an object.
Definition: newgrf_object.cpp:498
MemCpyT
static void MemCpyT(T *destination, const T *source, size_t num=1)
Type-safe version of memcpy().
Definition: mem_func.hpp:25
DEBUG
#define DEBUG(name, level,...)
Output a line of debugging information.
Definition: debug.h:39
_original_objects
const ObjectSpec _original_objects[]
Specification of the original object structures.
OrthogonalTileArea::tile
TileIndex tile
The base tile of the area.
Definition: tilearea_type.h:19
company_func.h
Functions related to companies.
DrawTileSprites::ground
PalSpriteID ground
Palette and sprite for the ground.
Definition: sprite.h:61
PALETTE_RECOLOUR_START
static const PaletteID PALETTE_RECOLOUR_START
First recolour sprite for company colours.
Definition: sprites.h:1538
_generating_world
bool _generating_world
Whether we are generating the map or not.
Definition: genworld.cpp:61
ObjectID
uint32 ObjectID
Unique identifier for an object.
Definition: object_type.h:31
Object::GetTypeCount
static uint16 GetTypeCount(ObjectType type)
Get the count of objects for this type.
Definition: object_base.h:67
SpriteID
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:19
GetNearbyTileInformation
uint32 GetNearbyTileInformation(TileIndex tile, bool grf_version8)
Common part of station var 0x67, house var 0x62, indtile var 0x60, industry var 0x62.
Definition: newgrf_commons.cpp:448
_current_company
CompanyByte _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
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
AnimationBase
Helper class for a unified approach to NewGRF animation.
Definition: newgrf_animation_base.h:31
DistanceManhattan
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition: map.cpp:159
TileY
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:217
Object::location
TileArea location
Location of the object.
Definition: object_base.h:28
ResolverObject::callback
CallbackID callback
Callback being resolved.
Definition: newgrf_spritegroup.h:328
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:34
Object::type
ObjectType type
Type of the object.
Definition: object_base.h:26
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
Town
Town data structure.
Definition: town.h:55
NewGRFClass::Get
static NewGRFClass * Get(Tid cls_id)
Get a particular class.
Definition: newgrf_class_func.h:105
GetObjectIndex
static ObjectID GetObjectIndex(TileIndex t)
Get the index of which object this tile is attached to.
Definition: object_map.h:49
TO_STRUCTURES
other objects such as transmitters and lighthouses
Definition: transparency.h:31
ObjectAnimationTrigger
ObjectAnimationTrigger
Animation triggers for objects.
Definition: newgrf_animation_type.h:57
ObjectAnimationBase
Helper class for animation control.
Definition: newgrf_object.cpp:504
DrawGroundSprite
void DrawGroundSprite(SpriteID image, PaletteID pal, const SubSprite *sub, int extra_offs_x, int extra_offs_y)
Draws a ground sprite for the current tile.
Definition: viewport.cpp:604
Pool::PoolItem<&_company_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-NULL) Titem.
Definition: pool_type.hpp:235
GRFFilePropsBase::local_id
uint16 local_id
id defined by the grf file for this entity
Definition: newgrf_commons.h:319
Object::GetByTile
static Object * GetByTile(TileIndex tile)
Get the object associated with a tile.
Definition: object_cmd.cpp:52
NewGRFClass::InsertDefaults
static void InsertDefaults()
Initialise the defaults.
Definition: newgrf_airport.cpp:71
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
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:105
newgrf_sound.h
Functions related to NewGRF provided sounds.
INVALID_TILE
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:85
town.h
Base of the town class.
Livery::colour1
byte colour1
First colour, for all vehicles.
Definition: livery.h:78
GameSettings::game_creation
GameCreationSettings game_creation
settings used during the creation of a game (map)
Definition: settings_type.h:544
ObjectSpec::GetByTile
static const ObjectSpec * GetByTile(TileIndex tile)
Get the specification associated with a tile.
Definition: newgrf_object.cpp:52
DistanceSquare
uint DistanceSquare(TileIndex t0, TileIndex t1)
Gets the &#39;Square&#39; distance between the two given tiles.
Definition: map.cpp:176
Object::view
byte view
The view setting for this object.
Definition: object_base.h:31
water.h
Functions related to water (management)
IsTileOnWater
static bool IsTileOnWater(TileIndex t)
Tests if the tile was built on water.
Definition: water_map.h:130
PalSpriteID::sprite
SpriteID sprite
The &#39;real&#39; sprite.
Definition: gfx_type.h:25
ObjectSpec::cls_id
ObjectClassID cls_id
The class to which this spec belongs.
Definition: newgrf_object.h:63
TileLayoutSpriteGroup
Action 2 sprite layout for houses, industry tiles, objects and airport tiles.
Definition: newgrf_spritegroup.h:267
_date
Date _date
Current date in days (day counter)
Definition: date.cpp:28
ObjectSpec::climate
uint8 climate
In which climates is this object available?
Definition: newgrf_object.h:66
INVALID_OBJECT_TYPE
static const ObjectType INVALID_OBJECT_TYPE
An invalid object.
Definition: object_type.h:28
OBJECT_LIGHTHOUSE
static const ObjectType OBJECT_LIGHTHOUSE
The nice lighthouse.
Definition: object_type.h:19
DrawSprite
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition: gfx.cpp:833
tile_cmd.h
Generic &#39;commands&#39; that can be performed on all tiles.
GetObjectType
ObjectType GetObjectType(TileIndex t)
Gets the ObjectType of the given object tile.
Definition: object_cmd.cpp:63
CBID_OBJECT_ANIMATION_START_STOP
Called for periodically starting or stopping the animation.
Definition: newgrf_callbacks.h:262
MemSetT
static void MemSetT(T *ptr, byte value, size_t num=1)
Type-safe version of memset().
Definition: mem_func.hpp:51
ObjectClassID
ObjectClassID
Class IDs for objects.
Definition: newgrf_object.h:48
PalSpriteID::pal
PaletteID pal
The palette (use PAL_NONE) if not needed)
Definition: gfx_type.h:26
NewGRFClass::name
StringID name
Name of this class.
Definition: newgrf_class.h:41