OpenTTD Source: src/newgrf_industries.h Source File

OpenTTD Source 14.0-RC3

newgrf_industries.h
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
10 #ifndef NEWGRF_INDUSTRIES_H
11 #define NEWGRF_INDUSTRIES_H
12
13 #include "newgrf_town.h"
14
16 struct IndustriesScopeResolver : public ScopeResolver {
17 TileIndex tile;
18 Industry *industry;
19 IndustryType type;
20 uint32_t random_bits;
21
30 IndustriesScopeResolver(ResolverObject &ro, TileIndex tile, Industry *industry, IndustryType type, uint32_t random_bits = 0)
31 : ScopeResolver(ro), tile(tile), industry(industry), type(type), random_bits(random_bits)
32 {
33 }
34
35 uint32_t GetRandomBits() const override;
36 uint32_t GetVariable(byte variable, [[maybe_unused]] uint32_t parameter, bool *available) const override;
37 uint32_t GetTriggers() const override;
38 void StorePSA(uint pos, int32_t value) override;
39 };
40
42 struct IndustriesResolverObject : public ResolverObject {
43 IndustriesScopeResolver industries_scope;
44 TownScopeResolver *town_scope;
45
46 IndustriesResolverObject(TileIndex tile, Industry *indus, IndustryType type, uint32_t random_bits = 0,
47 CallbackID callback = CBID_NO_CALLBACK, uint32_t callback_param1 = 0, uint32_t callback_param2 = 0);
48 ~IndustriesResolverObject();
49
50 TownScopeResolver *GetTown();
51
52 ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0) override
53 {
54 switch (scope) {
55 case VSG_SCOPE_SELF: return &industries_scope;
56 case VSG_SCOPE_PARENT: {
57 TownScopeResolver *tsr = this->GetTown();
58 if (tsr != nullptr) return tsr;
59 }
60 [[fallthrough]];
61
62 default:
63 return ResolverObject::GetScope(scope, relative);
64 }
65 }
66
67 GrfSpecFeature GetFeature() const override;
68 uint32_t GetDebugID() const override;
69 };
70
72 enum IndustryTrigger {
74 INDUSTRY_TRIGGER_TILELOOP_PROCESS = 1,
76 INDUSTRY_TRIGGER_256_TICKS = 2,
78 INDUSTRY_TRIGGER_CARGO_DELIVERY = 4,
79 };
80
82 enum IndustryAvailabilityCallType {
83 IACT_MAPGENERATION,
84 IACT_RANDOMCREATION,
85 IACT_USERCREATION,
86 IACT_PROSPECTCREATION,
87 };
88
89 /* in newgrf_industry.cpp */
90 uint16_t GetIndustryCallback(CallbackID callback, uint32_t param1, uint32_t param2, Industry *industry, IndustryType type, TileIndex tile);
91 uint32_t GetIndustryIDAtOffset(TileIndex new_tile, const Industry *i, uint32_t cur_grfid);
92 void IndustryProductionCallback(Industry *ind, int reason);
93 CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, size_t layout, uint32_t seed, uint16_t initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type);
94 uint32_t GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32_t default_prob);
95 bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoID cargo_type);
96
97 IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32_t grf_id);
98
99 /* in newgrf_industrytiles.cpp*/
100 uint32_t GetNearbyIndustryTileInformation(byte parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8);
101
102 #endif /* NEWGRF_INDUSTRIES_H */
IndustriesScopeResolver::StorePSA
void StorePSA(uint pos, int32_t value) override
Store a value into the persistent storage area (PSA).
Definition: newgrf_industries.cpp:428
INDUSTRY_TRIGGER_CARGO_DELIVERY
@ INDUSTRY_TRIGGER_CARGO_DELIVERY
Triggered on cargo delivery.
Definition: newgrf_industries.h:78
VarSpriteGroupScope
VarSpriteGroupScope
Definition: newgrf_spritegroup.h:97
IndustriesResolverObject::IndustriesResolverObject
IndustriesResolverObject(TileIndex tile, Industry *indus, IndustryType type, uint32_t random_bits=0, CallbackID callback=CBID_NO_CALLBACK, uint32_t callback_param1=0, uint32_t callback_param2=0)
Constructor of the industries resolver.
Definition: newgrf_industries.cpp:467
IndustriesScopeResolver::tile
TileIndex tile
Tile owned by the industry.
Definition: newgrf_industries.h:17
IndustriesScopeResolver::GetRandomBits
uint32_t GetRandomBits() const override
Get a few random bits.
Definition: newgrf_industries.cpp:418
IndustriesResolverObject::GetTown
TownScopeResolver * GetTown()
Get or create the town scope object associated with the industry.
Definition: newgrf_industries.cpp:485
MapNewGRFIndustryType
IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32_t grf_id)
Map the GRF local type to an industry type.
Definition: newgrf_industries.cpp:40
IndustriesScopeResolver::GetTriggers
uint32_t GetTriggers() const override
Get the triggers.
Definition: newgrf_industries.cpp:423
IACT_RANDOMCREATION
@ IACT_RANDOMCREATION
during creation of random ingame industry
Definition: newgrf_industries.h:84
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition: newgrf_spritegroup.h:307
IndustriesScopeResolver::industry
Industry * industry
Industry being resolved.
Definition: newgrf_industries.h:18
IndustriesResolverObject::GetFeature
GrfSpecFeature GetFeature() const override
Get the feature number being resolved for.
Definition: newgrf_industries.cpp:502
IndustriesScopeResolver::random_bits
uint32_t random_bits
Random bits of the new industry.
Definition: newgrf_industries.h:20
IndustriesResolverObject::town_scope
TownScopeResolver * town_scope
Scope resolver for the associated town (if needed and available, else nullptr).
Definition: newgrf_industries.h:44
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
CallbackID
CallbackID
List of implemented NewGRF callbacks.
Definition: newgrf_callbacks.h:20
INDUSTRY_TRIGGER_TILELOOP_PROCESS
@ INDUSTRY_TRIGGER_TILELOOP_PROCESS
Triggered each tile loop.
Definition: newgrf_industries.h:74
VSG_SCOPE_PARENT
@ VSG_SCOPE_PARENT
Related object of the resolved one.
Definition: newgrf_spritegroup.h:101
Industry
Defines the internal data of a functional industry.
Definition: industry.h:68
GetIndustryProbabilityCallback
uint32_t GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32_t default_prob)
Check with callback CBID_INDUSTRY_PROBABILITY whether the industry can be built.
Definition: newgrf_industries.cpp:570
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
ScopeResolver
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope).
Definition: newgrf_spritegroup.h:288
VSG_SCOPE_SELF
@ VSG_SCOPE_SELF
Resolved object itself.
Definition: newgrf_spritegroup.h:100
GetNearbyIndustryTileInformation
uint32_t GetNearbyIndustryTileInformation(byte parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8)
Based on newhouses equivalent, but adapted for newindustries.
Definition: newgrf_industrytiles.cpp:34
CommandCost
Common return value for all commands.
Definition: command_type.h:23
IndustriesResolverObject
Resolver for industries.
Definition: newgrf_industries.h:42
CBID_NO_CALLBACK
@ CBID_NO_CALLBACK
Set when using the callback resolve system, but not to resolve a callback.
Definition: newgrf_callbacks.h:22
GetIndustryCallback
uint16_t GetIndustryCallback(CallbackID callback, uint32_t param1, uint32_t param2, Industry *industry, IndustryType type, TileIndex tile)
Perform an industry callback.
Definition: newgrf_industries.cpp:522
IndustriesScopeResolver
Resolver for industry scopes.
Definition: newgrf_industries.h:16
IndustryTemporarilyRefusesCargo
bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoID cargo_type)
Check whether an industry temporarily refuses to accept a certain cargo.
Definition: newgrf_industries.cpp:683
ResolverObject::GetScope
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
Definition: newgrf_spritegroup.cpp:135
TownScopeResolver
Scope resolver for a town.
Definition: newgrf_town.h:22
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
IndustryAvailabilityCallType
IndustryAvailabilityCallType
From where has callback CBID_INDUSTRY_PROBABILITY been called.
Definition: newgrf_industries.h:82
IACT_PROSPECTCREATION
@ IACT_PROSPECTCREATION
from the Fund/build using prospecting
Definition: newgrf_industries.h:86
IACT_USERCREATION
@ IACT_USERCREATION
from the Fund/build window
Definition: newgrf_industries.h:85
IndustriesScopeResolver::IndustriesScopeResolver
IndustriesScopeResolver(ResolverObject &ro, TileIndex tile, Industry *industry, IndustryType type, uint32_t random_bits=0)
Scope resolver for industries.
Definition: newgrf_industries.h:30
newgrf_town.h
INDUSTRY_TRIGGER_256_TICKS
@ INDUSTRY_TRIGGER_256_TICKS
Triggered (whole industry) each 256 ticks.
Definition: newgrf_industries.h:76
GrfSpecFeature
GrfSpecFeature
Definition: newgrf.h:66
ResolverObject::callback_param2
uint32_t callback_param2
Second parameter (var 18) of the callback.
Definition: newgrf_spritegroup.h:327
IACT_MAPGENERATION
@ IACT_MAPGENERATION
during random map generation
Definition: newgrf_industries.h:83
ResolverObject::callback
CallbackID callback
Callback being resolved.
Definition: newgrf_spritegroup.h:325
ResolverObject::callback_param1
uint32_t callback_param1
First parameter (var 10) of the callback.
Definition: newgrf_spritegroup.h:326
IndustriesScopeResolver::type
IndustryType type
Type of the industry.
Definition: newgrf_industries.h:19
IndustryProductionCallback
void IndustryProductionCallback(Industry *ind, int reason)
Get the industry production callback and apply it to the industry.
Definition: newgrf_industries.cpp:603
IndustriesScopeResolver::GetVariable
uint32_t GetVariable(byte variable, [[maybe_unused]] uint32_t parameter, bool *available) const override
Get a variable value.
Definition: newgrf_industries.cpp:159
IndustryTrigger
IndustryTrigger
When should the industry(tile) be triggered for random bits?
Definition: newgrf_industries.h:72
IndustriesResolverObject::GetScope
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0) override
Get a resolver for the scope.
Definition: newgrf_industries.h:52
ScopeResolver::ro
ResolverObject & ro
Surrounding resolver object.
Definition: newgrf_spritegroup.h:289
IndustriesResolverObject::GetDebugID
uint32_t GetDebugID() const override
Get an identifier for the item being resolved.
Definition: newgrf_industries.cpp:507
GetIndustryIDAtOffset
uint32_t GetIndustryIDAtOffset(TileIndex new_tile, const Industry *i, uint32_t cur_grfid)
Make an analysis of a tile and check for its belonging to the same industry, and/or the same grf file...
Definition: newgrf_industries.cpp:56
IndustriesResolverObject::industries_scope
IndustriesScopeResolver industries_scope
Scope resolver for the industry.
Definition: newgrf_industries.h:43
CheckIfCallBackAllowsCreation
CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, size_t layout, uint32_t seed, uint16_t initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type)
Check that the industry callback allows creation of the industry.
Definition: newgrf_industries.cpp:539