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/>.
10 /** @file newgrf_industries.h Functions for NewGRF industries. */
12 #ifndef NEWGRF_INDUSTRIES_H
13 #define NEWGRF_INDUSTRIES_H
15 #include "newgrf_town.h"
17 /** Resolver for industry scopes. */
18 struct IndustriesScopeResolver
: public ScopeResolver
{
19 TileIndex tile
; ///< Tile owned by the industry.
20 Industry
*industry
; ///< %Industry being resolved.
21 IndustryType type
; ///< Type of the industry.
22 uint32 random_bits
; ///< Random bits of the new industry.
24 IndustriesScopeResolver(ResolverObject
*ro
, TileIndex tile
, Industry
*industry
, IndustryType type
, uint32 random_bits
= 0);
26 /* virtual */ uint32
GetRandomBits() const;
27 /* virtual */ uint32
GetVariable(byte variable
, uint32 parameter
, bool *available
) const;
28 /* virtual */ uint32
GetTriggers() const;
29 /* virtual */ void SetTriggers(int triggers
) const;
30 /* virtual */ void StorePSA(uint pos
, int32 value
);
33 /** Resolver for industries. */
34 struct IndustriesResolverObject
: public ResolverObject
{
35 IndustriesScopeResolver industries_scope
; ///< Scope resolver for the industry.
36 TownScopeResolver
*town_scope
; ///< Scope resolver for the associated town (if needed and available, else \c NULL).
38 IndustriesResolverObject(TileIndex tile
, Industry
*indus
, IndustryType type
, uint32 random_bits
= 0,
39 CallbackID callback
= CBID_NO_CALLBACK
, uint32 callback_param1
= 0, uint32 callback_param2
= 0);
40 ~IndustriesResolverObject();
42 TownScopeResolver
*GetTown();
44 /* virtual */ ScopeResolver
*GetScope(VarSpriteGroupScope scope
= VSG_SCOPE_SELF
, byte relative
= 0)
47 case VSG_SCOPE_SELF
: return &industries_scope
;
48 case VSG_SCOPE_PARENT
: {
49 TownScopeResolver
*tsr
= this->GetTown();
50 if (tsr
!= NULL
) return tsr
;
53 default: return ResolverObject::GetScope(scope
, relative
);
58 /** When should the industry(tile) be triggered for random bits? */
59 enum IndustryTrigger
{
60 /** Triggered each tile loop */
61 INDUSTRY_TRIGGER_TILELOOP_PROCESS
= 1,
62 /** Triggered (whole industry) each 256 ticks */
63 INDUSTRY_TRIGGER_256_TICKS
= 2,
64 /** Triggered on cargo delivery */
65 INDUSTRY_TRIGGER_CARGO_DELIVERY
= 4,
68 /** From where has callback #CBID_INDUSTRY_PROBABILITY been called */
69 enum IndustryAvailabilityCallType
{
70 IACT_MAPGENERATION
, ///< during random map generation
71 IACT_RANDOMCREATION
, ///< during creation of random ingame industry
72 IACT_USERCREATION
, ///< from the Fund/build window
73 IACT_PROSPECTCREATION
, ///< from the Fund/build using prospecting
76 /* in newgrf_industry.cpp */
77 uint16
GetIndustryCallback(CallbackID callback
, uint32 param1
, uint32 param2
, Industry
*industry
, IndustryType type
, TileIndex tile
);
78 uint32
GetIndustryIDAtOffset(TileIndex new_tile
, const Industry
*i
, uint32 cur_grfid
);
79 void IndustryProductionCallback(Industry
*ind
, int reason
);
80 CommandCost
CheckIfCallBackAllowsCreation(TileIndex tile
, IndustryType type
, uint layout
, uint32 seed
, uint16 initial_random_bits
, Owner founder
, IndustryAvailabilityCallType creation_type
);
81 uint32
GetIndustryProbabilityCallback(IndustryType type
, IndustryAvailabilityCallType creation_type
, uint32 default_prob
);
82 bool IndustryTemporarilyRefusesCargo(Industry
*ind
, CargoID cargo_type
);
84 IndustryType
MapNewGRFIndustryType(IndustryType grf_type
, uint32 grf_id
);
86 /* in newgrf_industrytiles.cpp*/
87 uint32
GetNearbyIndustryTileInformation(byte parameter
, TileIndex tile
, IndustryID index
, bool signed_offsets
, bool grf_version8
);
89 #endif /* NEWGRF_INDUSTRIES_H */