OpenTTD
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 
30  IndustriesScopeResolver(ResolverObject &ro, TileIndex tile, Industry *industry, IndustryType type, uint32 random_bits = 0)
31  : ScopeResolver(ro), tile(tile), industry(industry), type(type), random_bits(random_bits)
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,
47  CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
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 
76 };
77 
84 };
85 
86 /* in newgrf_industry.cpp */
87 uint16 GetIndustryCallback(CallbackID callback, uint32 param1, uint32 param2, Industry *industry, IndustryType type, TileIndex tile);
88 uint32 GetIndustryIDAtOffset(TileIndex new_tile, const Industry *i, uint32 cur_grfid);
89 void IndustryProductionCallback(Industry *ind, int reason);
90 CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, size_t layout, uint32 seed, uint16 initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type);
91 uint32 GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32 default_prob);
92 bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoID cargo_type);
93 
94 IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id);
95 
96 /* in newgrf_industrytiles.cpp*/
97 uint32 GetNearbyIndustryTileInformation(byte parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8);
98 
99 #endif /* NEWGRF_INDUSTRIES_H */
Owner
Enum for all companies/owners.
Definition: company_type.h:18
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope)...
void IndustryProductionCallback(Industry *ind, int reason)
Get the industry production callback and apply it to the industry.
uint16 GetIndustryCallback(CallbackID callback, uint32 param1, uint32 param2, Industry *industry, IndustryType type, TileIndex tile)
Perform an industry callback.
IndustryTrigger
When should the industry(tile) be triggered for random bits?
uint32 GetRandomBits() const override
Get a few random bits.
ResolverObject & ro
Surrounding resolver object.
VarSpriteGroupScope
from the Fund/build using prospecting
Interface for SpriteGroup-s to access the gamestate.
uint32 GetTriggers() const override
Get the triggers.
TownScopeResolver * town_scope
Scope resolver for the associated town (if needed and available, else nullptr).
from the Fund/build window
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0) override
Get a resolver for the scope.
Defines the internal data of a functional industry.
Definition: industry.h:40
Set when using the callback resolve system, but not to resolve a callback.
uint32 GetNearbyIndustryTileInformation(byte parameter, TileIndex tile, IndustryID index, bool signed_offsets, bool grf_version8)
Based on newhouses equivalent, but adapted for newindustries.
virtual ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
Common return value for all commands.
Definition: command_type.h:23
Triggered (whole industry) each 256 ticks.
uint32 GetVariable(byte variable, uint32 parameter, bool *available) const override
Get a variable value.
Resolver for industry scopes.
uint32 GetIndustryProbabilityCallback(IndustryType type, IndustryAvailabilityCallType creation_type, uint32 default_prob)
Check with callback CBID_INDUSTRY_PROBABILITY whether the industry can be built.
during random map generation
IndustryType MapNewGRFIndustryType(IndustryType grf_type, uint32 grf_id)
Map the GRF local type to an industry type.
Scope resolver for a town.
Definition: newgrf_town.h:22
IndustryType type
Type of the industry.
void StorePSA(uint pos, int32 value) override
Store a value into the persistent storage area (PSA).
IndustryAvailabilityCallType
From where has callback CBID_INDUSTRY_PROBABILITY been called.
IndustriesScopeResolver(ResolverObject &ro, TileIndex tile, Industry *industry, IndustryType type, uint32 random_bits=0)
Scope resolver for industries.
Resolved object itself.
during creation of random ingame industry
Triggered on cargo delivery.
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
Related object of the resolved one.
bool IndustryTemporarilyRefusesCargo(Industry *ind, CargoID cargo_type)
Check whether an industry temporarily refuses to accept a certain cargo.
Resolver for industries.
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...
CallbackID
List of implemented NewGRF callbacks.
Triggered each tile loop.
Functions to handle the town part of NewGRF towns.
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:20
uint32 random_bits
Random bits of the new industry.
Industry * industry
Industry being resolved.
IndustriesScopeResolver industries_scope
Scope resolver for the industry.
TileIndex tile
Tile owned by the industry.
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.