core::Properties Class Reference

Wrapper around bl::engine::Configuration. Provides application configuration in variables that may be accessed without performing look ups, and hides the string config names. More...

#include <Properties.hpp>

Inheritance diagram for core::Properties:

Static Public Member Functions
static const std::string &	WindowIconFile ()
static int	WindowWidth ()
static int	WindowHeight ()
static sf::Vector2f	WindowSize ()
static bool	InEditor ()
static const std::string &	SaveDirectory ()
static const std::string &	SaveExtension ()
static int	PixelsPerTile ()
static int	ExtraRenderTiles ()
static int	LightingWidthTiles ()
static int	LightingHeightTiles ()
static const sf::VulkanFont &	MenuFont ()
static const std::string &	MenuImagePath ()
static const std::string &	ImagePath ()
static const std::string &	AnimationPath ()
static const std::string &	SoundPath ()
static const std::string &	SpritesheetPath ()
static const std::string &	MusicPath ()
static const std::string &	PlaylistPath ()
static const std::string &	MapPath ()
static const std::string &	TilesetPath ()
static const std::string &	MapTilePath ()
static const std::string &	MapAnimationPath ()
static const std::string &	ThunderSoundFile ()
static const std::string &	LightRainSoundFile ()
static const std::string &	HardRainSoundFile ()
static const std::string &	RainDropFile ()
static const std::string &	RainSplash1File ()
static const std::string &	RainSplash2File ()
static const std::string &	SnowFlakeFile ()
static const std::string &	FogFile ()
static const std::string &	SandPatchFile ()
static const std::string &	SandSwirlFile ()
static float	FrequentThunderMinInterval ()
static float	FrequentThunderMaxInterval ()
static float	InfrequentThunderMinInterval ()
static float	InfrequentThunderMaxInterval ()
static unsigned int	LightRainParticleCount ()
static unsigned int	HardRainParticleCount ()
static unsigned int	LightSnowParticleCount ()
static unsigned int	HardSnowParticleCount ()
static unsigned int	ThinFogAlpha ()
static unsigned int	ThickFogAlpha ()
static int	LightRainLightModifier ()
static int	HardRainLightModifier ()
static int	LightSnowLightModifier ()
static int	HardSnowLightModifier ()
static int	ThinFogLightModifier ()
static int	ThickFogLightModifier ()
static int	SunnyLightModifier ()
static int	SandstormLightModifier ()
static const std::string &	NpcFileExtension ()
static const std::string &	NpcPath ()
static const std::string &	TrainerFileExtension ()
static const std::string &	TrainerPath ()
static const std::string &	ConversationPath ()
static const std::string &	ConversationFileExtension ()
static const std::string &	LegacyPeoplemonPath ()
static const std::string &	CharacterAnimationPath ()
static float	CharacterMoveSpeed ()
static float	FastCharacterMoveSpeed ()
static float	CharacterSpinPeriod ()
static const std::string &	PlayerAnimations (player::Gender gender)
static const std::string &	ItemMetadataFile ()
static const std::string &	ItemSprite ()
static float	GhostWriterSpeed ()
static const std::string &	TextboxFile ()
static unsigned int	HudFontSize ()
static const std::string &	ScriptPath ()
static float	ScreenFadePeriod ()
static const std::string &	PeoplemonDBFile ()
static const std::string &	MoveDBFile ()
static sf::Color	HPBarColor (float percent)
static sf::Color	HPBarColor (unsigned int hp, unsigned int maxHp)
static std::string	AilmentTexture (pplmn::Ailment ailment)
static const std::string &	PeoplemonImageFolder ()
static bl::audio::AudioSystem::Handle	MenuMoveSound ()
static bl::audio::AudioSystem::Handle	MenuMoveFailSound ()
static bl::audio::AudioSystem::Handle	MenuBackSound ()
static unsigned int	WildPeoplemonChance ()
static const std::string &	TrainerExclaimImage ()
static const std::string &	TrainerExclaimSound ()
static bool	load (bool inEditor)
	Loads from the config file and sets defaults. Must be called before using any properties. More...
static void	save ()
	Saves the config to the data file. More...

Static Public Attributes
static constexpr std::uint32_t	EvolutionSparkPipelineId = 200
static constexpr std::uint32_t	RaindropPipelineId = 201
static constexpr std::uint32_t	SnowflakePipelineId = 202
static constexpr std::uint32_t	FogPipelineId = 203
static constexpr std::uint32_t	SandstormSandPipelineId = 204
static constexpr std::uint32_t	SandstormSwirlPipelineId = 205
static constexpr std::uint32_t	TrainerIntroPipelineId = 206
static constexpr std::uint32_t	WildIntroPipelineId = 207
static constexpr std::uint32_t	BattlePeoplemonSparkPipelineId = 208
static constexpr std::uint32_t	EditorConversationTreeShapePipelineId = 210
static constexpr std::uint32_t	EditorConversationTreeTextPipelineId = 211

