porytiles2::ConfigProvider Class Reference

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

#include <config_provider.hpp>

Inheritance diagram for porytiles2::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_primary (const std::string &tileset) const
virtual LayerValue< std::size_t >	num_tiles_total (const std::string &tileset) const
virtual LayerValue< std::size_t >	num_metatiles_primary (const std::string &tileset) const
virtual LayerValue< std::size_t >	num_metatiles_total (const std::string &tileset) const
virtual LayerValue< std::size_t >	num_pals_primary (const std::string &tileset) const
virtual LayerValue< std::size_t >	num_pals_total (const std::string &tileset) const
virtual LayerValue< std::size_t >	max_map_data_size (const std::string &tileset) const
virtual LayerValue< std::size_t >	num_tiles_per_metatile (const std::string &tileset) const
virtual LayerValue< Rgba32 >	extrinsic_transparency (const std::string &tileset) const
virtual LayerValue< bool >	patch_build_enabled (const std::string &tileset) const
virtual LayerValue< TilesPalMode >	tiles_pal_mode (const std::string &tileset) 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 27 of file config_provider.hpp.

Constructor & Destructor Documentation

~ConfigProvider()

virtual porytiles2::ConfigProvider::~ConfigProvider ( )

virtualdefault

Member Function Documentation

extrinsic_transparency()

LayerValue< Rgba32 > porytiles2::ConfigProvider::extrinsic_transparency ( const std::string &  tileset ) const

virtual

Reimplemented in porytiles2::DefaultProvider, and porytiles2::YamlFileProvider.

Definition at line 51 of file config_provider.cpp.

max_map_data_size()

LayerValue< std::size_t > porytiles2::ConfigProvider::max_map_data_size ( const std::string &  tileset ) const

virtual

Reimplemented in porytiles2::DefaultProvider, and porytiles2::YamlFileProvider.

Definition at line 41 of file config_provider.cpp.

name()

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

pure virtual

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

Returns

The name of this ConfigProvider

Implemented in porytiles2::DefaultProvider, and porytiles2::YamlFileProvider.

num_metatiles_primary()

LayerValue< std::size_t > porytiles2::ConfigProvider::num_metatiles_primary ( const std::string &  tileset ) const

virtual

Reimplemented in porytiles2::DefaultProvider, and porytiles2::YamlFileProvider.

Definition at line 21 of file config_provider.cpp.

num_metatiles_total()

LayerValue< std::size_t > porytiles2::ConfigProvider::num_metatiles_total ( const std::string &  tileset ) const

virtual

Reimplemented in porytiles2::DefaultProvider, and porytiles2::YamlFileProvider.

Definition at line 26 of file config_provider.cpp.

num_pals_primary()

LayerValue< std::size_t > porytiles2::ConfigProvider::num_pals_primary ( const std::string &  tileset ) const

virtual

Reimplemented in porytiles2::DefaultProvider, and porytiles2::YamlFileProvider.

Definition at line 31 of file config_provider.cpp.

num_pals_total()

LayerValue< std::size_t > porytiles2::ConfigProvider::num_pals_total ( const std::string &  tileset ) const

virtual

Reimplemented in porytiles2::DefaultProvider, and porytiles2::YamlFileProvider.

Definition at line 36 of file config_provider.cpp.

num_tiles_per_metatile()

LayerValue< std::size_t > porytiles2::ConfigProvider::num_tiles_per_metatile ( const std::string &  tileset ) const

virtual

Reimplemented in porytiles2::DefaultProvider, and porytiles2::YamlFileProvider.

Definition at line 46 of file config_provider.cpp.

num_tiles_primary()

LayerValue< std::size_t > porytiles2::ConfigProvider::num_tiles_primary ( const std::string &  tileset ) const

virtual

Reimplemented in porytiles2::DefaultProvider, and porytiles2::YamlFileProvider.

Definition at line 11 of file config_provider.cpp.

num_tiles_total()

LayerValue< std::size_t > porytiles2::ConfigProvider::num_tiles_total ( const std::string &  tileset ) const

virtual

Reimplemented in porytiles2::DefaultProvider, and porytiles2::YamlFileProvider.

Definition at line 16 of file config_provider.cpp.

patch_build_enabled()

LayerValue< bool > porytiles2::ConfigProvider::patch_build_enabled ( const std::string &  tileset ) const

virtual

Reimplemented in porytiles2::DefaultProvider, and porytiles2::YamlFileProvider.

Definition at line 56 of file config_provider.cpp.

tiles_pal_mode()

LayerValue< TilesPalMode > porytiles2::ConfigProvider::tiles_pal_mode ( const std::string &  tileset ) const

virtual

Reimplemented in porytiles2::DefaultProvider, and porytiles2::YamlFileProvider.

Definition at line 61 of file config_provider.cpp.

---

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

• Porytiles2/include/porytiles2/infra/config/config_provider.hpp
• Porytiles2/lib/infra/config/config_provider.cpp