Serves as the primary store of all Peoplemon information. More...

#include <Peoplemon.hpp>

Static Public Member Functions
static void	setDataSource (file::PeoplemonDB &data)
	Sets the data source for all peoplemon. Must remain in scope. More...

static Id	cast (unsigned int id)
	Casts an integer to a validated id. Returns Unknown if the id is invalid. More...

static const std::vector< Id > &	validIds ()
	Returtns the list of all valid ids. More...

static const std::string &	name (Id id)
	Returns the name of the given Peoplemon. More...

static const std::string &	description (Id id)
	Returns the description of the given Peoplemon. More...

static Type	type (Id id)
	Returns the type of the Peoplemon. More...

static SpecialAbility	specialAbility (Id id)
	Returns the ability of the given peoplemon, if any. More...

static const Stats &	baseStats (Id id)
	Returns the base stats for the given peoplemon. More...

static bool	canLearnMove (Id ppl, MoveId move)
	Returns whether or not the given Peoplemon can learn the given move. More...

static MoveId	moveLearnedAtLevel (Id ppl, unsigned int level)
	Returns the move the peoplemon learns at the given level, if any. More...

static unsigned int	evolveLevel (Id id)
	Returns the minimum level that the given peoplemon will evolve at. More...

static Id	evolvesInto (Id orig)
	Returns what the given peoplemon will evolve into. More...

static Id	evolvesFrom (Id evolved)
	Returns what the given Peoplemon evolved from. This is expensive. More...

static const Stats &	evAward (Id id)
	Returns the ev points awarded for defeating the given peoplemon. More...

static int	xpYieldMultiplier (Id id)
	Returns the multiplier used when computing the XP award for defeating the given peoplemon. More...

static unsigned int	levelUpXp (Id id, unsigned int level)
	Returns the XP required to level up the given peoplemon. More...

static std::string	thumbnailImage (Id id)
	Returns the path of the image to render as the peoplemon thumbnail. More...

static std::string	playerImage (Id id)
	Returns the full path to the image to use in battle for the player peoplemon. More...

static std::string	opponentImage (Id id)
	Returns the full path to the image to use in battle for the opponent peoplemon. More...

static float	catchRate (Id id)
	Returns the base catch rate for the given peoplemon. More...

static bool	canClone (Id id)
	Returns whether or not the given Peoplemon may be cloned. More...

static std::string	ailmentString (Ailment ailment)
	Returns the name of the given ailment as a string. More...

static const std::string &	abilityName (SpecialAbility ability)
	Returns the name of the given special ability. More...

static const std::string &	abilityDescription (SpecialAbility ability)
	Returns the description of the given special ability. More...

Detailed Description

Serves as the primary store of all Peoplemon information.

Definition at line 35 of file Peoplemon.hpp.

Member Function Documentation

◆ abilityDescription()

const std::string & core::pplmn::Peoplemon::abilityDescription ( SpecialAbility ability )

static

Returns the description of the given special ability.

Parameters

ability The ability to get the description of

Returns: const std::string& The description of the ability

Definition at line 268 of file Peoplemon.cpp.

◆ abilityName()

const std::string & core::pplmn::Peoplemon::abilityName ( SpecialAbility ability )

static

Returns the name of the given special ability.

Parameters

ability The ability to get the name of

Returns: const std::string& The name of the ability

Definition at line 263 of file Peoplemon.cpp.

◆ ailmentString()

std::string core::pplmn::Peoplemon::ailmentString ( Ailment ailment )

static

Returns the name of the given ailment as a string.

Parameters

ailment The ailment to get the name of

Returns: const std::string& The user facing text for the ailment

Definition at line 244 of file Peoplemon.cpp.

◆ baseStats()

const Stats & core::pplmn::Peoplemon::baseStats ( Id id )

static

Returns the base stats for the given peoplemon.

Parameters

id	The peoplemon to get base stats for

Returns: const Stats& The base stats of the given peoplemon

Definition at line 146 of file Peoplemon.cpp.

◆ canClone()

bool core::pplmn::Peoplemon::canClone ( Id id )

static

Returns whether or not the given Peoplemon may be cloned.

Parameters

id	The peoplemon to check

Returns: True if cloneable, false otherwise

Definition at line 242 of file Peoplemon.cpp.

◆ canLearnMove()

bool core::pplmn::Peoplemon::canLearnMove	(	Id	ppl,
		MoveId	move
	)

static

Returns whether or not the given Peoplemon can learn the given move.

Parameters

ppl	The peoplemon trying to learn
move	The move to be learned

Returns: True if the Peoplemon can learn it, false otherwise

Definition at line 152 of file Peoplemon.cpp.

◆ cast()

Id core::pplmn::Peoplemon::cast ( unsigned int id )

static

Casts an integer to a validated id. Returns Unknown if the id is invalid.

Parameters

id	The id to check

Returns: Id The corresponding Id, or Id::Unknown if invalid

Definition at line 112 of file Peoplemon.cpp.

◆ catchRate()

float core::pplmn::Peoplemon::catchRate ( Id id )

static

Returns the base catch rate for the given peoplemon.

Parameters

id	The peoplemon to get the catch rate for

Returns: float The base catch rate for the given peoplemon

Definition at line 237 of file Peoplemon.cpp.

◆ description()

const std::string & core::pplmn::Peoplemon::description ( Id id )

static

Returns the description of the given Peoplemon.

Parameters

id	The peoplemon to get the description of

Returns: const std::string& The description of the peoplemon

