Handling of NewGRF road stops. More...

#include "stdafx.h"
#include "debug.h"
#include "station_base.h"
#include "roadstop_base.h"
#include "newgrf_badge.h"
#include "newgrf_roadstop.h"
#include "newgrf_cargo.h"
#include "newgrf_roadtype.h"
#include "gfx_type.h"
#include "company_func.h"
#include "road.h"
#include "window_type.h"
#include "timer/timer_game_calendar.h"
#include "town.h"
#include "tile_cmd.h"
#include "viewport_func.h"
#include "newgrf_animation_base.h"
#include "newgrf_sound.h"
#include "table/strings.h"
#include "newgrf_class_func.h"
#include "safeguards.h"

Data Structures
struct	RoadStopAnimationFrameAnimationHelper
struct	RoadStopAnimationBase
	Helper class for animation control. More...

Functions
uint16_t	GetRoadStopCallback (CallbackID callback, uint32_t param1, uint32_t param2, const RoadStopSpec roadstopspec, BaseStation st, TileIndex tile, RoadType roadtype, StationType type, uint8_t view, std::span< int32_t > regs100)
void	DrawRoadStopTile (int x, int y, RoadType roadtype, const RoadStopSpec *spec, StationType type, int view)
	Draw representation of a road stop tile for GUI purposes.
std::optional< SpriteLayoutProcessor >	GetRoadStopLayout (TileInfo ti, const RoadStopSpec spec, BaseStation *st, StationType type, int view, std::span< int32_t > regs100)
uint16_t	GetAnimRoadStopCallback (CallbackID callback, uint32_t param1, uint32_t param2, const RoadStopSpec roadstopspec, BaseStation st, TileIndex tile, int)
	Perform the road stop callback in the context of the AnimationBase callback.
void	AnimateRoadStopTile (TileIndex tile)
void	TriggerRoadStopAnimation (BaseStation *st, TileIndex trigger_tile, StationAnimationTrigger trigger, CargoType cargo_type)
void	TriggerRoadStopRandomisation (BaseStation *st, TileIndex tile, StationRandomTrigger trigger, CargoType cargo_type)
	Trigger road stop randomisation.
bool	GetIfNewStopsByType (RoadStopType rs, RoadType roadtype)
	Checks if there's any new stations by a specific RoadStopType.
bool	GetIfClassHasNewStopsByType (const RoadStopClass *roadstopclass, RoadStopType rs, RoadType roadtype)
	Checks if the given RoadStopClass has any specs assigned to it, compatible with the given RoadStopType.
bool	GetIfStopIsForType (const RoadStopSpec *roadstopspec, RoadStopType rs, RoadType roadtype)
	Checks if the given RoadStopSpec is compatible with the given RoadStopType.
const RoadStopSpec *	GetRoadStopSpec (TileIndex t)
std::optional< uint8_t >	AllocateSpecToRoadStop (const RoadStopSpec spec, BaseStation st)
	Allocate a RoadStopSpec to a Station.
void	AssignSpecToRoadStop (const RoadStopSpec spec, BaseStation st, uint8_t specindex)
	Assign a previously allocated RoadStopSpec specindex to a Station.
void	DeallocateSpecFromRoadStop (BaseStation *st, uint8_t specindex)
	Deallocate a RoadStopSpec from a Station.
void	RoadStopUpdateCachedTriggers (BaseStation *st)
	Update the cached animation trigger bitmask for a station.

Variables
static const uint	NUM_ROADSTOPSPECS_PER_STATION = 63
	Maximum number of parts per station.

Detailed Description

Handling of NewGRF road stops.

Definition in file newgrf_roadstop.cpp.

Function Documentation

◆ AllocateSpecToRoadStop()

std::optional< uint8_t > AllocateSpecToRoadStop	(	const RoadStopSpec *	spec,
		BaseStation *	st )

Allocate a RoadStopSpec to a Station.

This is called once per build operation.

Parameters

spec	RoadStopSpec to allocate.
st	Station to allocate it to.

Returns: Index within the Station's road stop spec list, or std::nullopt if the allocation failed.

Definition at line 599 of file newgrf_roadstop.cpp.

References NUM_ROADSTOPSPECS_PER_STATION, and BaseStation::roadstop_speclist.

Referenced by CmdBuildRoadStop(), and CmdBuildRoadWaypoint().

◆ AnimateRoadStopTile()

void AnimateRoadStopTile ( TileIndex tile )

Definition at line 389 of file newgrf_roadstop.cpp.

◆ AssignSpecToRoadStop()

void AssignSpecToRoadStop	(	const RoadStopSpec *	spec,
		BaseStation *	st,
		uint8_t	specindex )

Assign a previously allocated RoadStopSpec specindex to a Station.

Parameters

