OpenTTD Source: src/newgrf_industries.h Source File

OpenTTD Source 15.0-RC2

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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
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(uint8_t variable, [[maybe_unused]] uint32_t parameter, bool &available) const override;
37 uint32_t GetRandomTriggers() const override;
38 void StorePSA(uint pos, int32_t value) override;
39};
40
42 struct IndustriesResolverObject : public ResolverObject {
43 IndustriesScopeResolver industries_scope;
44 std::optional<TownScopeResolver> town_scope = std::nullopt;
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
49 TownScopeResolver *GetTown();
50
51 ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, uint8_t relative = 0) override
52 {
53 switch (scope) {
54 case VSG_SCOPE_SELF: return &industries_scope;
55 case VSG_SCOPE_PARENT: {
56 TownScopeResolver *tsr = this->GetTown();
57 if (tsr != nullptr) return tsr;
58 }
59 [[fallthrough]];
60
61 default:
62 return ResolverObject::GetScope(scope, relative);
63 }
64 }
65
66 GrfSpecFeature GetFeature() const override;
67 uint32_t GetDebugID() const override;
68};
69
71 enum IndustryTrigger : uint8_t {
73 INDUSTRY_TRIGGER_TILELOOP_PROCESS = 1,
75 INDUSTRY_TRIGGER_256_TICKS = 2,
77 INDUSTRY_TRIGGER_CARGO_DELIVERY = 4,
78};
79
81 enum IndustryAvailabilityCallType : uint8_t {
82 IACT_MAPGENERATION,
83 IACT_RANDOMCREATION,
84 IACT_USERCREATION,
85 IACT_PROSPECTCREATION,
86};
87
88/* in newgrf_industry.cpp */
89uint16_t GetIndustryCallback(CallbackID callback, uint32_t param1, uint32_t param2, Industry *industry, IndustryType type, TileIndex tile, std::span<int32_t> regs100 = {});
90uint32_t GetIndustryIDAtOffset(TileIndex new_tile, const Industry *i, uint32_t cur_grfid);
91void IndustryProductionCallback(Industry *ind, int reason);
92 CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, size_t layout, uint32_t seed, uint16_t initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type);
93uint32_t GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32_t default_prob);
94bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoType cargo_type);
95
96IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32_t grf_id);
97
98/* in newgrf_industrytiles.cpp*/
99uint32_t GetNearbyIndustryTileInformation(uint8_t parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8);
100
101#endif /* NEWGRF_INDUSTRIES_H */
CargoType
uint8_t CargoType
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:21
CommandCost
Common return value for all commands.
Definition command_type.h:24
GrfSpecFeature
GrfSpecFeature
Definition newgrf.h:68
CallbackID
CallbackID
List of implemented NewGRF callbacks.
Definition newgrf_callbacks.h:22
CBID_NO_CALLBACK
@ CBID_NO_CALLBACK
Set when using the callback resolve system, but not to resolve a callback.
Definition newgrf_callbacks.h:24
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:57
MapNewGRFIndustryType
IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32_t grf_id)
Map the GRF local type to an industry type.
Definition newgrf_industries.cpp:41
IndustryTrigger
IndustryTrigger
When should the industry(tile) be triggered for random bits?
Definition newgrf_industries.h:71
INDUSTRY_TRIGGER_256_TICKS
@ INDUSTRY_TRIGGER_256_TICKS
Triggered (whole industry) each 256 ticks.
Definition newgrf_industries.h:75
INDUSTRY_TRIGGER_CARGO_DELIVERY
@ INDUSTRY_TRIGGER_CARGO_DELIVERY
Triggered on cargo delivery.
Definition newgrf_industries.h:77
INDUSTRY_TRIGGER_TILELOOP_PROCESS
@ INDUSTRY_TRIGGER_TILELOOP_PROCESS
Triggered each tile loop.
Definition newgrf_industries.h:73
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:545
IndustryAvailabilityCallType
IndustryAvailabilityCallType
From where has callback CBID_INDUSTRY_PROBABILITY been called.
Definition newgrf_industries.h:81
IACT_USERCREATION
@ IACT_USERCREATION
from the Fund/build window
Definition newgrf_industries.h:84
IACT_RANDOMCREATION
@ IACT_RANDOMCREATION
during creation of random ingame industry
Definition newgrf_industries.h:83
IACT_MAPGENERATION
@ IACT_MAPGENERATION
during random map generation
Definition newgrf_industries.h:82
IACT_PROSPECTCREATION
@ IACT_PROSPECTCREATION
from the Fund/build using prospecting
Definition newgrf_industries.h:85
IndustryProductionCallback
void IndustryProductionCallback(Industry *ind, int reason)
Get the industry production callback and apply it to the industry.
Definition newgrf_industries.cpp:605
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:577
GetIndustryCallback
uint16_t GetIndustryCallback(CallbackID callback, uint32_t param1, uint32_t param2, Industry *industry, IndustryType type, TileIndex tile, std::span< int32_t > regs100={})
Perform an industry callback.
Definition newgrf_industries.cpp:528
IndustryTemporarilyRefusesCargo
bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoType cargo_type)
Check whether an industry temporarily refuses to accept a certain cargo.
Definition newgrf_industries.cpp:687
GetNearbyIndustryTileInformation
uint32_t GetNearbyIndustryTileInformation(uint8_t parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8)
Based on newhouses equivalent, but adapted for newindustries.
Definition newgrf_industrytiles.cpp:35
VarSpriteGroupScope
VarSpriteGroupScope
Definition newgrf_spritegroup.h:82
VSG_SCOPE_SELF
@ VSG_SCOPE_SELF
Resolved object itself.
Definition newgrf_spritegroup.h:85
VSG_SCOPE_PARENT
@ VSG_SCOPE_PARENT
Related object of the resolved one.
Definition newgrf_spritegroup.h:86
newgrf_town.h
Functions to handle the town part of NewGRF towns.
IndustriesResolverObject
Resolver for industries.
Definition newgrf_industries.h:42
IndustriesResolverObject::town_scope
std::optional< TownScopeResolver > town_scope
Scope resolver for the associated town (if needed and available, else std::nullopt).
Definition newgrf_industries.h:44
IndustriesResolverObject::GetTown
TownScopeResolver * GetTown()
Get or create the town scope object associated with the industry.
Definition newgrf_industries.cpp:490
IndustriesResolverObject::GetFeature
GrfSpecFeature GetFeature() const override
Get the feature number being resolved for.
Definition newgrf_industries.cpp:507
IndustriesResolverObject::GetScope
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0) override
Get a resolver for the scope.
Definition newgrf_industries.h:51
IndustriesResolverObject::GetDebugID
uint32_t GetDebugID() const override
Get an identifier for the item being resolved.
Definition newgrf_industries.cpp:512
IndustriesResolverObject::industries_scope
IndustriesScopeResolver industries_scope
Scope resolver for the industry.
Definition newgrf_industries.h:43
IndustriesScopeResolver
Resolver for industry scopes.
Definition newgrf_industries.h:16
IndustriesScopeResolver::GetRandomTriggers
uint32_t GetRandomTriggers() const override
Get the triggers.
Definition newgrf_industries.cpp:435
IndustriesScopeResolver::type
IndustryType type
Type of the industry.
Definition newgrf_industries.h:19
IndustriesScopeResolver::random_bits
uint32_t random_bits
Random bits of the new industry.
Definition newgrf_industries.h:20
IndustriesScopeResolver::GetVariable
uint32_t GetVariable(uint8_t variable, uint32_t parameter, bool &available) const override
Get a variable value.
Definition newgrf_industries.cpp:165
IndustriesScopeResolver::GetRandomBits
uint32_t GetRandomBits() const override
Get a few random bits.
Definition newgrf_industries.cpp:430
IndustriesScopeResolver::StorePSA
void StorePSA(uint pos, int32_t value) override
Store a value into the persistent storage area (PSA).
Definition newgrf_industries.cpp:440
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
IndustriesScopeResolver::tile
TileIndex tile
Tile owned by the industry.
Definition newgrf_industries.h:17
IndustriesScopeResolver::industry
Industry * industry
Industry being resolved.
Definition newgrf_industries.h:18
Industry
Defines the internal data of a functional industry.
Definition industry.h:62
PoolID< uint8_t, struct CompanyIDTag, 0xF, 0xFF >
ResolverObject
Interface for SpriteGroup-s to access the gamestate.
Definition newgrf_spritegroup.h:288
ResolverObject::callback_param2
uint32_t callback_param2
Second parameter (var 18) of the callback.
Definition newgrf_spritegroup.h:342
ResolverObject::callback
CallbackID callback
Callback being resolved.
Definition newgrf_spritegroup.h:340
ResolverObject::callback_param1
uint32_t callback_param1
First parameter (var 10) of the callback.
Definition newgrf_spritegroup.h:341
ResolverObject::GetScope
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, uint8_t relative=0)
Get a resolver for the scope.
Definition newgrf_spritegroup.cpp:133
ScopeResolver
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope).
Definition newgrf_spritegroup.h:269
ScopeResolver::ro
ResolverObject & ro
Surrounding resolver object.
Definition newgrf_spritegroup.h:270
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
TownScopeResolver
Scope resolver for a town.
Definition newgrf_town.h:22