industry_map.h File Reference

Accessors to map for industries. More...

#include "industrytype.h"
#include "water_map.h"

Go to the source code of this file.

Functions
IndustryID	GetIndustryIndex (Tile t)
	Get the industry ID of the given tile.
bool	IsIndustryCompleted (Tile t)
	Is this industry tile fully built?
IndustryType	GetIndustryType (Tile tile)
	Retrieve the type for this industry.
void	SetIndustryCompleted (Tile tile)
	Set if the industry that owns the tile as under construction or not.
uint8_t	GetIndustryConstructionStage (Tile tile)
	Returns the industry construction stage of the specified tile.
void	SetIndustryConstructionStage (Tile tile, uint8_t value)
	Sets the industry construction stage of the specified tile.
IndustryGfx	GetCleanIndustryGfx (Tile t)
	Get the industry graphics ID for the given industry tile as stored in the without translation.
IndustryGfx	GetIndustryGfx (Tile t)
	Get the industry graphics ID for the given industry tile.
void	SetIndustryGfx (Tile t, IndustryGfx gfx)
	Set the industry graphics ID for the given industry tile.
uint8_t	GetIndustryConstructionCounter (Tile tile)
	Returns this industry tile's construction counter value.
void	SetIndustryConstructionCounter (Tile tile, uint8_t value)
	Sets this industry tile's construction counter value.
void	ResetIndustryConstructionStage (Tile tile)
	Reset the construction stage counter of the industry, as well as the completion bit.
uint8_t	GetIndustryAnimationLoop (Tile tile)
	Get the animation loop number.
void	SetIndustryAnimationLoop (Tile tile, uint8_t count)
	Set the animation loop number.
uint8_t	GetIndustryRandomBits (Tile tile)
	Get the random bits for this tile.
void	SetIndustryRandomBits (Tile tile, uint8_t bits)
	Set the random bits for this tile.
IndustryRandomTriggers	GetIndustryRandomTriggers (Tile tile)
	Get the activated triggers bits for this industry tile Used for grf callbacks.
void	SetIndustryRandomTriggers (Tile tile, IndustryRandomTriggers triggers)
	Set the activated triggers bits for this industry tile Used for grf callbacks.
void	MakeIndustry (Tile t, IndustryID index, IndustryGfx gfx, uint8_t random, WaterClass wc)
	Make the given tile an industry tile.

Detailed Description

Accessors to map for industries.

Definition in file industry_map.h.

Function Documentation

GetCleanIndustryGfx()

IndustryGfx GetCleanIndustryGfx ( Tile t )

inline

Get the industry graphics ID for the given industry tile as stored in the without translation.

Parameters

t	the tile to get the gfx for

Precondition

IsTileType(t, TileType::Industry)

Returns

the gfx ID

Definition at line 85 of file industry_map.h.

References GB(), Industry, IsTileType(), Tile::m5(), and Tile::m6().

Referenced by GetIndustryGfx(), and GetIndustryIDAtOffset().

GetIndustryAnimationLoop()

uint8_t GetIndustryAnimationLoop ( Tile tile )

inline

Get the animation loop number.

Parameters

tile	the tile to get the animation loop number of

Precondition

IsTileType(tile, TileType::Industry)

Returns

The loop/frame number.

Definition at line 160 of file industry_map.h.

References Industry, IsTileType(), and Tile::m4().

GetIndustryConstructionCounter()

uint8_t GetIndustryConstructionCounter ( Tile tile )

inline

Returns this industry tile's construction counter value.

Parameters

tile	the tile to query

Precondition

IsTileType(tile, TileType::Industry)

Returns

the construction counter

Definition at line 122 of file industry_map.h.

References GB(), Industry, IsTileType(), and Tile::m1().

GetIndustryConstructionStage()

uint8_t GetIndustryConstructionStage ( Tile tile )

inline

Returns the industry construction stage of the specified tile.

Parameters

tile	the tile to query

Precondition

IsTileType(tile, TileType::Industry)

Returns

the construction stage

Definition at line 60 of file industry_map.h.

References GB(), Industry, INDUSTRY_COMPLETED, IsIndustryCompleted(), IsTileType(), and Tile::m1().

