OpenTTD Source: src/newgrf_commons.cpp Source File

OpenTTD Source 12.0-beta1

newgrf_commons.cpp
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 <http://www.gnu.org/licenses/>.
6 */
7
13 #include "stdafx.h"
14 #include "debug.h"
15 #include "landscape.h"
16 #include "house.h"
17 #include "industrytype.h"
18 #include "newgrf_config.h"
19 #include "clear_map.h"
20 #include "station_map.h"
21 #include "tree_map.h"
22 #include "tunnelbridge_map.h"
23 #include "newgrf_object.h"
24 #include "genworld.h"
25 #include "newgrf_spritegroup.h"
26 #include "newgrf_text.h"
27 #include "company_base.h"
28 #include "error.h"
29 #include "strings_func.h"
30
31 #include "table/strings.h"
32
33 #include "safeguards.h"
34
41 OverrideManagerBase::OverrideManagerBase(uint16 offset, uint16 maximum, uint16 invalid)
42 {
43 max_offset = offset;
44 max_new_entities = maximum;
45 invalid_ID = invalid;
46
47 mapping_ID = CallocT<EntityIDMapping>(max_new_entities);
48 entity_overrides = MallocT<uint16>(max_offset);
49 for (size_t i = 0; i < max_offset; i++) entity_overrides[i] = invalid;
50 grfid_overrides = CallocT<uint32>(max_offset);
51 }
52
57 OverrideManagerBase::~OverrideManagerBase()
58 {
59 free(mapping_ID);
60 free(entity_overrides);
61 free(grfid_overrides);
62 }
63
72 void OverrideManagerBase::Add(uint8 local_id, uint32 grfid, uint entity_type)
73 {
74 assert(entity_type < max_offset);
75 /* An override can be set only once */
76 if (entity_overrides[entity_type] != invalid_ID) return;
77 entity_overrides[entity_type] = local_id;
78 grfid_overrides[entity_type] = grfid;
79 }
80
82 void OverrideManagerBase::ResetMapping()
83 {
84 memset(mapping_ID, 0, (max_new_entities - 1) * sizeof(EntityIDMapping));
85 }
86
88 void OverrideManagerBase::ResetOverride()
89 {
90 for (uint16 i = 0; i < max_offset; i++) {
91 entity_overrides[i] = invalid_ID;
92 grfid_overrides[i] = 0;
93 }
94 }
95
102 uint16 OverrideManagerBase::GetID(uint8 grf_local_id, uint32 grfid) const
103 {
104 const EntityIDMapping *map;
105
106 for (uint16 id = 0; id < max_new_entities; id++) {
107 map = &mapping_ID[id];
108 if (map->entity_id == grf_local_id && map->grfid == grfid) {
109 return id;
110 }
111 }
112
113 return invalid_ID;
114 }
115
123 uint16 OverrideManagerBase::AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id)
124 {
125 uint16 id = this->GetID(grf_local_id, grfid);
126 EntityIDMapping *map;
127
128 /* Look to see if this entity has already been added. This is done
129 * separately from the loop below in case a GRF has been deleted, and there
130 * are any gaps in the array.
131 */
132 if (id != invalid_ID) {
133 return id;
134 }
135
136 /* This entity hasn't been defined before, so give it an ID now. */
137 for (id = max_offset; id < max_new_entities; id++) {
138 map = &mapping_ID[id];
139
140 if (CheckValidNewID(id) && map->entity_id == 0 && map->grfid == 0) {
141 map->entity_id = grf_local_id;
142 map->grfid = grfid;
143 map->substitute_id = substitute_id;
144 return id;
145 }
146 }
147
148 return invalid_ID;
149 }
150
156 uint32 OverrideManagerBase::GetGRFID(uint16 entity_id) const
157 {
158 return mapping_ID[entity_id].grfid;
159 }
160
166 uint16 OverrideManagerBase::GetSubstituteID(uint16 entity_id) const
167 {
168 return mapping_ID[entity_id].substitute_id;
169 }
170
176 void HouseOverrideManager::SetEntitySpec(const HouseSpec *hs)
177 {
178 HouseID house_id = this->AddEntityID(hs->grf_prop.local_id, hs->grf_prop.grffile->grfid, hs->grf_prop.subst_id);
179
180 if (house_id == invalid_ID) {
181 grfmsg(1, "House.SetEntitySpec: Too many houses allocated. Ignoring.");
182 return;
183 }
184
185 MemCpyT(HouseSpec::Get(house_id), hs);
186
187 /* Now add the overrides. */
188 for (int i = 0; i != max_offset; i++) {
189 HouseSpec *overridden_hs = HouseSpec::Get(i);
190
191 if (entity_overrides[i] != hs->grf_prop.local_id || grfid_overrides[i] != hs->grf_prop.grffile->grfid) continue;
192
193 overridden_hs->grf_prop.override = house_id;
194 entity_overrides[i] = invalid_ID;
195 grfid_overrides[i] = 0;
196 }
197 }
198
205 uint16 IndustryOverrideManager::GetID(uint8 grf_local_id, uint32 grfid) const
206 {
207 uint16 id = OverrideManagerBase::GetID(grf_local_id, grfid);
208 if (id != invalid_ID) return id;
209
210 /* No mapping found, try the overrides */
211 for (id = 0; id < max_offset; id++) {
212 if (entity_overrides[id] == grf_local_id && grfid_overrides[id] == grfid) return id;
213 }
214
215 return invalid_ID;
216 }
217
225 uint16 IndustryOverrideManager::AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id)
226 {
227 /* This entity hasn't been defined before, so give it an ID now. */
228 for (uint16 id = 0; id < max_new_entities; id++) {
229 /* Skip overridden industries */
230 if (id < max_offset && entity_overrides[id] != invalid_ID) continue;
231
232 /* Get the real live industry */
233 const IndustrySpec *inds = GetIndustrySpec(id);
234
235 /* This industry must be one that is not available(enabled), mostly because of climate.
236 * And it must not already be used by a grf (grffile == nullptr).
237 * So reserve this slot here, as it is the chosen one */
238 if (!inds->enabled && inds->grf_prop.grffile == nullptr) {
239 EntityIDMapping *map = &mapping_ID[id];
240
241 if (map->entity_id == 0 && map->grfid == 0) {
242 /* winning slot, mark it as been used */
243 map->entity_id = grf_local_id;
244 map->grfid = grfid;
245 map->substitute_id = substitute_id;
246 return id;
247 }
248 }
249 }
250
251 return invalid_ID;
252 }
253
260 void IndustryOverrideManager::SetEntitySpec(IndustrySpec *inds)
261 {
262 /* First step : We need to find if this industry is already specified in the savegame data. */
263 IndustryType ind_id = this->GetID(inds->grf_prop.local_id, inds->grf_prop.grffile->grfid);
264
265 if (ind_id == invalid_ID) {
266 /* Not found.
267 * Or it has already been overridden, so you've lost your place.
268 * Or it is a simple substitute.
269 * We need to find a free available slot */
270 ind_id = this->AddEntityID(inds->grf_prop.local_id, inds->grf_prop.grffile->grfid, inds->grf_prop.subst_id);
271 inds->grf_prop.override = invalid_ID; // make sure it will not be detected as overridden
272 }
273
274 if (ind_id == invalid_ID) {
275 grfmsg(1, "Industry.SetEntitySpec: Too many industries allocated. Ignoring.");
276 return;
277 }
278
279 /* Now that we know we can use the given id, copy the spec to its final destination... */
280 _industry_specs[ind_id] = *inds;
281 /* ... and mark it as usable*/
282 _industry_specs[ind_id].enabled = true;
283 }
284
285 void IndustryTileOverrideManager::SetEntitySpec(const IndustryTileSpec *its)
286 {
287 IndustryGfx indt_id = this->AddEntityID(its->grf_prop.local_id, its->grf_prop.grffile->grfid, its->grf_prop.subst_id);
288
289 if (indt_id == invalid_ID) {
290 grfmsg(1, "IndustryTile.SetEntitySpec: Too many industry tiles allocated. Ignoring.");
291 return;
292 }
293
294 memcpy(&_industry_tile_specs[indt_id], its, sizeof(*its));
295
296 /* Now add the overrides. */
297 for (int i = 0; i < max_offset; i++) {
298 IndustryTileSpec *overridden_its = &_industry_tile_specs[i];
299
300 if (entity_overrides[i] != its->grf_prop.local_id || grfid_overrides[i] != its->grf_prop.grffile->grfid) continue;
301
302 overridden_its->grf_prop.override = indt_id;
303 overridden_its->enabled = false;
304 entity_overrides[i] = invalid_ID;
305 grfid_overrides[i] = 0;
306 }
307 }
308
315 void ObjectOverrideManager::SetEntitySpec(ObjectSpec *spec)
316 {
317 /* First step : We need to find if this object is already specified in the savegame data. */
318 ObjectType type = this->GetID(spec->grf_prop.local_id, spec->grf_prop.grffile->grfid);
319
320 if (type == invalid_ID) {
321 /* Not found.
322 * Or it has already been overridden, so you've lost your place.
323 * Or it is a simple substitute.
324 * We need to find a free available slot */
325 type = this->AddEntityID(spec->grf_prop.local_id, spec->grf_prop.grffile->grfid, OBJECT_TRANSMITTER);
326 }
327
328 if (type == invalid_ID) {
329 grfmsg(1, "Object.SetEntitySpec: Too many objects allocated. Ignoring.");
330 return;
331 }
332
333 extern ObjectSpec _object_specs[NUM_OBJECTS];
334
335 /* Now that we know we can use the given id, copy the spec to its final destination. */
336 memcpy(&_object_specs[type], spec, sizeof(*spec));
337 ObjectClass::Assign(&_object_specs[type]);
338 }
339
348 uint32 GetTerrainType(TileIndex tile, TileContext context)
349 {
350 switch (_settings_game.game_creation.landscape) {
351 case LT_TROPIC: return GetTropicZone(tile);
352 case LT_ARCTIC: {
353 bool has_snow;
354 switch (GetTileType(tile)) {
355 case MP_CLEAR:
356 /* During map generation the snowstate may not be valid yet, as the tileloop may not have run yet. */
357 if (_generating_world) goto genworld;
358 has_snow = IsSnowTile(tile) && GetClearDensity(tile) >= 2;
359 break;
360
361 case MP_RAILWAY: {
362 /* During map generation the snowstate may not be valid yet, as the tileloop may not have run yet. */
363 if (_generating_world) goto genworld; // we do not care about foundations here
364 RailGroundType ground = GetRailGroundType(tile);
365 has_snow = (ground == RAIL_GROUND_ICE_DESERT || (context == TCX_UPPER_HALFTILE && ground == RAIL_GROUND_HALF_SNOW));
366 break;
367 }
368
369 case MP_ROAD:
370 /* During map generation the snowstate may not be valid yet, as the tileloop may not have run yet. */
371 if (_generating_world) goto genworld; // we do not care about foundations here
372 has_snow = IsOnSnow(tile);
373 break;
374
375 case MP_TREES: {
376 /* During map generation the snowstate may not be valid yet, as the tileloop may not have run yet. */
377 if (_generating_world) goto genworld;
378 TreeGround ground = GetTreeGround(tile);
379 has_snow = (ground == TREE_GROUND_SNOW_DESERT || ground == TREE_GROUND_ROUGH_SNOW) && GetTreeDensity(tile) >= 2;
380 break;
381 }
382
383 case MP_TUNNELBRIDGE:
384 if (context == TCX_ON_BRIDGE) {
385 has_snow = (GetBridgeHeight(tile) > GetSnowLine());
386 } else {
387 /* During map generation the snowstate may not be valid yet, as the tileloop may not have run yet. */
388 if (_generating_world) goto genworld; // we do not care about foundations here
389 has_snow = HasTunnelBridgeSnowOrDesert(tile);
390 }
391 break;
392
393 case MP_STATION:
394 case MP_HOUSE:
395 case MP_INDUSTRY:
396 case MP_OBJECT:
397 /* These tiles usually have a levelling foundation. So use max Z */
398 has_snow = (GetTileMaxZ(tile) > GetSnowLine());
399 break;
400
401 case MP_VOID:
402 case MP_WATER:
403 genworld:
404 has_snow = (GetTileZ(tile) > GetSnowLine());
405 break;
406
407 default: NOT_REACHED();
408 }
409 return has_snow ? 4 : 0;
410 }
411 default: return 0;
412 }
413 }
414
423 TileIndex GetNearbyTile(byte parameter, TileIndex tile, bool signed_offsets, Axis axis)
424 {
425 int8 x = GB(parameter, 0, 4);
426 int8 y = GB(parameter, 4, 4);
427
428 if (signed_offsets && x >= 8) x -= 16;
429 if (signed_offsets && y >= 8) y -= 16;
430
431 /* Swap width and height depending on axis for railway stations */
432 if (axis == INVALID_AXIS && HasStationTileRail(tile)) axis = GetRailStationAxis(tile);
433 if (axis == AXIS_Y) Swap(x, y);
434
435 /* Make sure we never roam outside of the map, better wrap in that case */
436 return TILE_MASK(tile + TileDiffXY(x, y));
437 }
438
446 uint32 GetNearbyTileInformation(TileIndex tile, bool grf_version8)
447 {
448 TileType tile_type = GetTileType(tile);
449
450 /* Fake tile type for trees on shore */
451 if (IsTileType(tile, MP_TREES) && GetTreeGround(tile) == TREE_GROUND_SHORE) tile_type = MP_WATER;
452
453 int z;
454 Slope tileh = GetTilePixelSlope(tile, &z);
455 /* Return 0 if the tile is a land tile */
456 byte terrain_type = (HasTileWaterClass(tile) ? (GetWaterClass(tile) + 1) & 3 : 0) << 5 | GetTerrainType(tile) << 2 | (tile_type == MP_WATER ? 1 : 0) << 1;
457 if (grf_version8) z /= TILE_HEIGHT;
458 return tile_type << 24 | Clamp(z, 0, 0xFF) << 16 | terrain_type << 8 | tileh;
459 }
460
467 uint32 GetCompanyInfo(CompanyID owner, const Livery *l)
468 {
469 if (l == nullptr && Company::IsValidID(owner)) l = &Company::Get(owner)->livery[LS_DEFAULT];
470 return owner | (Company::IsValidAiID(owner) ? 0x10000 : 0) | (l != nullptr ? (l->colour1 << 24) | (l->colour2 << 28) : 0);
471 }
472
480 CommandCost GetErrorMessageFromLocationCallbackResult(uint16 cb_res, const GRFFile *grffile, StringID default_error)
481 {
482 CommandCost res;
483
484 if (cb_res < 0x400) {
485 res = CommandCost(GetGRFStringID(grffile->grfid, 0xD000 + cb_res));
486 } else {
487 switch (cb_res) {
488 case 0x400: return res; // No error.
489
490 default: // unknown reason -> default error
491 case 0x401: res = CommandCost(default_error); break;
492
493 case 0x402: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_IN_RAINFOREST); break;
494 case 0x403: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_IN_DESERT); break;
495 case 0x404: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_ABOVE_SNOW_LINE); break;
496 case 0x405: res = CommandCost(STR_ERROR_CAN_ONLY_BE_BUILT_BELOW_SNOW_LINE); break;
497 case 0x406: res = CommandCost(STR_ERROR_CAN_T_BUILD_ON_SEA); break;
498 case 0x407: res = CommandCost(STR_ERROR_CAN_T_BUILD_ON_CANAL); break;
499 case 0x408: res = CommandCost(STR_ERROR_CAN_T_BUILD_ON_RIVER); break;
500 }
501 }
502
503 /* Copy some parameters from the registers to the error message text ref. stack */
504 res.UseTextRefStack(grffile, 4);
505
506 return res;
507 }
508
516 void ErrorUnknownCallbackResult(uint32 grfid, uint16 cbid, uint16 cb_res)
517 {
518 GRFConfig *grfconfig = GetGRFConfig(grfid);
519
520 if (!HasBit(grfconfig->grf_bugs, GBUG_UNKNOWN_CB_RESULT)) {
521 SetBit(grfconfig->grf_bugs, GBUG_UNKNOWN_CB_RESULT);
522 SetDParamStr(0, grfconfig->GetName());
523 SetDParam(1, cbid);
524 SetDParam(2, cb_res);
525 ShowErrorMessage(STR_NEWGRF_BUGGY, STR_NEWGRF_BUGGY_UNKNOWN_CALLBACK_RESULT, WL_CRITICAL);
526 }
527
528 /* debug output */
529 char buffer[512];
530
531 SetDParamStr(0, grfconfig->GetName());
532 GetString(buffer, STR_NEWGRF_BUGGY, lastof(buffer));
533 Debug(grf, 0, "{}", buffer + 3);
534
535 SetDParam(1, cbid);
536 SetDParam(2, cb_res);
537 GetString(buffer, STR_NEWGRF_BUGGY_UNKNOWN_CALLBACK_RESULT, lastof(buffer));
538 Debug(grf, 0, "{}", buffer + 3);
539 }
540
550 bool ConvertBooleanCallback(const GRFFile *grffile, uint16 cbid, uint16 cb_res)
551 {
552 assert(cb_res != CALLBACK_FAILED); // We do not know what to return
553
554 if (grffile->grf_version < 8) return cb_res != 0;
555
556 if (cb_res > 1) ErrorUnknownCallbackResult(grffile->grfid, cbid, cb_res);
557 return cb_res != 0;
558 }
559
569 bool Convert8bitBooleanCallback(const GRFFile *grffile, uint16 cbid, uint16 cb_res)
570 {
571 assert(cb_res != CALLBACK_FAILED); // We do not know what to return
572
573 if (grffile->grf_version < 8) return GB(cb_res, 0, 8) != 0;
574
575 if (cb_res > 1) ErrorUnknownCallbackResult(grffile->grfid, cbid, cb_res);
576 return cb_res != 0;
577 }
578
579
580 /* static */ std::vector<DrawTileSeqStruct> NewGRFSpriteLayout::result_seq;
581
586 void NewGRFSpriteLayout::Clone(const DrawTileSeqStruct *source)
587 {
588 assert(this->seq == nullptr);
589 assert(source != nullptr);
590
591 size_t count = 1; // 1 for the terminator
592 const DrawTileSeqStruct *element;
593 foreach_draw_tile_seq(element, source) count++;
594
595 DrawTileSeqStruct *sprites = MallocT<DrawTileSeqStruct>(count);
596 MemCpyT(sprites, source, count);
597 this->seq = sprites;
598 }
599
604 void NewGRFSpriteLayout::Clone(const NewGRFSpriteLayout *source)
605 {
606 this->Clone((const DrawTileSprites*)source);
607
608 if (source->registers != nullptr) {
609 size_t count = 1; // 1 for the ground sprite
610 const DrawTileSeqStruct *element;
611 foreach_draw_tile_seq(element, source->seq) count++;
612
613 TileLayoutRegisters *regs = MallocT<TileLayoutRegisters>(count);
614 MemCpyT(regs, source->registers, count);
615 this->registers = regs;
616 }
617 }
618
619
624 void NewGRFSpriteLayout::Allocate(uint num_sprites)
625 {
626 assert(this->seq == nullptr);
627
628 DrawTileSeqStruct *sprites = CallocT<DrawTileSeqStruct>(num_sprites + 1);
629 sprites[num_sprites].MakeTerminator();
630 this->seq = sprites;
631 }
632
636 void NewGRFSpriteLayout::AllocateRegisters()
637 {
638 assert(this->seq != nullptr);
639 assert(this->registers == nullptr);
640
641 size_t count = 1; // 1 for the ground sprite
642 const DrawTileSeqStruct *element;
643 foreach_draw_tile_seq(element, this->seq) count++;
644
645 this->registers = CallocT<TileLayoutRegisters>(count);
646 }
647
660 uint32 NewGRFSpriteLayout::PrepareLayout(uint32 orig_offset, uint32 newgrf_ground_offset, uint32 newgrf_offset, uint constr_stage, bool separate_ground) const
661 {
662 result_seq.clear();
663 uint32 var10_values = 0;
664
665 /* Create a copy of the spritelayout, so we can modify some values.
666 * Also include the groundsprite into the sequence for easier processing. */
667 DrawTileSeqStruct *result = &result_seq.emplace_back();
668 result->image = ground;
669 result->delta_x = 0;
670 result->delta_y = 0;
671 result->delta_z = (int8)0x80;
672
673 const DrawTileSeqStruct *dtss;
674 foreach_draw_tile_seq(dtss, this->seq) {
675 result_seq.push_back(*dtss);
676 }
677 result_seq.emplace_back().MakeTerminator();
678 /* Determine the var10 values the action-1-2-3 chains needs to be resolved for,
679 * and apply the default sprite offsets (unless disabled). */
680 const TileLayoutRegisters *regs = this->registers;
681 bool ground = true;
682 foreach_draw_tile_seq(result, result_seq.data()) {
683 TileLayoutFlags flags = TLF_NOTHING;
684 if (regs != nullptr) flags = regs->flags;
685
686 /* Record var10 value for the sprite */
687 if (HasBit(result->image.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE) || (flags & TLF_SPRITE_REG_FLAGS)) {
688 uint8 var10 = (flags & TLF_SPRITE_VAR10) ? regs->sprite_var10 : (ground && separate_ground ? 1 : 0);
689 SetBit(var10_values, var10);
690 }
691
692 /* Add default sprite offset, unless there is a custom one */
693 if (!(flags & TLF_SPRITE)) {
694 if (HasBit(result->image.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE)) {
695 result->image.sprite += ground ? newgrf_ground_offset : newgrf_offset;
696 if (constr_stage > 0 && regs != nullptr) result->image.sprite += GetConstructionStageOffset(constr_stage, regs->max_sprite_offset);
697 } else {
698 result->image.sprite += orig_offset;
699 }
700 }
701
702 /* Record var10 value for the palette */
703 if (HasBit(result->image.pal, SPRITE_MODIFIER_CUSTOM_SPRITE) || (flags & TLF_PALETTE_REG_FLAGS)) {
704 uint8 var10 = (flags & TLF_PALETTE_VAR10) ? regs->palette_var10 : (ground && separate_ground ? 1 : 0);
705 SetBit(var10_values, var10);
706 }
707
708 /* Add default palette offset, unless there is a custom one */
709 if (!(flags & TLF_PALETTE)) {
710 if (HasBit(result->image.pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) {
711 result->image.sprite += ground ? newgrf_ground_offset : newgrf_offset;
712 if (constr_stage > 0 && regs != nullptr) result->image.sprite += GetConstructionStageOffset(constr_stage, regs->max_palette_offset);
713 }
714 }
715
716 ground = false;
717 if (regs != nullptr) regs++;
718 }
719
720 return var10_values;
721 }
722
731 void NewGRFSpriteLayout::ProcessRegisters(uint8 resolved_var10, uint32 resolved_sprite, bool separate_ground) const
732 {
733 DrawTileSeqStruct *result;
734 const TileLayoutRegisters *regs = this->registers;
735 bool ground = true;
736 foreach_draw_tile_seq(result, result_seq.data()) {
737 TileLayoutFlags flags = TLF_NOTHING;
738 if (regs != nullptr) flags = regs->flags;
739
740 /* Is the sprite or bounding box affected by an action-1-2-3 chain? */
741 if (HasBit(result->image.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE) || (flags & TLF_SPRITE_REG_FLAGS)) {
742 /* Does the var10 value apply to this sprite? */
743 uint8 var10 = (flags & TLF_SPRITE_VAR10) ? regs->sprite_var10 : (ground && separate_ground ? 1 : 0);
744 if (var10 == resolved_var10) {
745 /* Apply registers */
746 if ((flags & TLF_DODRAW) && GetRegister(regs->dodraw) == 0) {
747 result->image.sprite = 0;
748 } else {
749 if (HasBit(result->image.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE)) result->image.sprite += resolved_sprite;
750 if (flags & TLF_SPRITE) {
751 int16 offset = (int16)GetRegister(regs->sprite); // mask to 16 bits to avoid trouble
752 if (!HasBit(result->image.sprite, SPRITE_MODIFIER_CUSTOM_SPRITE) || (offset >= 0 && offset < regs->max_sprite_offset)) {
753 result->image.sprite += offset;
754 } else {
755 result->image.sprite = SPR_IMG_QUERY;
756 }
757 }
758
759 if (result->IsParentSprite()) {
760 if (flags & TLF_BB_XY_OFFSET) {
761 result->delta_x += (int32)GetRegister(regs->delta.parent[0]);
762 result->delta_y += (int32)GetRegister(regs->delta.parent[1]);
763 }
764 if (flags & TLF_BB_Z_OFFSET) result->delta_z += (int32)GetRegister(regs->delta.parent[2]);
765 } else {
766 if (flags & TLF_CHILD_X_OFFSET) result->delta_x += (int32)GetRegister(regs->delta.child[0]);
767 if (flags & TLF_CHILD_Y_OFFSET) result->delta_y += (int32)GetRegister(regs->delta.child[1]);
768 }
769 }
770 }
771 }
772
773 /* Is the palette affected by an action-1-2-3 chain? */
774 if (result->image.sprite != 0 && (HasBit(result->image.pal, SPRITE_MODIFIER_CUSTOM_SPRITE) || (flags & TLF_PALETTE_REG_FLAGS))) {
775 /* Does the var10 value apply to this sprite? */
776 uint8 var10 = (flags & TLF_PALETTE_VAR10) ? regs->palette_var10 : (ground && separate_ground ? 1 : 0);
777 if (var10 == resolved_var10) {
778 /* Apply registers */
779 if (HasBit(result->image.pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) result->image.pal += resolved_sprite;
780 if (flags & TLF_PALETTE) {
781 int16 offset = (int16)GetRegister(regs->palette); // mask to 16 bits to avoid trouble
782 if (!HasBit(result->image.pal, SPRITE_MODIFIER_CUSTOM_SPRITE) || (offset >= 0 && offset < regs->max_palette_offset)) {
783 result->image.pal += offset;
784 } else {
785 result->image.sprite = SPR_IMG_QUERY;
786 result->image.pal = PAL_NONE;
787 }
788 }
789 }
790 }
791
792 ground = false;
793 if (regs != nullptr) regs++;
794 }
795 }
MP_CLEAR
@ MP_CLEAR
A tile without any structures, i.e. grass, rocks, farm fields etc.
Definition: tile_type.h:46
MP_HOUSE
@ MP_HOUSE
A house by a town.
Definition: tile_type.h:49
TCX_UPPER_HALFTILE
@ TCX_UPPER_HALFTILE
Querying information about the upper part of a tile with halftile foundation.
Definition: newgrf_commons.h:26
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
GRFFileProps::override
uint16 override
id of the entity been replaced by
Definition: newgrf_commons.h:333
Pool::PoolItem<&_company_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
EntityIDMapping::substitute_id
uint8 substitute_id
The (original) entity ID to use if this GRF is not available.
Definition: newgrf_commons.h:189
GetTileMaxZ
int GetTileMaxZ(TileIndex t)
Get top height of the tile inside the map.
Definition: tile_map.cpp:141
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:32
RAIL_GROUND_HALF_SNOW
@ RAIL_GROUND_HALF_SNOW
Snow only on higher part of slope (steep or one corner raised)
Definition: rail_map.h:500
TLF_DODRAW
@ TLF_DODRAW
Only draw sprite if value of register TileLayoutRegisters::dodraw is non-zero.
Definition: newgrf_commons.h:36
HasTileWaterClass
static bool HasTileWaterClass(TileIndex t)
Checks whether the tile has an waterclass associated.
Definition: water_map.h:95
NewGRFSpriteLayout::PrepareLayout
uint32 PrepareLayout(uint32 orig_offset, uint32 newgrf_ground_offset, uint32 newgrf_offset, uint constr_stage, bool separate_ground) const
Prepares a sprite layout before resolving action-1-2-3 chains.
Definition: newgrf_commons.cpp:660
ObjectSpec
Allow incrementing of ObjectClassID variables.
Definition: newgrf_object.h:58
ObjectSpec::grf_prop
GRFFilePropsBase< 2 > grf_prop
Properties related the the grf file.
Definition: newgrf_object.h:60
DrawTileSeqStruct::IsParentSprite
bool IsParentSprite() const
Check whether this is a parent sprite with a boundingbox.
Definition: sprite.h:47
GameCreationSettings::landscape
byte landscape
the landscape we're currently in
Definition: settings_type.h:320
TLF_CHILD_X_OFFSET
@ TLF_CHILD_X_OFFSET
Add signed offset to child sprite X positions from register TileLayoutRegisters::delta....
Definition: newgrf_commons.h:44
company_base.h
grfmsg
void CDECL grfmsg(int severity, const char *str,...)
Debug() function dedicated to newGRF debugging messages Function is essentially the same as Debug(grf...
Definition: newgrf.cpp:391
tunnelbridge_map.h
TileLayoutRegisters::sprite
uint8 sprite
Register specifying a signed offset for the sprite.
Definition: newgrf_commons.h:94
NewGRFSpriteLayout::AllocateRegisters
void AllocateRegisters()
Allocate memory for register modifiers.
Definition: newgrf_commons.cpp:636
OverrideManagerBase::~OverrideManagerBase
virtual ~OverrideManagerBase()
Destructor of the generic class.
Definition: newgrf_commons.cpp:57
TileLayoutRegisters::parent
uint8 parent[3]
Registers for signed offsets for the bounding box position of parent sprites.
Definition: newgrf_commons.h:99
TREE_GROUND_SHORE
@ TREE_GROUND_SHORE
shore
Definition: tree_map.h:56
TileLayoutRegisters::palette_var10
uint8 palette_var10
Value for variable 10 when resolving the palette.
Definition: newgrf_commons.h:103
PalSpriteID::sprite
SpriteID sprite
The 'real' sprite.
Definition: gfx_type.h:23
GetBridgeHeight
int GetBridgeHeight(TileIndex t)
Get the height ('z') of a bridge.
Definition: bridge_map.cpp:70
GetTreeDensity
static uint GetTreeDensity(TileIndex t)
Returns the 'density' of a tile with trees.
Definition: tree_map.h:113
HasBit
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103
GetTileZ
int GetTileZ(TileIndex tile)
Get bottom height of the tile.
Definition: tile_map.cpp:121
NewGRFSpriteLayout::ProcessRegisters
void ProcessRegisters(uint8 resolved_var10, uint32 resolved_sprite, bool separate_ground) const
Evaluates the register modifiers and integrates them into the preprocessed sprite layout.
Definition: newgrf_commons.cpp:731
MP_RAILWAY
@ MP_RAILWAY
A railway.
Definition: tile_type.h:47
NUM_OBJECTS
static const ObjectType NUM_OBJECTS
Number of supported objects overall.
Definition: object_type.h:25
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:102
GetRegister
static uint32 GetRegister(uint i)
Gets the value of a so-called newgrf "register".
Definition: newgrf_spritegroup.h:29
MP_INDUSTRY
@ MP_INDUSTRY
Part of an industry.
Definition: tile_type.h:54
OverrideManagerBase::Add
void Add(uint8 local_id, uint32 grfid, uint entity_type)
Since the entity IDs defined by the GRF file does not necessarily correlate to those used by the game...
Definition: newgrf_commons.cpp:72
clear_map.h
TILE_MASK
#define TILE_MASK(x)
'Wraps' the given tile to it is within the map.
Definition: map_func.h:26
newgrf_config.h
ConvertBooleanCallback
bool ConvertBooleanCallback(const GRFFile *grffile, uint16 cbid, uint16 cb_res)
Converts a callback result into a boolean.
Definition: newgrf_commons.cpp:550
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
MemCpyT
static void MemCpyT(T *destination, const T *source, size_t num=1)
Type-safe version of memcpy().
Definition: mem_func.hpp:23
TLF_BB_Z_OFFSET
@ TLF_BB_Z_OFFSET
Add signed offset to bounding box Z positions from register TileLayoutRegisters::delta....
Definition: newgrf_commons.h:42
MP_ROAD
@ MP_ROAD
A tile with road (or tram tracks)
Definition: tile_type.h:48
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:196
genworld.h
TileLayoutRegisters
Additional modifiers for items in sprite layouts.
Definition: newgrf_commons.h:91
TileLayoutRegisters::dodraw
uint8 dodraw
Register deciding whether the sprite shall be drawn at all. Non-zero means drawing.
Definition: newgrf_commons.h:93
IndustryOverrideManager::GetID
uint16 GetID(uint8 grf_local_id, uint32 grfid) const override
Return the ID (if ever available) of a previously inserted entity.
Definition: newgrf_commons.cpp:205
ShowErrorMessage
void ShowErrorMessage(StringID summary_msg, StringID detailed_msg, WarningLevel wl, int x=0, int y=0, const GRFFile *textref_stack_grffile=nullptr, uint textref_stack_size=0, const uint32 *textref_stack=nullptr)
Display an error message in a window.
Definition: error_gui.cpp:383
GameSettings::game_creation
GameCreationSettings game_creation
settings used during the creation of a game (map)
Definition: settings_type.h:576
EntityIDMapping::grfid
uint32 grfid
The GRF ID of the file the entity belongs to.
Definition: newgrf_commons.h:187
DrawTileSprites::ground
PalSpriteID ground
Palette and sprite for the ground.
Definition: sprite.h:59
OverrideManagerBase::OverrideManagerBase
OverrideManagerBase(uint16 offset, uint16 maximum, uint16 invalid)
Constructor of generic class.
Definition: newgrf_commons.cpp:41
DrawTileSeqStruct::delta_x
int8 delta_x
0x80 is sequence terminator
Definition: sprite.h:26
GRFConfig::grf_bugs
uint32 grf_bugs
NOSAVE: bugs in this GRF in this run,.
Definition: newgrf_config.h:175
AXIS_Y
@ AXIS_Y
The y axis.
Definition: direction_type.h:125
GetClearDensity
static uint GetClearDensity(TileIndex t)
Get the density of a non-field clear tile.
Definition: clear_map.h:83
CommandCost::UseTextRefStack
void UseTextRefStack(const GRFFile *grffile, uint num_registers)
Activate usage of the NewGRF TextRefStack for the error message.
Definition: command.cpp:802
CommandCost
Common return value for all commands.
Definition: command_type.h:23
GetSnowLine
byte GetSnowLine()
Get the current snow line, either variable or static.
Definition: landscape.cpp:645
GRFConfig
Information about GRF, used in the game and (part of it) in savegames.
Definition: newgrf_config.h:155
DrawTileSeqStruct::delta_z
int8 delta_z
0x80 identifies child sprites
Definition: sprite.h:28
TLF_BB_XY_OFFSET
@ TLF_BB_XY_OFFSET
Add signed offset to bounding box X and Y positions from register TileLayoutRegisters::delta....
Definition: newgrf_commons.h:41
OverrideManagerBase::ResetMapping
void ResetMapping()
Resets the mapping, which is used while initializing game.
Definition: newgrf_commons.cpp:82
TLF_CHILD_Y_OFFSET
@ TLF_CHILD_Y_OFFSET
Add signed offset to child sprite Y positions from register TileLayoutRegisters::delta....
Definition: newgrf_commons.h:45
Convert8bitBooleanCallback
bool Convert8bitBooleanCallback(const GRFFile *grffile, uint16 cbid, uint16 cb_res)
Converts a callback result into a boolean.
Definition: newgrf_commons.cpp:569
ObjectType
uint16 ObjectType
Types of objects.
Definition: object_type.h:14
MP_OBJECT
@ MP_OBJECT
Contains objects such as transmitters and owned land.
Definition: tile_type.h:56
MP_WATER
@ MP_WATER
Water tile.
Definition: tile_type.h:52
GetErrorMessageFromLocationCallbackResult
CommandCost GetErrorMessageFromLocationCallbackResult(uint16 cb_res, const GRFFile *grffile, StringID default_error)
Get the error message from a shape/location/slope check callback result.
Definition: newgrf_commons.cpp:480
foreach_draw_tile_seq
#define foreach_draw_tile_seq(idx, list)
Iterate through all DrawTileSeqStructs in DrawTileSprites.
Definition: sprite.h:79
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:53
GetTropicZone
static TropicZone GetTropicZone(TileIndex tile)
Get the tropic zone.
Definition: tile_map.h:238
TileContext
TileContext
Context for tile accesses.
Definition: newgrf_commons.h:24
TileLayoutRegisters::child
uint8 child[2]
Registers for signed offsets for the position of child sprites.
Definition: newgrf_commons.h:100
NewGRFSpriteLayout
NewGRF supplied spritelayout.
Definition: newgrf_commons.h:113
HasStationTileRail
static bool HasStationTileRail(TileIndex t)
Has this station tile a rail? In other words, is this station tile a rail station or rail waypoint?
Definition: station_map.h:146
safeguards.h
ObjectOverrideManager::SetEntitySpec
void SetEntitySpec(ObjectSpec *spec)
Method to install the new object data in its proper slot The slot assignment is internal of this meth...
Definition: newgrf_commons.cpp:315
Company::IsValidAiID
static bool IsValidAiID(size_t index)
Is this company a valid company, controlled by the computer (a NoAI program)?
Definition: company_base.h:135
IsSnowTile
static bool IsSnowTile(TileIndex t)
Test if a tile is covered with snow.
Definition: clear_map.h:35
GetGRFStringID
StringID GetGRFStringID(uint32 grfid, StringID stringid)
Returns the index for this stringid associated with its grfID.
Definition: newgrf_text.cpp:601
SPRITE_MODIFIER_CUSTOM_SPRITE
@ SPRITE_MODIFIER_CUSTOM_SPRITE
Set when a sprite originates from an Action 1.
Definition: sprites.h:1537
IndustryTileSpec::enabled
bool enabled
entity still available (by default true).newgrf can disable it, though
Definition: industrytype.h:171
IsOnSnow
static bool IsOnSnow(TileIndex t)
Check if a road tile has snow/desert.
Definition: road_map.h:459
DrawTileSprites
Ground palette sprite of a tile, together with its sprite layout.
Definition: sprite.h:58
MP_TUNNELBRIDGE
@ MP_TUNNELBRIDGE
Tunnel entry/exit and bridge heads.
Definition: tile_type.h:55
newgrf_text.h
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:446
error.h
GetConstructionStageOffset
static uint GetConstructionStageOffset(uint construction_stage, uint num_sprites)
Determines which sprite to use from a spriteset for a specific construction stage.
Definition: newgrf_commons.h:75
Slope
Slope
Enumeration for the slope-type.
Definition: slope_type.h:48
EntityIDMapping
Maps an entity id stored on the map to a GRF file.
Definition: newgrf_commons.h:186
stdafx.h
landscape.h
IndustrySpec
Defines the data structure for constructing industry.
Definition: industrytype.h:107
HasTunnelBridgeSnowOrDesert
static bool HasTunnelBridgeSnowOrDesert(TileIndex t)
Tunnel: Is this tunnel entrance in a snowy or desert area? Bridge: Does the bridge ramp lie in a snow...
Definition: tunnelbridge_map.h:52
IndustryTileSpec::grf_prop
GRFFileProps grf_prop
properties related to the grf file
Definition: industrytype.h:172
house.h
IsTileType
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a given tiletype.
Definition: tile_map.h:150
GBUG_UNKNOWN_CB_RESULT
@ GBUG_UNKNOWN_CB_RESULT
A callback returned an unknown/invalid result.
Definition: newgrf_config.h:47
RailGroundType
RailGroundType
The ground 'under' the rail.
Definition: rail_map.h:485
newgrf_object.h
MP_TREES
@ MP_TREES
Tile got trees.
Definition: tile_type.h:50
newgrf_spritegroup.h
TileLayoutRegisters::sprite_var10
uint8 sprite_var10
Value for variable 10 when resolving the sprite.
Definition: newgrf_commons.h:102
_generating_world
bool _generating_world
Whether we are generating the map or not.
Definition: genworld.cpp:61
EntityIDMapping::entity_id
uint8 entity_id
The entity ID within the GRF file.
Definition: newgrf_commons.h:188
IndustrySpec::enabled
bool enabled
entity still available (by default true).newgrf can disable it, though
Definition: industrytype.h:140
CALLBACK_FAILED
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
Definition: newgrf_callbacks.h:404
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
HouseID
uint16 HouseID
OpenTTD ID of house types.
Definition: house_type.h:13
TreeGround
TreeGround
Enumeration for ground types of tiles with trees.
Definition: tree_map.h:52
Clamp
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:77
strings_func.h
GetWaterClass
static WaterClass GetWaterClass(TileIndex t)
Get the water class at a tile.
Definition: water_map.h:106
OverrideManagerBase::max_new_entities
uint16 max_new_entities
what is the amount of entities, old and new summed
Definition: newgrf_commons.h:198
TileLayoutRegisters::palette
uint8 palette
Register specifying a signed offset for the palette.
Definition: newgrf_commons.h:95
MP_VOID
@ MP_VOID
Invisible tiles at the SW and SE border.
Definition: tile_type.h:53
TileLayoutRegisters::max_palette_offset
uint16 max_palette_offset
Maximum offset to add to the palette. (limited by size of the spriteset)
Definition: newgrf_commons.h:97
TileType
TileType
The different types of tiles.
Definition: tile_type.h:45
GetRailStationAxis
static Axis GetRailStationAxis(TileIndex t)
Get the rail direction of a rail station.
Definition: station_map.h:337
OverrideManagerBase::GetSubstituteID
uint16 GetSubstituteID(uint16 entity_id) const
Gives the substitute of the entity, as specified by the grf file.
Definition: newgrf_commons.cpp:166
TCX_ON_BRIDGE
@ TCX_ON_BRIDGE
Querying information about stuff on the bridge (via some bridgehead).
Definition: newgrf_commons.h:27
IndustryOverrideManager::AddEntityID
uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id) override
Method to find an entity ID and to mark it as reserved for the Industry to be included.
Definition: newgrf_commons.cpp:225
industrytype.h
tree_map.h
TileDiffXY
static TileIndexDiff TileDiffXY(int x, int y)
Calculates an offset for the given coordinate(-offset).
Definition: map_func.h:179
MP_STATION
@ MP_STATION
A tile of a station.
Definition: tile_type.h:51
IndustrySpec::grf_prop
GRFFileProps grf_prop
properties related to the grf file
Definition: industrytype.h:141
OverrideManagerBase::ResetOverride
void ResetOverride()
Resets the override, which is used while initializing game.
Definition: newgrf_commons.cpp:88
TileLayoutFlags
TileLayoutFlags
Flags to enable register usage in sprite layouts.
Definition: newgrf_commons.h:33
OverrideManagerBase::mapping_ID
EntityIDMapping * mapping_ID
mapping of ids from grf files. Public out of convenience
Definition: newgrf_commons.h:204
GetTreeGround
static TreeGround GetTreeGround(TileIndex t)
Returns the groundtype for tree tiles.
Definition: tree_map.h:88
NewGRFSpriteLayout::Clone
void Clone(const DrawTileSeqStruct *source)
Clone the building sprites of a spritelayout.
Definition: newgrf_commons.cpp:586
GetCompanyInfo
uint32 GetCompanyInfo(CompanyID owner, const Livery *l)
Returns company information like in vehicle var 43 or station var 43.
Definition: newgrf_commons.cpp:467
DrawTileSprites::seq
const DrawTileSeqStruct * seq
Array of child sprites. Terminated with a terminator entry.
Definition: sprite.h:60
station_map.h
Debug
#define Debug(name, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
SetBit
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
DrawTileSeqStruct::MakeTerminator
void MakeTerminator()
Make this struct a sequence terminator.
Definition: sprite.h:35
TileLayoutRegisters::flags
TileLayoutFlags flags
Flags defining which members are valid and to be used.
Definition: newgrf_commons.h:92
TILE_HEIGHT
static const uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in #ZOOM_LVL_BASE.
Definition: tile_type.h:16
GetNearbyTile
TileIndex GetNearbyTile(byte parameter, TileIndex tile, bool signed_offsets, Axis axis)
Get the tile at the given offset.
Definition: newgrf_commons.cpp:423
OverrideManagerBase::max_offset
uint16 max_offset
what is the length of the original entity's array of specs
Definition: newgrf_commons.h:197
HouseSpec
Definition: house.h:98
Axis
Axis
Allow incrementing of DiagDirDiff variables.
Definition: direction_type.h:123
OverrideManagerBase::AddEntityID
virtual uint16 AddEntityID(byte grf_local_id, uint32 grfid, byte substitute_id)
Reserves a place in the mapping array for an entity to be installed.
Definition: newgrf_commons.cpp:123
OverrideManagerBase::GetGRFID
uint32 GetGRFID(uint16 entity_id) const
Gives the GRFID of the file the entity belongs to.
Definition: newgrf_commons.cpp:156
TREE_GROUND_SNOW_DESERT
@ TREE_GROUND_SNOW_DESERT
a desert or snow tile, depend on landscape
Definition: tree_map.h:55
GRFFilePropsBase::local_id
uint16 local_id
id defined by the grf file for this entity
Definition: newgrf_commons.h:319
PalSpriteID::pal
PaletteID pal
The palette (use PAL_NONE) if not needed)
Definition: gfx_type.h:24
ErrorUnknownCallbackResult
void ErrorUnknownCallbackResult(uint32 grfid, uint16 cbid, uint16 cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
Definition: newgrf_commons.cpp:516
TLF_PALETTE_REG_FLAGS
@ TLF_PALETTE_REG_FLAGS
Flags which require resolving the action-1-2-3 chain for the palette, even if it is no action-1 palet...
Definition: newgrf_commons.h:65
TLF_SPRITE
@ TLF_SPRITE
Add signed offset to sprite from register TileLayoutRegisters::sprite.
Definition: newgrf_commons.h:37
TLF_PALETTE
@ TLF_PALETTE
Add signed offset to palette from register TileLayoutRegisters::palette.
Definition: newgrf_commons.h:38
GetIndustrySpec
const IndustrySpec * GetIndustrySpec(IndustryType thistype)
Accessor for array _industry_specs.
Definition: industry_cmd.cpp:121
GetTileType
static TileType GetTileType(TileIndex tile)
Get the tiletype of a given tile.
Definition: tile_map.h:96
Pool::PoolItem<&_company_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:326
GRFFilePropsBase::grffile
const struct GRFFile * grffile
grf file that introduced this entity
Definition: newgrf_commons.h:320
Swap
static void Swap(T &a, T &b)
Type safe swap operation.
Definition: math_func.hpp:215
INVALID_AXIS
@ INVALID_AXIS
Flag for an invalid Axis.
Definition: direction_type.h:127
GetTilePixelSlope
static Slope GetTilePixelSlope(TileIndex tile, int *h)
Return the slope of a given tile.
Definition: tile_map.h:280
free
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: stdafx.h:460
OBJECT_TRANSMITTER
static const ObjectType OBJECT_TRANSMITTER
The large antenna.
Definition: object_type.h:16
IndustryOverrideManager::SetEntitySpec
void SetEntitySpec(IndustrySpec *inds)
Method to install the new industry data in its proper slot The slot assignment is internal of this me...
Definition: newgrf_commons.cpp:260
IndustryTileSpec
Defines the data structure of each individual tile of an industry.
Definition: industrytype.h:156
TLF_PALETTE_VAR10
@ TLF_PALETTE_VAR10
Resolve palette with a specific value in variable 10.
Definition: newgrf_commons.h:48
TLF_SPRITE_REG_FLAGS
@ TLF_SPRITE_REG_FLAGS
Flags which require resolving the action-1-2-3 chain for the sprite, even if it is no action-1 sprite...
Definition: newgrf_commons.h:62
TLF_SPRITE_VAR10
@ TLF_SPRITE_VAR10
Resolve sprite with a specific value in variable 10.
Definition: newgrf_commons.h:47
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:394
Livery
Information about a particular livery.
Definition: livery.h:78
NewGRFSpriteLayout::result_seq
static std::vector< DrawTileSeqStruct > result_seq
Temporary storage when preprocessing spritelayouts.
Definition: newgrf_commons.h:171
RAIL_GROUND_ICE_DESERT
@ RAIL_GROUND_ICE_DESERT
Icy or sandy.
Definition: rail_map.h:498
HouseSpec::grf_prop
GRFFileProps grf_prop
Properties related the the grf file.
Definition: house.h:114
GetGRFConfig
GRFConfig * GetGRFConfig(uint32 grfid, uint32 mask)
Retrieve a NewGRF from the current config by its grfid.
Definition: newgrf_config.cpp:762
SetDParamStr
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:296
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:348
NewGRFSpriteLayout::Allocate
void Allocate(uint num_sprites)
Allocate a spritelayout for num_sprites building sprites.
Definition: newgrf_commons.cpp:624
GRFFile
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:105
WL_CRITICAL
@ WL_CRITICAL
Critical errors, the MessageBox is shown in all cases.
Definition: error.h:25
OverrideManagerBase::invalid_ID
uint16 invalid_ID
ID used to detected invalid entities;.
Definition: newgrf_commons.h:200
debug.h
GRFConfig::GetName
const char * GetName() const
Get the name of this grf.
Definition: newgrf_config.cpp:105
TileLayoutRegisters::max_sprite_offset
uint16 max_sprite_offset
Maximum offset to add to the sprite. (limited by size of the spriteset)
Definition: newgrf_commons.h:96
DrawTileSeqStruct
A tile child sprite and palette to draw for stations etc, with 3D bounding box.
Definition: sprite.h:25
Livery::colour2
byte colour2
Second colour, for vehicles with 2CC support.
Definition: livery.h:81
Livery::colour1
byte colour1
First colour, for all vehicles.
Definition: livery.h:80
HouseOverrideManager::SetEntitySpec
void SetEntitySpec(const HouseSpec *hs)
Install the specs into the HouseSpecs array It will find itself the proper slot on which it will go.
Definition: newgrf_commons.cpp:176
_object_specs
ObjectSpec _object_specs[NUM_OBJECTS]
All the object specifications.
Definition: newgrf_object.cpp:32
TREE_GROUND_ROUGH_SNOW
@ TREE_GROUND_ROUGH_SNOW
A snow tile that is rough underneath.
Definition: tree_map.h:57