core::battle::cmd::Animation Struct Reference

Represents a type of animation that can be played in battle. More...

#include <Animation.hpp>

Public Types
enum class	Type : std::uint8_t {   _ERROR = 0 , ShakeAndFlash = 1 , SlideDown , ComeBack ,   SendOut , UseMove , PlayerFirstSendout , OpponentFirstSendout ,   StatIncrease , MultipleStateIncrease , StatDecrease , MultipleStateDecrease ,   SlideOut , Ailment , PassiveAilment , MakeWildVisible ,   ThrowPeopleball , PeopleballShake , PeopleballCaught , ThrowCloneBall }
	The type of animation to play. More...

Public Member Functions
	Animation (Type type)
	For animations that are not specific to either battler. More...
	Animation (bool forHost, Type type)
	Construct a new Animation for a non-move effect. More...
	Animation (bool forHost, core::pplmn::MoveId move)
	Construct a new Animation for the attack animation. More...
	Animation (bool forHost, Type type, pplmn::Stat stat)
	Construct a new Animation for a stat increase or decrease. More...
	Animation (bool forHost, pplmn::Ailment ailment)
	Construct a new Animation for the given ailment. More...
	Animation (bool forHost, pplmn::PassiveAilment ailment)
	Construct a new Animation for the given ailment. More...
	Animation (bool forHost, Type type, item::Id peopleball)
	Construct a new Animation for a peopleball. More...
bool	forHostBattler () const
	Returns whether or not this animation is for the host or not. More...
Type	getType () const
	Returns the type of animation to play. More...
pplmn::MoveId	getMove () const
	Returns the move for this animation. More...
pplmn::Stat	getStat () const
	Returns the stat for this animation. More...
pplmn::Ailment	getAilment () const
	Get the ailment for this animation. More...
pplmn::PassiveAilment	getPassiveAilment () const
	Get the ailment for this animation. More...
item::Id	getPeopleball () const
	Get the Peopleball for this animation. More...

Detailed Description

Represents a type of animation that can be played in battle.

Definition at line 25 of file Animation.hpp.

Member Enumeration Documentation

Type

enum core::battle::cmd::Animation::Type : std::uint8_t

strong

The type of animation to play.

Enumerator
_ERROR
ShakeAndFlash
SlideDown
ComeBack
SendOut
UseMove
PlayerFirstSendout
OpponentFirstSendout
StatIncrease
MultipleStateIncrease
StatDecrease
MultipleStateDecrease
SlideOut
Ailment
PassiveAilment
MakeWildVisible
ThrowPeopleball
PeopleballShake
PeopleballCaught
ThrowCloneBall

Definition at line 30 of file Animation.hpp.

Constructor & Destructor Documentation

Animation() [1/7]

core::battle::cmd::Animation::Animation

(

Type

type

)

For animations that are not specific to either battler.

Parameters

type	The type of animation to play

Definition at line 9 of file Animation.cpp.

Animation() [2/7]

core::battle::cmd::Animation::Animation	(	bool	forHost,
		Type	type
	)

Construct a new Animation for a non-move effect.

Parameters

forHost	True to play on the host battler, false for other
type	The type of animation to play

Definition at line 14 of file Animation.cpp.

Animation() [3/7]

core::battle::cmd::Animation::Animation	(	bool	forHost,
		core::pplmn::MoveId	move
	)

Construct a new Animation for the attack animation.

Parameters

forHost	True to play on the host battler, false for other
moveIndex	Which move is being used [0, 3]

Definition at line 19 of file Animation.cpp.

Animation() [4/7]

core::battle::cmd::Animation::Animation	(	bool	forHost,
		Type	type,
		pplmn::Stat	stat
	)

Construct a new Animation for a stat increase or decrease.

Parameters

forHost	True to play on the host battler, false for other
type	Which type of stat change
stat	The stat being changed

Definition at line 24 of file Animation.cpp.

Animation() [5/7]

core::battle::cmd::Animation::Animation	(	bool	forHost,
		pplmn::Ailment	ailment
	)

Construct a new Animation for the given ailment.

Parameters

forHost	True to play on the host battler, false for other
ailment	The ailment animation to play

Definition at line 29 of file Animation.cpp.

Animation() [6/7]

core::battle::cmd::Animation::Animation	(	bool	forHost,
		pplmn::PassiveAilment	ailment
	)

Construct a new Animation for the given ailment.

Parameters

forHost	True to play on the host battler, false for other
ailment	The ailment animation to play

Definition at line 34 of file Animation.cpp.

Animation() [7/7]

core::battle::cmd::Animation::Animation	(	bool	forHost,
		Type	type,
		item::Id	peopleball
	)

Construct a new Animation for a peopleball.

Parameters

forHost	True to play on the host battler, false for other
type	The type of animation to play
peopleball	The peopleball to display

Definition at line 39 of file Animation.cpp.

Member Function Documentation

forHostBattler()

bool core::battle::cmd::Animation::forHostBattler

(

)

const

Returns whether or not this animation is for the host or not.

Definition at line 44 of file Animation.cpp.

getAilment()

pplmn::Ailment core::battle::cmd::Animation::getAilment

(

)

const

Get the ailment for this animation.

Definition at line 58 of file Animation.cpp.

getMove()

pplmn::MoveId core::battle::cmd::Animation::getMove

(

)

const

Returns the move for this animation.

Definition at line 48 of file Animation.cpp.

getPassiveAilment()

pplmn::PassiveAilment core::battle::cmd::Animation::getPassiveAilment

(

)

const

Get the ailment for this animation.

Definition at line 63 of file Animation.cpp.

getPeopleball()

item::Id core::battle::cmd::Animation::getPeopleball

(

)

const

Get the Peopleball for this animation.

Definition at line 68 of file Animation.cpp.

getStat()

pplmn::Stat core::battle::cmd::Animation::getStat

(

)

const

Returns the stat for this animation.

Definition at line 53 of file Animation.cpp.

getType()

Animation::Type core::battle::cmd::Animation::getType

(

)

const

Returns the type of animation to play.

Definition at line 46 of file Animation.cpp.

---

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

• include/Core/Battles/Commands/Animation.hpp
• src/Core/Battles/Commands/Animation.cpp