Referenced by DrawTile_Industry(), and IndustryTileScopeResolver::GetVariable().

GetIndustryGfx()

IndustryGfx GetIndustryGfx ( Tile t )

inline

Get the industry graphics ID for the given industry tile.

Parameters

t	the tile to get the gfx for

Precondition

IsTileType(t, TileType::Industry)

Returns

the gfx ID

Definition at line 97 of file industry_map.h.

References GetCleanIndustryGfx(), GetTranslatedIndustryTileID(), Industry, and IsTileType().

Referenced by AddAcceptedCargo_Industry(), AfterLoadGame(), AnimateTile_Industry(), BubbleTick(), ClearTile_Industry(), DoTriggerIndustryTileRandomisation(), DrawTile_Industry(), NIHIndustryTile::GetBadges(), GetFoundation_Industry(), NIHIndustryTile::GetGRFID(), NIHIndustryTile::GetSpec(), IndustryTileScopeResolver::GetVariable(), NIHIndustryTile::IsInspectable(), NIHIndustryTile::Resolve(), TerraformTile_Industry(), and TileLoop_Industry().

GetIndustryIndex()

IndustryID GetIndustryIndex ( Tile t )

inline

Get the industry ID of the given tile.

Parameters

t	the tile to get the industry ID from

Precondition

IsTileType(t, TileType::Industry)

Returns

the industry ID

Definition at line 23 of file industry_map.h.

References Industry, IsTileType(), and Tile::m2().

Referenced by ClickTile_Industry(), DisasterTick_Aircraft(), Industry::GetByTile(), NIHIndustryTile::GetName(), GetNearbyIndustryTileInformation(), NIHIndustryTile::GetParent(), GetProductionAroundTiles(), IsWateredTile(), Station::RecomputeCatchment(), Station::RemoveFromAllNearbyLists(), Industry::TileBelongsToIndustry(), and Industry::~Industry().

GetIndustryRandomBits()

uint8_t GetIndustryRandomBits ( Tile tile )

inline

Get the random bits for this tile.

Used for grf callbacks

Parameters

tile	the tile to query

Precondition

IsTileType(tile, TileType::Industry)

Returns

requested bits

Definition at line 185 of file industry_map.h.

References Industry, IsTileType(), and Tile::m3().

Referenced by DoTriggerIndustryTileRandomisation(), IndustryTileScopeResolver::GetRandomBits(), and IndustriesScopeResolver::GetVariable().

GetIndustryRandomTriggers()

IndustryRandomTriggers GetIndustryRandomTriggers ( Tile tile )

inline

Get the activated triggers bits for this industry tile Used for grf callbacks.

Parameters

tile	the tile to query

Precondition

IsTileType(tile, TileType::Industry)

Returns

requested triggers

Definition at line 211 of file industry_map.h.

References GB(), Industry, IsTileType(), and Tile::m6().

Referenced by DoTriggerIndustryTileRandomisation(), and IndustryTileScopeResolver::GetRandomTriggers().

GetIndustryType()

IndustryType GetIndustryType

(

Tile

tile

)

Retrieve the type for this industry.

Although it is accessed by a tile, it will return the general type of industry, and not the sprite index as would do GetIndustryGfx.

Parameters

tile	that is queried

Precondition

IsTileType(tile, TileType::Industry)

Returns

general type for this industry, as defined in industry.h

Definition at line 110 of file industry_cmd.cpp.

References Industry::GetByTile(), Industry, IsTileType(), and Industry::type.

Referenced by AfterLoadGame(), and GenerateStationName().

IsIndustryCompleted()

bool IsIndustryCompleted ( Tile t )

inline

Is this industry tile fully built?

Parameters

t	the tile to analyze

Precondition

IsTileType(t, TileType::Industry)

Returns

true if and only if the industry tile is fully built

Definition at line 35 of file industry_map.h.

References HasBit(), Industry, IsTileType(), and Tile::m1().

Referenced by ChopLumberMillTrees(), GetIndustryConstructionStage(), GetTileDesc_Industry(), and TileLoop_Industry().

MakeIndustry()

void MakeIndustry ( Tile t, IndustryID index, IndustryGfx gfx, uint8_t random, WaterClass wc )

inline

Make the given tile an industry tile.

Parameters