spec	RoadStopSpec to assign..
st	Station to allocate it to.
specindex	Spec index of allocation.

Definition at line 632 of file newgrf_roadstop.cpp.

References RoadStopSpec::grf_prop, GRFFilePropsBase::grfid, GRFFilePropsBase::local_id, BaseStation::roadstop_speclist, and RoadStopUpdateCachedTriggers().

Referenced by CmdBuildRoadStop(), and CmdBuildRoadWaypoint().

◆ DeallocateSpecFromRoadStop()

void DeallocateSpecFromRoadStop	(	BaseStation *	st,
		uint8_t	specindex )

Deallocate a RoadStopSpec from a Station.

Called when removing a single roadstop tile.

Parameters

st	Station to work with.
specindex	Index of the custom roadstop within the Station's roadstop spec list.

Definition at line 649 of file newgrf_roadstop.cpp.

References BaseStation::cached_roadstop_anim_triggers, BaseStation::cached_roadstop_cargo_triggers, BaseStation::custom_roadstop_tile_data, GetCustomRoadStopSpecIndex(), BaseStation::roadstop_speclist, and RoadStopUpdateCachedTriggers().

Referenced by RemoveRoadStop(), and RemoveRoadWaypointStop().

◆ DrawRoadStopTile()

void DrawRoadStopTile	(	int	x,
		int	y,
		RoadType	roadtype,
		const RoadStopSpec *	spec,
		StationType	type,
		int	view )

Draw representation of a road stop tile for GUI purposes.

Parameters

x	position x of image.
y	position y of image.
roadtype	the RoadType of the underlying road.
spec	the RoadStop's spec.
type	The type of station.
view	The road stop's view.

Definition at line 289 of file newgrf_roadstop.cpp.

References _local_company, DrawCommonTileSeqInGUI(), DrawModeRegister, DrawSprite(), GB(), GetCompanyPalette(), GetCustomRoadSprite(), SpriteLayoutProcessor::GetLayout(), GetRoadTypeInfo(), GroundSpritePaletteTransform(), INVALID_ROADTYPE, INVALID_TILE, Overlay, TileLayoutSpriteGroup::ProcessRegisters(), Road, RoadWaypoint, ROTSG_GROUND, ROTSG_OVERLAY, ROTSG_ROADSTOP, SPRITE_WIDTH, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), and WaypGround.

Referenced by RoadStopPickerCallbacks< roadstoptype >::DrawType(), RoadWaypointPickerCallbacks::DrawType(), and BuildRoadStationWindow::DrawWidget().

◆ GetAnimRoadStopCallback()

uint16_t GetAnimRoadStopCallback	(	CallbackID	callback,
		uint32_t	param1,
		uint32_t	param2,
		const RoadStopSpec *	roadstopspec,
		BaseStation *	st,
		TileIndex	tile,
		int	)

Perform the road stop callback in the context of the AnimationBase callback.

Parameters

callback	The identifier of the callback.
param1	The first parameter of the NewGRF callback.
param2	The second parameter of the NewGRF callback.
roadstopspec	The specification to run the callback on.
st	The station the road stop is part of.
tile	The tile the road stop is at.

Returns: The NewGRF result of the callback.

Definition at line 370 of file newgrf_roadstop.cpp.

References GetStationGfx(), GetStationType(), and INVALID_ROADTYPE.

◆ GetIfClassHasNewStopsByType()

bool GetIfClassHasNewStopsByType	(	const RoadStopClass *	roadstopclass,
		RoadStopType	rs,
		RoadType	roadtype )

Checks if the given RoadStopClass has any specs assigned to it, compatible with the given RoadStopType.

Parameters

roadstopclass	the RoadStopClass to check.
rs	the RoadStopType to check.
roadtype	the RoadType to check.

Returns: true if the RoadStopSpec has any specs compatible with the given RoadStopType and RoadType.

Definition at line 544 of file newgrf_roadstop.cpp.

References GetIfStopIsForType(), and NewGRFClass< Tspec, Tindex >::Specs().

Referenced by GetIfNewStopsByType(), and BuildRoadToolbarWindow::OnPlaceMouseUp().

◆ GetIfNewStopsByType()

bool GetIfNewStopsByType	(	RoadStopType	rs,
		RoadType	roadtype )

Checks if there's any new stations by a specific RoadStopType.

Parameters

rs	the RoadStopType to check.
roadtype	the RoadType to check.

Returns: true if there was any new RoadStopSpec's found for the given RoadStopType and RoadType, else false.

Definition at line 525 of file newgrf_roadstop.cpp.

References NewGRFClass< RoadStopSpec, RoadStopClassID >::Classes(), GetIfClassHasNewStopsByType(), IsWaypointClass(), and ROADSTOP_CLASS_DFLT.