Detailed Description

Wrapper around bl::engine::Configuration. Provides application configuration in variables that may be accessed without performing look ups, and hides the string config names.

Definition at line 28 of file Properties.hpp.

Member Function Documentation

AilmentTexture()

std::string core::Properties::AilmentTexture ( pplmn::Ailment  ailment )

static

Definition at line 653 of file Properties.cpp.

AnimationPath()

const std::string & core::Properties::AnimationPath ( )

static

Definition at line 327 of file Properties.cpp.

CharacterAnimationPath()

const std::string & core::Properties::CharacterAnimationPath ( )

static

Definition at line 557 of file Properties.cpp.

CharacterMoveSpeed()

float core::Properties::CharacterMoveSpeed ( )

static

Definition at line 563 of file Properties.cpp.

CharacterSpinPeriod()

float core::Properties::CharacterSpinPeriod ( )

static

Definition at line 585 of file Properties.cpp.

ConversationFileExtension()

const std::string & core::Properties::ConversationFileExtension ( )

static

Definition at line 545 of file Properties.cpp.

ConversationPath()

const std::string & core::Properties::ConversationPath ( )

static

Definition at line 539 of file Properties.cpp.

ExtraRenderTiles()

int core::Properties::ExtraRenderTiles ( )

static

Definition at line 285 of file Properties.cpp.

FastCharacterMoveSpeed()

float core::Properties::FastCharacterMoveSpeed ( )

static

Definition at line 568 of file Properties.cpp.

FogFile()

const std::string & core::Properties::FogFile ( )

static

Definition at line 407 of file Properties.cpp.

FrequentThunderMaxInterval()

float core::Properties::FrequentThunderMaxInterval ( )

static

Definition at line 450 of file Properties.cpp.

FrequentThunderMinInterval()

float core::Properties::FrequentThunderMinInterval ( )

static

Definition at line 445 of file Properties.cpp.

GhostWriterSpeed()

float core::Properties::GhostWriterSpeed ( )

static

Definition at line 602 of file Properties.cpp.

HardRainLightModifier()

int core::Properties::HardRainLightModifier ( )

static

Definition at line 480 of file Properties.cpp.

HardRainParticleCount()

unsigned int core::Properties::HardRainParticleCount ( )

static

Definition at line 430 of file Properties.cpp.

HardRainSoundFile()

const std::string & core::Properties::HardRainSoundFile ( )

static

Definition at line 377 of file Properties.cpp.

HardSnowLightModifier()

int core::Properties::HardSnowLightModifier ( )

static

Definition at line 490 of file Properties.cpp.

HardSnowParticleCount()

unsigned int core::Properties::HardSnowParticleCount ( )

static

Definition at line 440 of file Properties.cpp.

HPBarColor() [1/2]

sf::Color core::Properties::HPBarColor ( float  percent )

static

Definition at line 647 of file Properties.cpp.

HPBarColor() [2/2]

sf::Color core::Properties::HPBarColor ( unsigned int  hp, unsigned int  maxHp  )

static

Definition at line 642 of file Properties.cpp.

HudFontSize()

unsigned int core::Properties::HudFontSize ( )

static

Definition at line 613 of file Properties.cpp.

ImagePath()

const std::string & core::Properties::ImagePath ( )

static

Definition at line 333 of file Properties.cpp.

InEditor()

bool core::Properties::InEditor ( )

static

Definition at line 266 of file Properties.cpp.

InfrequentThunderMaxInterval()

float core::Properties::InfrequentThunderMaxInterval ( )

static

Definition at line 460 of file Properties.cpp.

InfrequentThunderMinInterval()

float core::Properties::InfrequentThunderMinInterval ( )

static

Definition at line 455 of file Properties.cpp.

ItemMetadataFile()

const std::string & core::Properties::ItemMetadataFile ( )

static

Definition at line 590 of file Properties.cpp.

ItemSprite()

const std::string & core::Properties::ItemSprite ( )

static

Definition at line 596 of file Properties.cpp.

LegacyPeoplemonPath()

const std::string & core::Properties::LegacyPeoplemonPath ( )

static

Definition at line 551 of file Properties.cpp.

LightingHeightTiles()

int core::Properties::LightingHeightTiles ( )

static

Definition at line 297 of file Properties.cpp.

LightingWidthTiles()

int core::Properties::LightingWidthTiles ( )

static

Definition at line 291 of file Properties.cpp.

LightRainLightModifier()

int core::Properties::LightRainLightModifier ( )

static

