OpenTTD
newgrf_industrytiles.h
Go to the documentation of this file.
1 /* $Id: newgrf_industrytiles.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_INDUSTRYTILES_H
13 #define NEWGRF_INDUSTRYTILES_H
14 
15 #include "newgrf_animation_type.h"
16 #include "newgrf_industries.h"
17 #include "core/random_func.hpp"
18 
23 
31  : ScopeResolver(ro), industry(industry), tile(tile)
32  {
33  }
34 
35  /* virtual */ uint32 GetRandomBits() const;
36  /* virtual */ uint32 GetVariable(byte variable, uint32 parameter, bool *available) const;
37  /* virtual */ uint32 GetTriggers() const;
38 };
39 
44 
45  IndustryTileResolverObject(IndustryGfx gfx, TileIndex tile, Industry *indus,
46  CallbackID callback = CBID_NO_CALLBACK, uint32 callback_param1 = 0, uint32 callback_param2 = 0);
47 
48  /* virtual */ ScopeResolver *GetScope(VarSpriteGroupScope scope = VSG_SCOPE_SELF, byte relative = 0)
49  {
50  switch (scope) {
51  case VSG_SCOPE_SELF: return &indtile_scope;
52  case VSG_SCOPE_PARENT: return &ind_scope;
53  default: return ResolverObject::GetScope(scope, relative);
54  }
55  }
56 };
57 
58 bool DrawNewIndustryTile(TileInfo *ti, Industry *i, IndustryGfx gfx, const IndustryTileSpec *inds);
59 uint16 GetIndustryTileCallback(CallbackID callback, uint32 param1, uint32 param2, IndustryGfx gfx_id, Industry *industry, TileIndex tile);
60 CommandCost PerformIndustryTileSlopeCheck(TileIndex ind_base_tile, TileIndex ind_tile, const IndustryTileSpec *its, IndustryType type, IndustryGfx gfx, uint itspec_index, uint16 initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type);
61 
62 void AnimateNewIndustryTile(TileIndex tile);
63 bool StartStopIndustryTileAnimation(TileIndex tile, IndustryAnimationTrigger iat, uint32 random = Random());
64 bool StartStopIndustryTileAnimation(const Industry *ind, IndustryAnimationTrigger iat);
65 
66 
72 };
74 void TriggerIndustry(Industry *ind, IndustryTileTrigger trigger);
75 
76 #endif /* NEWGRF_INDUSTRYTILES_H */
Interface to query and set values specific to a single VarSpriteGroupScope (action 2 scope)...
Tile information, used while rendering the tile.
Definition: tile_cmd.h:44
IndustryAnimationTrigger
Animation triggers of the industries.
Resolver for the industry tiles scope.
ResolverObject & ro
Surrounding resolver object.
VarSpriteGroupScope
ScopeResolver * GetScope(VarSpriteGroupScope scope=VSG_SCOPE_SELF, byte relative=0)
Get a resolver for the scope.
Cargo has been delivered.
Functions for NewGRF industries.
Interface for SpriteGroup-s to access the gamestate.
Definitions related to NewGRF animation.
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.
CommandCost PerformIndustryTileSlopeCheck(TileIndex ind_base_tile, TileIndex ind_tile, const IndustryTileSpec *its, IndustryType type, IndustryGfx gfx, uint itspec_index, uint16 initial_random_bits, Owner founder, IndustryAvailabilityCallType creation_type)
Check the slope of a tile of a new industry.
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:25
Pseudo random number generator.
Resolver for industry scopes.
Resolver for industry tiles.
IndustryTileTrigger
Available industry tile triggers.
uint32 GetRandomBits() const
Get a few random bits.
void TriggerIndustry(Industry *ind, IndustryTileTrigger trigger)
Trigger a random trigger for all industry tiles.
uint32 GetVariable(byte variable, uint32 parameter, bool *available) const
Get a variable value.
IndustryTileScopeResolver indtile_scope
Scope resolver for the industry tile.
IndustryAvailabilityCallType
From where has callback CBID_INDUSTRY_PROBABILITY been called.
Industry * industry
Industry owning the tiles.
Resolved object itself.
IndustriesScopeResolver ind_scope
Scope resolver for the industry owning the tile.
TileIndex tile
Tile being resolved.
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
Related object of the resolved one.
IndustryTileScopeResolver(ResolverObject &ro, Industry *industry, TileIndex tile)
Constructor of the scope resolver for the industry tile.
CallbackID
List of implemented NewGRF callbacks.
Defines the data structure of each individual tile of an industry.
Definition: industrytype.h:148
Owner
Enum for all companies/owners.
Definition: company_type.h:20
The tile of the industry has been triggered during the tileloop.
uint32 GetTriggers() const
Get the triggers.
void TriggerIndustryTile(TileIndex t, IndustryTileTrigger trigger)
Trigger a random trigger for a single industry tile.
The industry has been triggered via its tick.