OpenTTD
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 
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 
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);
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 
78 };
79 
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 */
CommandCost CheckIfCallBackAllowsCreation(TileIndex tile, IndustryType type, uint layout, uint32 seed, uint16 initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type)
Check that the industry callback allows creation of the industry.
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope)...
uint32 GetTriggers() const
Get the triggers.
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?
ResolverObject & ro
Surrounding resolver object.
VarSpriteGroupScope
from the Fund/build using prospecting
Interface for SpriteGroup-s to access the gamestate.
TownScopeResolver * town_scope
Scope resolver for the associated town (if needed and available, else NULL).
from the Fund/build window
Defines the internal data of a functional industry.
Definition: industry.h:39
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.
uint32 GetVariable(byte variable, uint32 parameter, bool *available) const
Get a variable value.
Common return value for all commands.
Definition: command_type.h:25
Triggered (whole industry) each 256 ticks.
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:24
IndustryType type
Type of the industry.
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:80
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 GetRandomBits() const
Get a few random bits.
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:22
Owner
Enum for all companies/owners.
Definition: company_type.h:20
uint32 random_bits
Random bits of the new industry.
void StorePSA(uint pos, int32 value)
Store a value into the persistent storage area (PSA).
Industry * industry
Industry being resolved.
IndustriesScopeResolver industries_scope
Scope resolver for the industry.
TileIndex tile
Tile owned by the industry.
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.