OpenTTD Source  12.0-beta2
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 
19  IndustryType type;
20  uint32 random_bits;
21 
32  {
33  }
34 
35  uint32 GetRandomBits() const override;
36  uint32 GetVariable(byte variable, uint32 parameter, bool *available) const override;
37  uint32 GetTriggers() const override;
38  void StorePSA(uint pos, int32 value) override;
39 };
40 
45 
46  IndustriesResolverObject(TileIndex tile, Industry *indus, IndustryType type, uint32 random_bits = 0,
49 
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 GetDebugID() const override;
69 };
70 
79 };
80 
87 };
88 
89 /* in newgrf_industry.cpp */
90 uint16 GetIndustryCallback(CallbackID callback, uint32 param1, uint32 param2, Industry *industry, IndustryType type, TileIndex tile);
91 uint32 GetIndustryIDAtOffset(TileIndex new_tile, const Industry *i, uint32 cur_grfid);
92 void IndustryProductionCallback(Industry *ind, int reason);
93 CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, size_t layout, uint32 seed, uint16 initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type);
94 uint32 GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32 default_prob);
95 bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoID cargo_type);
96 
97 IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id);
98 
99 /* in newgrf_industrytiles.cpp*/
100 uint32 GetNearbyIndustryTileInformation(byte parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8);
101 
102 #endif /* NEWGRF_INDUSTRIES_H */
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
INDUSTRY_TRIGGER_CARGO_DELIVERY
@ INDUSTRY_TRIGGER_CARGO_DELIVERY
Triggered on cargo delivery.
Definition: newgrf_industries.h:78
VarSpriteGroupScope
VarSpriteGroupScope
Definition: newgrf_spritegroup.h:97
GetIndustryCallback
uint16 GetIndustryCallback(CallbackID callback, uint32 param1, uint32 param2, Industry *industry, IndustryType type, TileIndex tile)
Perform an industry callback.
Definition: newgrf_industries.cpp:521
ResolverObject::callback_param1
uint32 callback_param1
First parameter (var 10) of the callback.
Definition: newgrf_spritegroup.h:326
IndustriesScopeResolver::tile
TileIndex tile
Tile owned by the industry.
Definition: newgrf_industries.h:17
IndustriesScopeResolver::GetTriggers
uint32 GetTriggers() const override
Get the triggers.
Definition: newgrf_industries.cpp:422
GetNearbyIndustryTileInformation
uint32 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
IndustriesResolverObject::GetTown
TownScopeResolver * GetTown()
Get or create the town scope object associated with the industry.
Definition: newgrf_industries.cpp:484
GetIndustryIDAtOffset
uint32 GetIndustryIDAtOffset(TileIndex new_tile, const Industry *i, uint32 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:55
IACT_RANDOMCREATION
@ IACT_RANDOMCREATION
during creation of random ingame industry
Definition: newgrf_industries.h:84
IndustriesScopeResolver::StorePSA
void StorePSA(uint pos, int32 value) override
Store a value into the persistent storage area (PSA).
Definition: newgrf_industries.cpp:427
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::GetDebugID
uint32 GetDebugID() const override
Get an identifier for the item being resolved.
Definition: newgrf_industries.cpp:506
IndustriesResolverObject::GetFeature
GrfSpecFeature GetFeature() const override
Get the feature number being resolved for.
Definition: newgrf_industries.cpp:501
IndustriesResolverObject::town_scope
TownScopeResolver * town_scope
Scope resolver for the associated town (if needed and available, else nullptr).
Definition: newgrf_industries.h:44
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:66
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
ResolverObject::callback_param2
uint32 callback_param2
Second parameter (var 18) of the callback.
Definition: newgrf_spritegroup.h:327
IndustriesScopeResolver::random_bits
uint32 random_bits
Random bits of the new industry.
Definition: newgrf_industries.h:20
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
IndustriesScopeResolver
Resolver for industry scopes.
Definition: newgrf_industries.h:16
MapNewGRFIndustryType
IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id)
Map the GRF local type to an industry type.
Definition: newgrf_industries.cpp:39
GetIndustryProbabilityCallback
uint32 GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32 default_prob)
Check with callback CBID_INDUSTRY_PROBABILITY whether the industry can be built.
Definition: newgrf_industries.cpp:569
IndustryTemporarilyRefusesCargo
bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoID cargo_type)
Check whether an industry temporarily refuses to accept a certain cargo.
Definition: newgrf_industries.cpp:680
ResolverObject::GetScope
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
Definition: newgrf_spritegroup.cpp:139
TownScopeResolver
Scope resolver for a town.
Definition: newgrf_town.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::GetRandomBits
uint32 GetRandomBits() const override
Get a few random bits.
Definition: newgrf_industries.cpp:417
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
IndustriesScopeResolver::IndustriesScopeResolver
IndustriesScopeResolver(ResolverObject &ro, TileIndex tile, Industry *industry, IndustryType type, uint32 random_bits=0)
Scope resolver for industries.
Definition: newgrf_industries.h:30
IndustriesScopeResolver::GetVariable
uint32 GetVariable(byte variable, uint32 parameter, bool *available) const override
Get a variable value.
Definition: newgrf_industries.cpp:158
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
IndustriesResolverObject::IndustriesResolverObject
IndustriesResolverObject(TileIndex tile, Industry *indus, IndustryType type, uint32 random_bits=0, CallbackID callback=CBID_NO_CALLBACK, uint32 callback_param1=0, uint32 callback_param2=0)
Constructor of the industries resolver.
Definition: newgrf_industries.cpp:466
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:602
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
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
CheckIfCallBackAllowsCreation
CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, size_t layout, uint32 seed, uint16 initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type)
Check that the industry callback allows creation of the industry.
Definition: newgrf_industries.cpp:538
ScopeResolver::ro
ResolverObject & ro
Surrounding resolver object.
Definition: newgrf_spritegroup.h:289
IndustriesResolverObject::industries_scope
IndustriesScopeResolver industries_scope
Scope resolver for the industry.
Definition: newgrf_industries.h:43