porytiles::DefaultProvider Class Reference

A default implementation of ConfigProvider that provides sensible default values. More...

#include <default_provider.hpp>

Inheritance diagram for porytiles::DefaultProvider:

Collaboration diagram for porytiles::DefaultProvider:

Public Member Functions
std::string	name () const override
	Gets the name of this config layer.
LayerValue< std::size_t >	num_tiles_in_primary (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::size_t >	num_tiles_total (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::size_t >	num_metatiles_in_primary (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::size_t >	num_metatiles_total (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::size_t >	num_palettes_in_primary (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::size_t >	num_palettes_total (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::size_t >	max_map_data_size (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::size_t >	num_tiles_per_metatile (ConfigScopeType type, const std::string &scope) const override
LayerValue< Rgba32 >	extrinsic_transparency (ConfigScopeType type, const std::string &scope) const override
LayerValue< bool >	ignore_triple_layer_content (ConfigScopeType type, const std::string &scope) const override
LayerValue< ArtifactEditMode >	tiles_edit_mode (ConfigScopeType type, const std::string &scope) const override
LayerValue< ArtifactEditMode >	palettes_edit_mode (ConfigScopeType type, const std::string &scope) const override
LayerValue< bool >	palette_hints_enabled (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::vector< PaletteHint > >	palette_hints (ConfigScopeType type, const std::string &scope) const override
LayerValue< PackingStrategyType >	packing_strategy (ConfigScopeType type, const std::string &scope) const override
LayerValue< PackingStrategyParams >	packing_strategy_params (ConfigScopeType type, const std::string &scope) const override
LayerValue< TileSharingPacking >	tile_sharing_packing (ConfigScopeType type, const std::string &scope) const override
LayerValue< TileSharingAlignment >	tile_sharing_alignment (ConfigScopeType type, const std::string &scope) const override
LayerValue< TilesPaletteMode >	tiles_palette_mode (ConfigScopeType type, const std::string &scope) const override
LayerValue< AnimPaletteResolutionStrategy >	global_anim_palette_resolution_strategy (ConfigScopeType type, const std::string &scope) const override
LayerValue< AnimKeyFrameResolutionStrategy >	global_anim_key_frame_resolution_strategy (ConfigScopeType type, const std::string &scope) const override
LayerValue< AnimMultiPaletteSubtileResolutionStrategy >	global_anim_multi_palette_subtile_resolution_strategy (ConfigScopeType type, const std::string &scope) const override
LayerValue< FrameLinking >	global_frame_linking (ConfigScopeType type, const std::string &scope) const override
LayerValue< PerAnimOverrides >	per_anim_overrides (ConfigScopeType type, const std::string &scope) const override
LayerValue< bool >	cross_tileset_anim_linking (ConfigScopeType type, const std::string &scope) const override
LayerValue< bool >	verify_checksums (ConfigScopeType type, const std::string &scope) const override
LayerValue< PrimaryPairingMode >	primary_pairing_mode (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::vector< std::string > >	primary_pairing_partners (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::vector< std::string > >	diagnostic_warnings_exclude (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::vector< std::string > >	diagnostic_warnings_include (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::vector< std::string > >	diagnostic_remarks_exclude (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::vector< std::string > >	diagnostic_remarks_include (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::string >	tileset_paths_primary_src (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::string >	tileset_paths_primary_bin (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::string >	tileset_paths_secondary_src (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::string >	tileset_paths_secondary_bin (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::optional< std::size_t > >	metatile_attribute_size (ConfigScopeType type, const std::string &scope) const override
LayerValue< std::optional< std::size_t > >	metatile_attribute_declaration_size (ConfigScopeType type, const std::string &scope) const override
LayerValue< MetatileAttributeFieldDefinitions >	metatile_attribute_fields (ConfigScopeType type, const std::string &scope) const override
LayerValue< MetatileAttributeFieldOverrides >	metatile_attribute_field_overrides (ConfigScopeType type, const std::string &scope) const override
LayerValue< RolePinDefinitions >	role_pins (ConfigScopeType type, const std::string &scope) const override
LayerValue< bool >	tileset_animations_wire_anim_code (ConfigScopeType type, const std::string &scope) const override
Public Member Functions inherited from porytiles::ConfigProvider
virtual	~ConfigProvider ()=default

Detailed Description

A default implementation of ConfigProvider that provides sensible default values.

This provider returns default values for all configuration parameters. It's useful as a base layer in a configuration system where other providers can override specific values.

Definition at line 17 of file default_provider.hpp.

Member Function Documentation

cross_tileset_anim_linking()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 173 of file default_provider.cpp.

diagnostic_remarks_exclude()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 212 of file default_provider.cpp.

diagnostic_remarks_include()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 219 of file default_provider.cpp.

diagnostic_warnings_exclude()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 198 of file default_provider.cpp.

diagnostic_warnings_include()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 205 of file default_provider.cpp.

extrinsic_transparency()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 69 of file default_provider.cpp.

global_anim_key_frame_resolution_strategy()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 144 of file default_provider.cpp.

global_anim_multi_palette_subtile_resolution_strategy()

LayerValue< AnimMultiPaletteSubtileResolutionStrategy > porytiles::DefaultProvider::global_anim_multi_palette_subtile_resolution_strategy ( ConfigScopeType  type, const std::string &  scope  ) const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 152 of file default_provider.cpp.

global_anim_palette_resolution_strategy()

LayerValue< AnimPaletteResolutionStrategy > porytiles::DefaultProvider::global_anim_palette_resolution_strategy ( ConfigScopeType  type, const std::string &  scope  ) const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 135 of file default_provider.cpp.

global_frame_linking()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 161 of file default_provider.cpp.

ignore_triple_layer_content()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 75 of file default_provider.cpp.

max_map_data_size()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 57 of file default_provider.cpp.

metatile_attribute_declaration_size()

LayerValue< std::optional< std::size_t > > porytiles::DefaultProvider::metatile_attribute_declaration_size ( ConfigScopeType  type, const std::string &  scope  ) const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 256 of file default_provider.cpp.

metatile_attribute_field_overrides()

LayerValue< MetatileAttributeFieldOverrides > porytiles::DefaultProvider::metatile_attribute_field_overrides ( ConfigScopeType  type, const std::string &  scope  ) const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 270 of file default_provider.cpp.

metatile_attribute_fields()

LayerValue< MetatileAttributeFieldDefinitions > porytiles::DefaultProvider::metatile_attribute_fields ( ConfigScopeType  type, const std::string &  scope  ) const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 263 of file default_provider.cpp.

metatile_attribute_size()

LayerValue< std::optional< std::size_t > > porytiles::DefaultProvider::metatile_attribute_size ( ConfigScopeType  type, const std::string &  scope  ) const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 250 of file default_provider.cpp.

name()

std::string porytiles::DefaultProvider::name ( ) const

overridevirtual

Gets the name of this config layer.

Returns

The name "DefaultProvider"

Implements porytiles::ConfigProvider.

Definition at line 16 of file default_provider.cpp.

num_metatiles_in_primary()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 33 of file default_provider.cpp.

num_metatiles_total()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 39 of file default_provider.cpp.

num_palettes_in_primary()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 45 of file default_provider.cpp.

num_palettes_total()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 51 of file default_provider.cpp.

num_tiles_in_primary()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 21 of file default_provider.cpp.

num_tiles_per_metatile()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 63 of file default_provider.cpp.

num_tiles_total()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 28 of file default_provider.cpp.

packing_strategy()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 105 of file default_provider.cpp.

packing_strategy_params()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 111 of file default_provider.cpp.

palette_hints()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 100 of file default_provider.cpp.

palette_hints_enabled()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 93 of file default_provider.cpp.

palettes_edit_mode()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 87 of file default_provider.cpp.

per_anim_overrides()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 167 of file default_provider.cpp.

primary_pairing_mode()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 185 of file default_provider.cpp.

primary_pairing_partners()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 191 of file default_provider.cpp.

role_pins()

LayerValue< RolePinDefinitions > porytiles::DefaultProvider::role_pins ( ConfigScopeType  type, const std::string &  scope  ) const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 278 of file default_provider.cpp.

tile_sharing_alignment()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 123 of file default_provider.cpp.

tile_sharing_packing()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 117 of file default_provider.cpp.

tiles_edit_mode()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 82 of file default_provider.cpp.

tiles_palette_mode()

LayerValue< TilesPaletteMode > porytiles::DefaultProvider::tiles_palette_mode ( ConfigScopeType  type, const std::string &  scope  ) const

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 129 of file default_provider.cpp.

tileset_animations_wire_anim_code()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 283 of file default_provider.cpp.

tileset_paths_primary_bin()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 232 of file default_provider.cpp.

tileset_paths_primary_src()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 226 of file default_provider.cpp.

tileset_paths_secondary_bin()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 244 of file default_provider.cpp.

tileset_paths_secondary_src()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 238 of file default_provider.cpp.

verify_checksums()

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

overridevirtual

Reimplemented from porytiles::ConfigProvider.

Definition at line 179 of file default_provider.cpp.

---

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

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