newgrf_canal.h File Reference

Handling of NewGRF canals. More...

#include "newgrf.h"
#include "newgrf_callbacks.h"
#include "tile_type.h"

Go to the source code of this file.

Data Structures
struct	WaterFeature
	Information about a water feature. More...

Functions
SpriteID	GetCanalSprite (CanalFeature feature, TileIndex tile)
	Lookup the base sprite to use for a canal.
uint	GetCanalSpriteOffset (CanalFeature feature, TileIndex tile, uint cur_offset)
	Get the new sprite offset for a water tile.

Variables
EnumIndexArray< WaterFeature, CanalFeature, CanalFeature::End >	_water_feature
	Table of canal 'feature' sprite groups.

Detailed Description

Handling of NewGRF canals.

Definition in file newgrf_canal.h.

Function Documentation

GetCanalSprite()

SpriteID GetCanalSprite	(	CanalFeature	feature,
		TileIndex	tile )

Lookup the base sprite to use for a canal.

Parameters

feature	Which canal feature we want.
tile	Tile index of canal, if appropriate.

Returns

Base sprite returned by GRF, or 0 if none.

Definition at line 139 of file newgrf_canal.cpp.

Referenced by DrawCanalWater(), DrawTile_Station(), DrawWaterEdges(), and DrawWaterLock().

GetCanalSpriteOffset()

uint GetCanalSpriteOffset	(	CanalFeature	feature,
		TileIndex	tile,
		uint	cur_offset )

Get the new sprite offset for a water tile.

Parameters

tile	Tile index of the canal/water tile.
feature	For which feature to get the new sprite offset.
cur_offset	Current sprite offset.

Returns

New sprite offset.

Definition at line 171 of file newgrf_canal.cpp.

References _water_feature, CALLBACK_FAILED, CBID_CANALS_SPRITE_OFFSET, GetCanalCallback(), and SpriteOffset.

Referenced by DrawWaterSprite(), and DrawWaterTileStruct().

Variable Documentation

_water_feature

EnumIndexArray<WaterFeature, CanalFeature, CanalFeature::End> _water_feature

extern

Table of canal 'feature' sprite groups.

Definition at line 20 of file newgrf_canal.cpp.

Referenced by CanalResolverObject::CanalResolverObject(), DrawCanalWater(), DrawWaterLock(), FinaliseCanals(), GetCanalSpriteOffset(), CanalMapSpriteGroupHandler::MapDefault(), and ResetNewGRFData().