Definition at line 131 of file Peoplemon.cpp.

◆ evAward()

const Stats & core::pplmn::Peoplemon::evAward ( Id id )

static

Returns the ev points awarded for defeating the given peoplemon.

Parameters

id	The peoplemon that was defeated

Returns: const Stats& The EVs awarded

Definition at line 176 of file Peoplemon.cpp.

◆ evolveLevel()

unsigned int core::pplmn::Peoplemon::evolveLevel ( Id id )

static

Returns the minimum level that the given peoplemon will evolve at.

Parameters

id	The peoplemon to check

Returns: unsigned int The level to evolve at. Over 100 means no evolution

Definition at line 166 of file Peoplemon.cpp.

◆ evolvesFrom()

Id core::pplmn::Peoplemon::evolvesFrom ( Id evolved )

static

Returns what the given Peoplemon evolved from. This is expensive.

Parameters

evolved The peoplemon to work backwards from

Returns: Id The peoplemon that was evolved from, if any

Definition at line 204 of file Peoplemon.cpp.

◆ evolvesInto()

Id core::pplmn::Peoplemon::evolvesInto ( Id orig )

static

Returns what the given peoplemon will evolve into.

Parameters

orig	The peoplemon that is evolving

Returns: Id The peoplemon that is being evolved into

Definition at line 171 of file Peoplemon.cpp.

◆ levelUpXp()

unsigned int core::pplmn::Peoplemon::levelUpXp	(	Id	id,
		unsigned int	level
	)

static

Returns the XP required to level up the given peoplemon.

Parameters

id	The peoplemon trying to level up
level	The current level of the peoplemon

Returns: unsigned int The XP required to advance to the next level

Definition at line 187 of file Peoplemon.cpp.

◆ moveLearnedAtLevel()

MoveId core::pplmn::Peoplemon::moveLearnedAtLevel	(	Id	ppl,
		unsigned int	level
	)

static

Returns the move the peoplemon learns at the given level, if any.

Parameters

ppl	The peoplemon that levled up
level	The level reached

Returns: MoveId The move to learn, if any

Definition at line 157 of file Peoplemon.cpp.

◆ name()

const std::string & core::pplmn::Peoplemon::name ( Id id )

static

Returns the name of the given Peoplemon.

Parameters

id	The peoplemon to get the name of

Returns: const std::string& The name of the peoplemon

Definition at line 126 of file Peoplemon.cpp.

◆ opponentImage()

std::string core::pplmn::Peoplemon::opponentImage ( Id id )

static

Returns the full path to the image to use in battle for the opponent peoplemon.

Parameters

id	The id of the peoplemon to get the image for

Returns: std::string The image file to use

Definition at line 228 of file Peoplemon.cpp.

◆ playerImage()

std::string core::pplmn::Peoplemon::playerImage ( Id id )

static

Returns the full path to the image to use in battle for the player peoplemon.

Parameters

id	The id of the peoplemon to get the image for

Returns: std::string The image file to use

Definition at line 219 of file Peoplemon.cpp.

◆ setDataSource()

void core::pplmn::Peoplemon::setDataSource ( file::PeoplemonDB & data )

static

Sets the data source for all peoplemon. Must remain in scope.

Parameters

data	The data source. Must remain in scope

Definition at line 94 of file Peoplemon.cpp.

◆ specialAbility()

SpecialAbility core::pplmn::Peoplemon::specialAbility ( Id id )

static

Returns the ability of the given peoplemon, if any.

Parameters

id	The peoplemon to get the ability for

Returns: SpecialAbility The ability of the peoplemon

Definition at line 141 of file Peoplemon.cpp.

◆ thumbnailImage()

std::string core::pplmn::Peoplemon::thumbnailImage ( Id id )

static

Returns the path of the image to render as the peoplemon thumbnail.

Parameters

id	The id of the peoplemon

Returns: std::string The image to use as the thumbnail

Definition at line 211 of file Peoplemon.cpp.

◆ type()

Type core::pplmn::Peoplemon::type ( Id id )

static

Returns the type of the Peoplemon.

Parameters

id	The Peoplemon to get the type of

Returns: Type The type of the given Peoplemon

Definition at line 136 of file Peoplemon.cpp.

◆ validIds()

const std::vector< Id > & core::pplmn::Peoplemon::validIds ( )

static

Returtns the list of all valid ids.

Returns: std::vector<Id> A vector containing all valid ids

Definition at line 118 of file Peoplemon.cpp.

◆ xpYieldMultiplier()

int core::pplmn::Peoplemon::xpYieldMultiplier ( Id id )

static

Returns the multiplier used when computing the XP award for defeating the given peoplemon.

Parameters

id	The peoplemon that was defeated

Returns: int The XP reward multiplier

Definition at line 182 of file Peoplemon.cpp.

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

include/Core/Peoplemon/Peoplemon.hpp
src/Core/Peoplemon/Peoplemon.cpp

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ abilityDescription()

◆ abilityName()

◆ ailmentString()

◆ baseStats()

◆ canClone()

◆ canLearnMove()

◆ cast()

◆ catchRate()

◆ description()

◆ evAward()

◆ evolveLevel()

◆ evolvesFrom()

◆ evolvesInto()

◆ levelUpXp()

◆ moveLearnedAtLevel()

◆ name()

◆ opponentImage()

◆ playerImage()

◆ setDataSource()

◆ specialAbility()

◆ thumbnailImage()

◆ type()

◆ validIds()

◆ xpYieldMultiplier()