Definition at line 475 of file Properties.cpp.

LightRainParticleCount()

unsigned int core::Properties::LightRainParticleCount ( )

static

Definition at line 425 of file Properties.cpp.

LightRainSoundFile()

const std::string & core::Properties::LightRainSoundFile ( )

static

Definition at line 371 of file Properties.cpp.

LightSnowLightModifier()

int core::Properties::LightSnowLightModifier ( )

static

Definition at line 485 of file Properties.cpp.

LightSnowParticleCount()

unsigned int core::Properties::LightSnowParticleCount ( )

static

Definition at line 435 of file Properties.cpp.

load()

bool core::Properties::load ( bool  inEditor )

static

Loads from the config file and sets defaults. Must be called before using any properties.

Parameters

inEditor

True if in the editor, false if in the game

Returns

True if loaded without error, false for failure

Definition at line 119 of file Properties.cpp.

MapAnimationPath()

const std::string & core::Properties::MapAnimationPath ( )

static

Definition at line 357 of file Properties.cpp.

MapPath()

const std::string & core::Properties::MapPath ( )

static

Definition at line 339 of file Properties.cpp.

MapTilePath()

const std::string & core::Properties::MapTilePath ( )

static

Definition at line 351 of file Properties.cpp.

MenuBackSound()

bl::audio::AudioSystem::Handle core::Properties::MenuBackSound ( )

static

Definition at line 712 of file Properties.cpp.

MenuFont()

const sf::VulkanFont & core::Properties::MenuFont ( )

static

Definition at line 363 of file Properties.cpp.

MenuImagePath()

const std::string & core::Properties::MenuImagePath ( )

static

Definition at line 303 of file Properties.cpp.

MenuMoveFailSound()

bl::audio::AudioSystem::Handle core::Properties::MenuMoveFailSound ( )

static

Definition at line 707 of file Properties.cpp.

MenuMoveSound()

bl::audio::AudioSystem::Handle core::Properties::MenuMoveSound ( )

static

Definition at line 702 of file Properties.cpp.

MoveDBFile()

const std::string & core::Properties::MoveDBFile ( )

static

Definition at line 636 of file Properties.cpp.

MusicPath()

const std::string & core::Properties::MusicPath ( )

static

Definition at line 315 of file Properties.cpp.

NpcFileExtension()

const std::string & core::Properties::NpcFileExtension ( )

static

Definition at line 515 of file Properties.cpp.

NpcPath()

const std::string & core::Properties::NpcPath ( )

static

Definition at line 521 of file Properties.cpp.

PeoplemonDBFile()

const std::string & core::Properties::PeoplemonDBFile ( )

static

Definition at line 630 of file Properties.cpp.

PeoplemonImageFolder()

const std::string & core::Properties::PeoplemonImageFolder ( )

static

Definition at line 672 of file Properties.cpp.

PixelsPerTile()

int core::Properties::PixelsPerTile ( )

static

Definition at line 279 of file Properties.cpp.

PlayerAnimations()

const std::string & core::Properties::PlayerAnimations ( player::Gender  gender )

static

Definition at line 573 of file Properties.cpp.

PlaylistPath()

const std::string & core::Properties::PlaylistPath ( )

static

Definition at line 321 of file Properties.cpp.

RainDropFile()

const std::string & core::Properties::RainDropFile ( )

static

Definition at line 383 of file Properties.cpp.

RainSplash1File()

const std::string & core::Properties::RainSplash1File ( )

static

Definition at line 389 of file Properties.cpp.

RainSplash2File()

const std::string & core::Properties::RainSplash2File ( )

static

Definition at line 395 of file Properties.cpp.

SandPatchFile()

const std::string & core::Properties::SandPatchFile ( )

static

Definition at line 413 of file Properties.cpp.

SandstormLightModifier()

int core::Properties::SandstormLightModifier ( )

static

Definition at line 510 of file Properties.cpp.

SandSwirlFile()

const std::string & core::Properties::SandSwirlFile ( )

static

Definition at line 419 of file Properties.cpp.

save()

void core::Properties::save ( )

static

Saves the config to the data file.

Definition at line 242 of file Properties.cpp.

SaveDirectory()

const std::string & core::Properties::SaveDirectory ( )

static

Definition at line 268 of file Properties.cpp.

SaveExtension()

const std::string & core::Properties::SaveExtension ( )

static

Definition at line 274 of file Properties.cpp.

ScreenFadePeriod()

float core::Properties::ScreenFadePeriod ( )

static

Definition at line 624 of file Properties.cpp.

ScriptPath()

const std::string & core::Properties::ScriptPath ( )

static

Definition at line 618 of file Properties.cpp.

SnowFlakeFile()

const std::string & core::Properties::SnowFlakeFile ( )

