InvokeGrfChangeInfoHandler Struct Reference

Helper class to invoke a GrfChangeInfoHandler. More...

Public Types
using	Invoker = ChangeInfoResult(*)(uint first, uint last, int prop, ByteReader &buf, GrfLoadingStage stage)
	The function prototype for a change info handler.

Static Public Member Functions
template<GrfSpecFeature TFeature>
static ChangeInfoResult	Invoke (uint first, uint last, int prop, ByteReader &buf, GrfLoadingStage stage)
	Invoke the change info handler for a specific feature.
static ChangeInfoResult	Invoke (GrfSpecFeature feature, uint first, uint last, int prop, ByteReader &buf, GrfLoadingStage stage)
	Invoke the change info handler for a specific feature.

Static Public Attributes
static constexpr EnumIndexArray< Invoker, GrfSpecFeature, GrfSpecFeature::End >	funcs
	List of invoke handlers for each feature.

Detailed Description

Helper class to invoke a GrfChangeInfoHandler.

Definition at line 142 of file newgrf_act0.cpp.

Member Typedef Documentation

Invoker

using InvokeGrfChangeInfoHandler::Invoker = ChangeInfoResult(*)(uint first, uint last, int prop, ByteReader &buf, GrfLoadingStage stage)

The function prototype for a change info handler.

Definition at line 164 of file newgrf_act0.cpp.

Member Function Documentation

Invoke() [1/2]

ChangeInfoResult InvokeGrfChangeInfoHandler::Invoke ( GrfSpecFeature feature, uint first, uint last, int prop, ByteReader & buf, GrfLoadingStage stage )

inlinestatic

Invoke the change info handler for a specific feature.

Parameters

feature	The feature.
first	The first id of the feature instance (engine, station, ...) to activate for.
last	The id to stop iterating at (exclusive).
prop	The property to activate for.
buf	The buffer containing the sprite data.
stage	The current loading stage.

Returns

Whether it was successful, or why it wasn't.

Definition at line 186 of file newgrf_act0.cpp.

References funcs, to_underlying(), and Unknown.

Invoke() [2/2]

template<GrfSpecFeature TFeature>

ChangeInfoResult InvokeGrfChangeInfoHandler::Invoke ( uint first, uint last, int prop, ByteReader & buf, GrfLoadingStage stage )

inlinestatic

Invoke the change info handler for a specific feature.

Template Parameters

TFeature

The feature.

Parameters

first	The first id of the feature instance (engine, station, ...) to activate for.
last	The id to stop iterating at (exclusive).
prop	The property to activate for.
buf	The buffer containing the sprite data.
stage	The current loading stage.

Returns

Whether it was successful, or why it wasn't.

Definition at line 154 of file newgrf_act0.cpp.

References GrfChangeInfoHandler< TFeature >::Activation(), Activation, GrfChangeInfoHandler< TFeature >::Reserve(), and Reserve.

Field Documentation

funcs

EnumIndexArray<Invoker, GrfSpecFeature, GrfSpecFeature::End> InvokeGrfChangeInfoHandler::funcs

staticconstexpr

Initial value:

{ 
    Invoke<GrfSpecFeature::Trains>,       Invoke<GrfSpecFeature::RoadVehicles>,  Invoke<GrfSpecFeature::Ships>,         Invoke<GrfSpecFeature::Aircraft>,
    Invoke<GrfSpecFeature::Stations>,     Invoke<GrfSpecFeature::Canals>,        Invoke<GrfSpecFeature::Bridges>,       Invoke<GrfSpecFeature::Houses>,
    Invoke<GrfSpecFeature::GlobalVar>,    Invoke<GrfSpecFeature::IndustryTiles>, Invoke<GrfSpecFeature::Industries>,    Invoke<GrfSpecFeature::Cargoes>,
    Invoke<GrfSpecFeature::SoundEffects>, Invoke<GrfSpecFeature::Airports>,      nullptr , Invoke<GrfSpecFeature::Objects>,
    Invoke<GrfSpecFeature::RailTypes>,    Invoke<GrfSpecFeature::AirportTiles>,  Invoke<GrfSpecFeature::RoadTypes>,     Invoke<GrfSpecFeature::TramTypes>,
    Invoke<GrfSpecFeature::RoadStops>,    Invoke<GrfSpecFeature::Badges>,
  }

List of invoke handlers for each feature.

Definition at line 167 of file newgrf_act0.cpp.

Referenced by Invoke().

---

The documentation for this struct was generated from the following file:

• src/newgrf/newgrf_act0.cpp