t	the tile to make an industry tile
index	the industry this tile belongs to
gfx	the graphics to use for the tile
random	the random value
wc	the water class for this industry; only useful when build on water

Definition at line 239 of file industry_map.h.

References Industry, Tile::m1(), Tile::m2(), Tile::m4(), Tile::m6(), Tile::m7(), Tile::m8(), SB(), SetIndustryGfx(), SetIndustryRandomBits(), SetIndustryRandomTriggers(), SetTileType(), and SetWaterClass().

Referenced by DoCreateNewIndustry().

ResetIndustryConstructionStage()

void ResetIndustryConstructionStage ( Tile tile )

inline

Reset the construction stage counter of the industry, as well as the completion bit.

In fact, it is the same as restarting construction from the ground up.

Parameters

tile	the tile to query

Precondition

IsTileType(tile, TileType::Industry)

Definition at line 147 of file industry_map.h.

References Industry, IsTileType(), Tile::m1(), and SB().

Referenced by TileLoop_Industry().

SetIndustryAnimationLoop()

void SetIndustryAnimationLoop ( Tile tile, uint8_t count )

inline

Set the animation loop number.

Parameters

tile	the tile to set the animation loop number of
count	the new animation frame number

Precondition

IsTileType(tile, TileType::Industry)

Definition at line 172 of file industry_map.h.

References Industry, IsTileType(), and Tile::m4().

Referenced by TileLoop_Industry().

SetIndustryCompleted()

void SetIndustryCompleted ( Tile tile )

inline

Set if the industry that owns the tile as under construction or not.

Parameters

tile	the tile to query

Precondition

IsTileType(tile, TileType::Industry)

Definition at line 48 of file industry_map.h.

References Industry, IsTileType(), Tile::m1(), and SetBit().

Referenced by TileLoop_Industry().

SetIndustryConstructionCounter()

void SetIndustryConstructionCounter ( Tile tile, uint8_t value )

inline

Sets this industry tile's construction counter value.

Parameters

tile	the tile to query
value	the new value for the construction counter

Precondition

IsTileType(tile, TileType::Industry)

Definition at line 134 of file industry_map.h.

References Industry, IsTileType(), Tile::m1(), and SB().

Referenced by DoCreateNewIndustry().

SetIndustryConstructionStage()

void SetIndustryConstructionStage ( Tile tile, uint8_t value )

inline

Sets the industry construction stage of the specified tile.

Parameters

tile	the tile to query
value	the new construction stage

Precondition

IsTileType(tile, TileType::Industry)

Definition at line 72 of file industry_map.h.

References Industry, IsTileType(), Tile::m1(), and SB().

Referenced by DoCreateNewIndustry(), and TileLoop_Industry().

SetIndustryGfx()

void SetIndustryGfx ( Tile t, IndustryGfx gfx )

inline

Set the industry graphics ID for the given industry tile.

Parameters

t	the tile to set the gfx for

Precondition

IsTileType(t, TileType::Industry)

Parameters

gfx	the graphics ID

Definition at line 109 of file industry_map.h.

References GB(), Industry, IsTileType(), Tile::m5(), Tile::m6(), and SB().

Referenced by MakeIndustry(), and TileLoop_Industry().

SetIndustryRandomBits()

void SetIndustryRandomBits ( Tile tile, uint8_t bits )

inline

Set the random bits for this tile.

Used for grf callbacks

Parameters

tile	the tile to query
bits	the random bits

Precondition

IsTileType(tile, TileType::Industry)

Definition at line 198 of file industry_map.h.

References Industry, IsTileType(), and Tile::m3().

Referenced by DoTriggerIndustryTileRandomisation(), and MakeIndustry().

SetIndustryRandomTriggers()

void SetIndustryRandomTriggers ( Tile tile, IndustryRandomTriggers triggers )

inline

Set the activated triggers bits for this industry tile Used for grf callbacks.

Parameters

tile	the tile to query
triggers	the triggers to set

Precondition

IsTileType(tile, TileType::Industry)

Definition at line 225 of file industry_map.h.

References BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::base(), Industry, IsTileType(), Tile::m6(), and SB().

Referenced by DoTriggerIndustryTileRandomisation(), and MakeIndustry().