OpenTTD: src/newgrf_industries.h Source File

OpenTTD

- Main Page
- Related Pages
- Modules
- Namespaces
- Data Structures
- Files

- File List
- Globals

newgrf_industries.h
Go to the documentation of this file.
1 /* $Id: newgrf_industries.h 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 #ifndef NEWGRF_INDUSTRIES_H
13 #define NEWGRF_INDUSTRIES_H
14
15 #include "newgrf_town.h"
16
18 struct IndustriesScopeResolver : public ScopeResolver {
19 TileIndex tile;
20 Industry *industry;
21 IndustryType type;
22 uint32 random_bits;
23
32 IndustriesScopeResolver(ResolverObject &ro, TileIndex tile, Industry *industry, IndustryType type, uint32 random_bits = 0)
33 : ScopeResolver(ro), tile(tile), industry(industry), type(type), random_bits(random_bits)
34 {
35 }
36
37 /* virtual */ uint32 GetRandomBits() const;
38 /* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
39 /* virtual */ uint32 GetTriggers() const;
40 /* virtual */ void StorePSA(uint pos, int32 value);
41 };
42
44 struct IndustriesResolverObject : public ResolverObject {
45 IndustriesScopeResolver industries_scope;
46 TownScopeResolver *town_scope;
47
48 IndustriesResolverObject(TileIndex tile, Industry *indus, IndustryType type, uint32 random_bits = 0,
49 CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
50 ~IndustriesResolverObject();
51
52 TownScopeResolver *GetTown();
53
54 /* virtual */ ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0)
55 {
56 switch (scope) {
57 case VSG_SCOPE_SELF: return &industries_scope;
58 case VSG_SCOPE_PARENT: {
59 TownScopeResolver *tsr = this->GetTown();
60 if (tsr != NULL) return tsr;
61 }
62 FALLTHROUGH;
63
64 default:
65 return ResolverObject::GetScope(scope, relative);
66 }
67 }
68 };
69
71 enum IndustryTrigger {
73 INDUSTRY_TRIGGER_TILELOOP_PROCESS = 1,
75 INDUSTRY_TRIGGER_256_TICKS = 2,
77 INDUSTRY_TRIGGER_CARGO_DELIVERY = 4,
78 };
79
81 enum IndustryAvailabilityCallType {
82 IACT_MAPGENERATION,
83 IACT_RANDOMCREATION,
84 IACT_USERCREATION,
85 IACT_PROSPECTCREATION,
86 };
87
88 /* in newgrf_industry.cpp */
89 uint16 GetIndustryCallback(CallbackID callback, uint32 param1, uint32 param2, Industry *industry, IndustryType type, TileIndex tile);
90 uint32 GetIndustryIDAtOffset(TileIndex new_tile, const Industry *i, uint32 cur_grfid);
91 void IndustryProductionCallback(Industry *ind, int reason);
92 CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, uint layout, uint32 seed, uint16 initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type);
93 uint32 GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32 default_prob);
94 bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoID cargo_type);
95
96 IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id);
97
98 /* in newgrf_industrytiles.cpp*/
99 uint32 GetNearbyIndustryTileInformation(byte parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8);
100
101 #endif /* NEWGRF_INDUSTRIES_H */