◆ GetIfStopIsForType()

bool GetIfStopIsForType	(	const RoadStopSpec *	roadstopspec,
		RoadStopType	rs,
		RoadType	roadtype )

Checks if the given RoadStopSpec is compatible with the given RoadStopType.

Parameters

roadstopspec	the RoadStopSpec to check.
rs	the RoadStopType to check.
roadtype	the RoadType to check.

Returns: true if the RoadStopSpec is compatible with the given RoadStopType and RoadType.

Definition at line 559 of file newgrf_roadstop.cpp.

References Bus, RoadOnly, ROADSTOPTYPE_ALL, ROADSTOPTYPE_FREIGHT, ROADSTOPTYPE_PASSENGER, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Test(), TramOnly, and Truck.

Referenced by GetIfClassHasNewStopsByType().

◆ GetRoadStopCallback()

uint16_t GetRoadStopCallback	(	CallbackID	callback,
		uint32_t	param1,
		uint32_t	param2,
		const RoadStopSpec *	roadstopspec,
		BaseStation *	st,
		TileIndex	tile,
		RoadType	roadtype,
		StationType	type,
		uint8_t	view,
		std::span< int32_t >	regs100 )

Definition at line 274 of file newgrf_roadstop.cpp.

◆ GetRoadStopLayout()

std::optional< SpriteLayoutProcessor > GetRoadStopLayout	(	TileInfo *	ti,
		const RoadStopSpec *	spec,
		BaseStation *	st,
		StationType	type,
		int	view,
		std::span< int32_t >	regs100 )

Definition at line 349 of file newgrf_roadstop.cpp.

◆ GetRoadStopSpec()

const RoadStopSpec * GetRoadStopSpec ( TileIndex t )

Definition at line 584 of file newgrf_roadstop.cpp.

◆ RoadStopUpdateCachedTriggers()

void RoadStopUpdateCachedTriggers ( BaseStation * st )

Update the cached animation trigger bitmask for a station.

Parameters

st	Station to update.

Definition at line 690 of file newgrf_roadstop.cpp.

References BaseStation::cached_roadstop_anim_triggers, BaseStation::cached_roadstop_cargo_triggers, GetStationSpecList(), and BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set().

Referenced by AssignSpecToRoadStop(), and DeallocateSpecFromRoadStop().

◆ TriggerRoadStopAnimation()

void TriggerRoadStopAnimation	(	BaseStation *	st,
		TileIndex	trigger_tile,
		StationAnimationTrigger	trigger,
		CargoType	cargo_type )

Definition at line 397 of file newgrf_roadstop.cpp.

◆ TriggerRoadStopRandomisation()

void TriggerRoadStopRandomisation	(	BaseStation *	st,
		TileIndex	tile,
		StationRandomTrigger	trigger,
		CargoType	cargo_type )

Trigger road stop randomisation.

Parameters

st	the station being triggered
tile	the exact tile of the station that should be triggered
trigger	trigger type
cargo_type	cargo type causing the trigger

Definition at line 434 of file newgrf_roadstop.cpp.

References BaseStation::cached_roadstop_cargo_triggers, RoadStopSpec::cargo_triggers, CargoTaken, BaseStation::custom_roadstop_tile_data, SpecializedStation< Station, false >::From(), GetEmptyMask(), GetStationGfx(), GetStationType(), HasBit(), INVALID_ROADTYPE, IsValidCargoType(), MarkTileDirtyByTile(), BaseStation::random_bits, BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Reset(), BaseBitSet< Timpl, Tvalue_type, Tstorage, Tmask >::Set(), to_underlying(), and BaseStation::waiting_random_triggers.

Referenced by Vehicle::LeaveStation(), and LoadUnloadVehicle().

Variable Documentation

◆ NUM_ROADSTOPSPECS_PER_STATION

const uint NUM_ROADSTOPSPECS_PER_STATION = 63

static

Maximum number of parts per station.

Definition at line 54 of file newgrf_roadstop.cpp.

Referenced by AllocateSpecToRoadStop().

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ AllocateSpecToRoadStop()

◆ AnimateRoadStopTile()

◆ AssignSpecToRoadStop()

◆ DeallocateSpecFromRoadStop()

◆ DrawRoadStopTile()

◆ GetAnimRoadStopCallback()

◆ GetIfClassHasNewStopsByType()

◆ GetIfNewStopsByType()

◆ GetIfStopIsForType()

◆ GetRoadStopCallback()

◆ GetRoadStopLayout()

◆ GetRoadStopSpec()

◆ RoadStopUpdateCachedTriggers()

◆ TriggerRoadStopAnimation()

◆ TriggerRoadStopRandomisation()

Variable Documentation

◆ NUM_ROADSTOPSPECS_PER_STATION