porytiles::ConfigProvider Class Reference

An interface which config implementations can use to load config values. More...

#include <config_provider.hpp>

Inheritance diagram for porytiles::ConfigProvider:

Public Member Functions
virtual	~ConfigProvider ()=default
virtual std::string	name () const =0
	Gets the name of this ConfigProvider, useful for diagnostic purposes.
virtual LayerValue< std::size_t >	num_tiles_in_primary (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::size_t >	num_tiles_total (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::size_t >	num_metatiles_in_primary (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::size_t >	num_metatiles_total (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::size_t >	num_pals_in_primary (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::size_t >	num_pals_total (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::size_t >	max_map_data_size (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::size_t >	num_tiles_per_metatile (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< Rgba32 >	extrinsic_transparency (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< ArtifactEditMode >	tiles_edit_mode (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< ArtifactEditMode >	pals_edit_mode (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< bool >	pal_hints_enabled (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::vector< PaletteHint > >	pal_hints (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< PackingStrategyType >	packing_strategy (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< PackingStrategyParams >	packing_strategy_params (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< TileSharingPacking >	tile_sharing_packing (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< TileSharingAlignment >	tile_sharing_alignment (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< TilesPalMode >	tiles_pal_mode (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< AnimPalResolutionStrategy >	global_anim_pal_resolution_strategy (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< AnimKeyFrameResolutionStrategy >	global_anim_key_frame_resolution_strategy (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< AnimMultiPalSubtileResolutionStrategy >	global_anim_multi_pal_subtile_resolution_strategy (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< FrameLinking >	global_frame_linking (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< PerAnimOverrides >	per_anim_overrides (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< bool >	cross_tileset_anim_linking (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< bool >	verify_checksums (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< PrimaryPairingMode >	primary_pairing_mode (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::vector< std::string > >	primary_pairing_partners (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::vector< std::string > >	diagnostic_warnings_exclude (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::vector< std::string > >	diagnostic_warnings_include (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::vector< std::string > >	diagnostic_remarks_exclude (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::vector< std::string > >	diagnostic_remarks_include (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::string >	tileset_paths_primary_src (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::string >	tileset_paths_primary_bin (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::string >	tileset_paths_secondary_src (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::string >	tileset_paths_secondary_bin (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< std::size_t >	metatile_attr_size (ConfigScopeType type, const std::string &scope) const
virtual LayerValue< bool >	tileset_animations_wire_anim_code (ConfigScopeType type, const std::string &scope) const

Detailed Description

An interface which config implementations can use to load config values.

ConfigProvider is basically just a copy of all three layer configs (domain, app, infra) but with LayerValue return types. ConfigProvider provides a default implementation for each method which returns an empty LayerValue. This is helpful for ConfigProvider implementations, since often the implementations may not want to provide a value for every config param.

Definition at line 38 of file config_provider.hpp.

Constructor & Destructor Documentation

~ConfigProvider()

virtual porytiles::ConfigProvider::~ConfigProvider ( )

virtualdefault

Member Function Documentation

cross_tileset_anim_linking()

LayerValue< bool > porytiles::ConfigProvider::cross_tileset_anim_linking ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 127 of file config_provider.cpp.

diagnostic_remarks_exclude()

LayerValue< std::vector< std::string > > porytiles::ConfigProvider::diagnostic_remarks_exclude ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 157 of file config_provider.cpp.

diagnostic_remarks_include()

LayerValue< std::vector< std::string > > porytiles::ConfigProvider::diagnostic_remarks_include ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 162 of file config_provider.cpp.

diagnostic_warnings_exclude()

LayerValue< std::vector< std::string > > porytiles::ConfigProvider::diagnostic_warnings_exclude ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 147 of file config_provider.cpp.

diagnostic_warnings_include()

LayerValue< std::vector< std::string > > porytiles::ConfigProvider::diagnostic_warnings_include ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 152 of file config_provider.cpp.

extrinsic_transparency()

LayerValue< Rgba32 > porytiles::ConfigProvider::extrinsic_transparency ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 52 of file config_provider.cpp.

global_anim_key_frame_resolution_strategy()

LayerValue< AnimKeyFrameResolutionStrategy > porytiles::ConfigProvider::global_anim_key_frame_resolution_strategy ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 107 of file config_provider.cpp.

global_anim_multi_pal_subtile_resolution_strategy()

LayerValue< AnimMultiPalSubtileResolutionStrategy > porytiles::ConfigProvider::global_anim_multi_pal_subtile_resolution_strategy ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 112 of file config_provider.cpp.

global_anim_pal_resolution_strategy()

LayerValue< AnimPalResolutionStrategy > porytiles::ConfigProvider::global_anim_pal_resolution_strategy ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 102 of file config_provider.cpp.

global_frame_linking()

LayerValue< FrameLinking > porytiles::ConfigProvider::global_frame_linking ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 117 of file config_provider.cpp.

max_map_data_size()

LayerValue< std::size_t > porytiles::ConfigProvider::max_map_data_size ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 42 of file config_provider.cpp.

metatile_attr_size()

LayerValue< std::size_t > porytiles::ConfigProvider::metatile_attr_size ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::MetatilesHeaderProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 187 of file config_provider.cpp.

name()

virtual std::string porytiles::ConfigProvider::name ( ) const

pure virtual

Gets the name of this ConfigProvider, useful for diagnostic purposes.

Returns

The name of this ConfigProvider

Implemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::MetatilesHeaderProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

num_metatiles_in_primary()

LayerValue< std::size_t > porytiles::ConfigProvider::num_metatiles_in_primary ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 22 of file config_provider.cpp.

num_metatiles_total()

LayerValue< std::size_t > porytiles::ConfigProvider::num_metatiles_total ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 27 of file config_provider.cpp.

num_pals_in_primary()

LayerValue< std::size_t > porytiles::ConfigProvider::num_pals_in_primary ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 32 of file config_provider.cpp.

num_pals_total()

LayerValue< std::size_t > porytiles::ConfigProvider::num_pals_total ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 37 of file config_provider.cpp.

num_tiles_in_primary()

LayerValue< std::size_t > porytiles::ConfigProvider::num_tiles_in_primary ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 12 of file config_provider.cpp.

num_tiles_per_metatile()

LayerValue< std::size_t > porytiles::ConfigProvider::num_tiles_per_metatile ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 47 of file config_provider.cpp.

num_tiles_total()

LayerValue< std::size_t > porytiles::ConfigProvider::num_tiles_total ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 17 of file config_provider.cpp.

packing_strategy()

LayerValue< PackingStrategyType > porytiles::ConfigProvider::packing_strategy ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 77 of file config_provider.cpp.

packing_strategy_params()

LayerValue< PackingStrategyParams > porytiles::ConfigProvider::packing_strategy_params ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 82 of file config_provider.cpp.

pal_hints()

LayerValue< std::vector< PaletteHint > > porytiles::ConfigProvider::pal_hints ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 72 of file config_provider.cpp.

pal_hints_enabled()

LayerValue< bool > porytiles::ConfigProvider::pal_hints_enabled ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 67 of file config_provider.cpp.

pals_edit_mode()

LayerValue< ArtifactEditMode > porytiles::ConfigProvider::pals_edit_mode ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 62 of file config_provider.cpp.

per_anim_overrides()

LayerValue< PerAnimOverrides > porytiles::ConfigProvider::per_anim_overrides ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 122 of file config_provider.cpp.

primary_pairing_mode()

LayerValue< PrimaryPairingMode > porytiles::ConfigProvider::primary_pairing_mode ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 137 of file config_provider.cpp.

primary_pairing_partners()

LayerValue< std::vector< std::string > > porytiles::ConfigProvider::primary_pairing_partners ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 142 of file config_provider.cpp.

tile_sharing_alignment()

LayerValue< TileSharingAlignment > porytiles::ConfigProvider::tile_sharing_alignment ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 92 of file config_provider.cpp.

tile_sharing_packing()

LayerValue< TileSharingPacking > porytiles::ConfigProvider::tile_sharing_packing ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 87 of file config_provider.cpp.

tiles_edit_mode()

LayerValue< ArtifactEditMode > porytiles::ConfigProvider::tiles_edit_mode ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 57 of file config_provider.cpp.

tiles_pal_mode()

LayerValue< TilesPalMode > porytiles::ConfigProvider::tiles_pal_mode ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 97 of file config_provider.cpp.

tileset_animations_wire_anim_code()

LayerValue< bool > porytiles::ConfigProvider::tileset_animations_wire_anim_code ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 192 of file config_provider.cpp.

tileset_paths_primary_bin()

LayerValue< std::string > porytiles::ConfigProvider::tileset_paths_primary_bin ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 172 of file config_provider.cpp.

tileset_paths_primary_src()

LayerValue< std::string > porytiles::ConfigProvider::tileset_paths_primary_src ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 167 of file config_provider.cpp.

tileset_paths_secondary_bin()

LayerValue< std::string > porytiles::ConfigProvider::tileset_paths_secondary_bin ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 182 of file config_provider.cpp.

tileset_paths_secondary_src()

LayerValue< std::string > porytiles::ConfigProvider::tileset_paths_secondary_src ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 177 of file config_provider.cpp.

verify_checksums()

LayerValue< bool > porytiles::ConfigProvider::verify_checksums ( ConfigScopeType  type, const std::string &  scope  ) const

virtual

Reimplemented in porytiles::CliOptionProvider, porytiles::DefaultProvider, porytiles::HeaderDefineProvider, porytiles::OverrideConfigProvider, and porytiles::YamlFileProvider.

Definition at line 132 of file config_provider.cpp.

---

The documentation for this class was generated from the following files:

• porytiles/include/porytiles/infra/config/config_provider.hpp
• porytiles/lib/infra/config/config_provider.cpp