PlayAudioAction Class Reference

More...

#include <PlayAudioAction.h>

Inheritance diagram for PlayAudioAction:

Collaboration diagram for PlayAudioAction:

Public Member Functions
	PlayAudioAction ()=default
	PlayAudioAction (const PlayAudioAction &)=default
auto	operator= (const PlayAudioAction &) -> PlayAudioAction &=default
	~PlayAudioAction () override=default
	PlayAudioAction (PlayAudioAction &&other) noexcept=default
auto	operator= (PlayAudioAction &&other) noexcept -> PlayAudioAction &=default
	PlayAudioAction (std::string soundEffect)
	PlayAudioAction (std::string soundEffect, float duration)
	PlayAudioAction (std::string soundEffect, float duration, const th::Bezier &easingFunction, float initialDelay, float endingDelay)
auto	init () -> void override
	Virtual function that is called once, when the Action is first starting up.
auto	execute () -> void override
	Virtual function that is called every frame to change a game object.
auto	end () -> void override
	Virtual function that is called once, when an Action is finished executing.
auto	ActionShowMenu () -> void override
	Displays a window in imgui.
auto	render () const -> void override
	Function used to draw things to screen, useful for things such as debug drawing.
auto	setModulated (bool state) -> void
Public Member Functions inherited from Action
	Action ()=default
	Action (const Action &)=default
auto	operator= (const Action &) -> Action &=default
virtual	~Action ()=default
	Action (Action &&other) noexcept=default
auto	operator= (Action &&other) noexcept -> Action &=default
auto	operator== (const Action &other) const -> bool
	Action (std::string name)
	Action (std::string name, float duration)
	Action (std::string name, float duration, const th::Bezier &bezierCurve, float initialDelay, float endingDelay)
auto	update (float dt) -> void
	Universal update function that handles calling init, update, and end at the right time.
auto	shouldRemove () const -> bool
auto	getOwner () const -> Entity *
auto	setOwner (Entity *newObject) -> void
auto	getHasInitialized () const -> bool
auto	getHasExecuted () const -> bool
auto	getHasEnded () const -> bool
auto	isPaused () const -> bool
auto	setPaused (bool newState) -> void
auto	isBlocking () const -> bool
auto	setBlocking (bool newState) -> void
auto	setInitialDelay (float delay) -> void
auto	getInitialDelay () const -> float
auto	setDuration (float duration) -> void
auto	getDuration () const -> float
auto	setEndingDelay (float delay) -> void
auto	getEndingDelay () const -> float
auto	getTotalLifetime () const -> float
auto	getName () -> std::string
	Function used for displaying info about what an Action does.
auto	getCompletionPercentage () const -> float
	Function used to see how much the action has completed.
auto	getCurve () const -> th::Bezier
	Function used to see which type of curve an action has.
auto	setCurve (const th::Bezier &curve) -> void
	set the curve of the function

Private Attributes
std::string	soundEffect
bool	modulated = false

Additional Inherited Members
Protected Member Functions inherited from Action
auto	percentageComplete () const -> float
template<typename T>
auto	lerpBasedOnTime (const T &start, const T &end) -> T
Protected Attributes inherited from Action
Entity *	changingObject = nullptr
std::string	actionName = "BaseAction"
bool	blocking = false
	If an action is blocking, it stops all actions after it in an ActionList from updating.

Detailed Description

@PlaySoundEffectAction.h

Constructor & Destructor Documentation

PlayAudioAction() [1/6]

PlayAudioAction::PlayAudioAction ( )

default

Here is the caller graph for this function:

PlayAudioAction() [2/6]

PlayAudioAction::PlayAudioAction ( const PlayAudioAction & )

default

Here is the call graph for this function:

~PlayAudioAction()

PlayAudioAction::~PlayAudioAction ( )

overridedefault

PlayAudioAction() [3/6]

PlayAudioAction::PlayAudioAction ( PlayAudioAction && other )

defaultnoexcept

Here is the call graph for this function:

PlayAudioAction() [4/6]

PlayAudioAction::PlayAudioAction

(

std::string

soundEffect

)

Here is the call graph for this function:

PlayAudioAction() [5/6]

PlayAudioAction::PlayAudioAction	(	std::string	soundEffect,
		float	duration )

Here is the call graph for this function:

PlayAudioAction() [6/6]

PlayAudioAction::PlayAudioAction	(	std::string	soundEffect,
		float	duration,
		const th::Bezier &	easingFunction,
		float	initialDelay,
		float	endingDelay )

Here is the call graph for this function:

Member Function Documentation

ActionShowMenu()

void PlayAudioAction::ActionShowMenu ( ) ->void

overridevirtual

Displays a window in imgui.

Reimplemented from Action.

end()

auto PlayAudioAction::end ( ) ->void

overridevirtual

Virtual function that is called once, when an Action is finished executing.

Reimplemented from Action.

execute()

auto PlayAudioAction::execute ( ) ->void

overridevirtual

Virtual function that is called every frame to change a game object.

Reimplemented from Action.

init()

auto PlayAudioAction::init ( ) ->void

overridevirtual

Virtual function that is called once, when the Action is first starting up.

Reimplemented from Action.

Here is the call graph for this function:

operator=() [1/2]

auto PlayAudioAction::operator= ( const PlayAudioAction & ) ->PlayAudioAction &=default

default

Here is the call graph for this function:

operator=() [2/2]

auto PlayAudioAction::operator= ( PlayAudioAction && other ) ->PlayAudioAction &=default

defaultnoexcept

Here is the call graph for this function:

render()

void PlayAudioAction::render ( ) const->void

overridevirtual

Function used to draw things to screen, useful for things such as debug drawing.

Todo

: Implement debug draw rendering

Reimplemented from Action.

setModulated()

auto PlayAudioAction::setModulated

(

bool

state

)

->void

Member Data Documentation

modulated

bool PlayAudioAction::modulated = false

private

soundEffect

std::string PlayAudioAction::soundEffect

private

---

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

• /home/egrazil/sites/Brunot/The House/source/Actions/PlayAudioAction.h
• /home/egrazil/sites/Brunot/The House/source/Actions/PlayAudioAction.cpp