static

Definition at line 401 of file Properties.cpp.

SoundPath()

const std::string & core::Properties::SoundPath ( )

static

Definition at line 696 of file Properties.cpp.

SpritesheetPath()

const std::string & core::Properties::SpritesheetPath ( )

static

Definition at line 309 of file Properties.cpp.

SunnyLightModifier()

int core::Properties::SunnyLightModifier ( )

static

Definition at line 505 of file Properties.cpp.

TextboxFile()

const std::string & core::Properties::TextboxFile ( )

static

Definition at line 607 of file Properties.cpp.

ThickFogAlpha()

unsigned int core::Properties::ThickFogAlpha ( )

static

Definition at line 465 of file Properties.cpp.

ThickFogLightModifier()

int core::Properties::ThickFogLightModifier ( )

static

Definition at line 500 of file Properties.cpp.

ThinFogAlpha()

unsigned int core::Properties::ThinFogAlpha ( )

static

Definition at line 470 of file Properties.cpp.

ThinFogLightModifier()

int core::Properties::ThinFogLightModifier ( )

static

Definition at line 495 of file Properties.cpp.

ThunderSoundFile()

const std::string & core::Properties::ThunderSoundFile ( )

static

Definition at line 365 of file Properties.cpp.

TilesetPath()

const std::string & core::Properties::TilesetPath ( )

static

Definition at line 345 of file Properties.cpp.

TrainerExclaimImage()

const std::string & core::Properties::TrainerExclaimImage ( )

static

Definition at line 684 of file Properties.cpp.

TrainerExclaimSound()

const std::string & core::Properties::TrainerExclaimSound ( )

static

Definition at line 690 of file Properties.cpp.

TrainerFileExtension()

const std::string & core::Properties::TrainerFileExtension ( )

static

Definition at line 527 of file Properties.cpp.

TrainerPath()

const std::string & core::Properties::TrainerPath ( )

static

Definition at line 533 of file Properties.cpp.

WildPeoplemonChance()

unsigned int core::Properties::WildPeoplemonChance ( )

static

Definition at line 678 of file Properties.cpp.

WindowHeight()

int core::Properties::WindowHeight ( )

static

Definition at line 256 of file Properties.cpp.

WindowIconFile()

const std::string & core::Properties::WindowIconFile ( )

static

Definition at line 244 of file Properties.cpp.

WindowSize()

sf::Vector2f core::Properties::WindowSize ( )

static

Definition at line 262 of file Properties.cpp.

WindowWidth()

int core::Properties::WindowWidth ( )

static

Definition at line 250 of file Properties.cpp.

Member Data Documentation

BattlePeoplemonSparkPipelineId

constexpr std::uint32_t core::Properties::BattlePeoplemonSparkPipelineId = 208

staticconstexpr

Definition at line 143 of file Properties.hpp.

EditorConversationTreeShapePipelineId

constexpr std::uint32_t core::Properties::EditorConversationTreeShapePipelineId = 210

staticconstexpr

Definition at line 145 of file Properties.hpp.

EditorConversationTreeTextPipelineId

constexpr std::uint32_t core::Properties::EditorConversationTreeTextPipelineId = 211

staticconstexpr

Definition at line 146 of file Properties.hpp.

EvolutionSparkPipelineId

constexpr std::uint32_t core::Properties::EvolutionSparkPipelineId = 200

staticconstexpr

Definition at line 135 of file Properties.hpp.

FogPipelineId

constexpr std::uint32_t core::Properties::FogPipelineId = 203

staticconstexpr

Definition at line 138 of file Properties.hpp.

RaindropPipelineId

constexpr std::uint32_t core::Properties::RaindropPipelineId = 201

staticconstexpr

Definition at line 136 of file Properties.hpp.

SandstormSandPipelineId

constexpr std::uint32_t core::Properties::SandstormSandPipelineId = 204

staticconstexpr

Definition at line 139 of file Properties.hpp.

SandstormSwirlPipelineId

constexpr std::uint32_t core::Properties::SandstormSwirlPipelineId = 205

staticconstexpr

Definition at line 140 of file Properties.hpp.

SnowflakePipelineId

constexpr std::uint32_t core::Properties::SnowflakePipelineId = 202

staticconstexpr

Definition at line 137 of file Properties.hpp.

TrainerIntroPipelineId

constexpr std::uint32_t core::Properties::TrainerIntroPipelineId = 206

staticconstexpr

Definition at line 141 of file Properties.hpp.

WildIntroPipelineId

constexpr std::uint32_t core::Properties::WildIntroPipelineId = 207

staticconstexpr

Definition at line 142 of file Properties.hpp.

---

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

• include/Core/Properties.hpp
• src/Core/Properties.cpp