Referencia de la clase Tapioca::AudioSourceComponent

Componente que se encarga de reproducir sonidos en el juego. Más...

#include <AudioSourceComponent.h>

Diagrama de herencia de Tapioca::AudioSourceComponent

Métodos públicos
	AudioSourceComponent ()
	Constructor por defecto.
	~AudioSourceComponent ()
	Destructor por defecto.
bool	initComponent (const CompMap &variables) override
	Metodo que se usa para recibir los parametros iniciales y guardarlos. No garantiza que todos los componentes iniciales esten creados.
void	awake () override
	Inicializa el componente. Se ejecuta antes que el start Garantiza que todos los componentes iniciales esten creados.
void	handleEvent (std::string const &id, void *info) override
	Recibe eventos. Se llama nada mas se recibe el evento, si es un evento de ventana se recibe en el pushEvent.
void	playOnce ()
	Reproduce el sonido una vez.
void	playLooped ()
	Reproduce el sonido en bucle.
void	stop ()
	Para la reproduccion del sonido.
bool	isPaused ()
	Devuelve si el sonido esta pausado.
bool	hasFinished ()
	Devuelve si ha terminado de reproducirse el sonido.
bool	hasStopped ()
	Devuelve si el sonido no esta reproduciendose.
void	pause (bool p)
	Pausa o reanuda la reproduccion del sonido.
void	loop (bool l)
	Indica si el sonido se reproduce en bucle o no.
void	setVolume (float v)
	Establece el volumen de reproduccion del sonido.
Métodos públicos heredados de Tapioca::Component
	Component ()
	Constructor de la clase Component.
virtual	~Component ()
	Destructor de la clase Component.
virtual void	start ()
	Inicializa el componente Garantiza que todos los componentes iniciales esten creados.
virtual void	update (const uint64_t deltaTime)
	Actualiza el estado de un componente. Se llama todas las veces posibles.
virtual void	fixedUpdate ()
	Actualiza el estado de un componente Se llama cada cierto tiempo fijo (Game::FIXED_DELTA_TIME),.
virtual void	render () const
	Renderizado de un componente.
virtual void	updateUI ()
	Actualiza la interfaz de usuario.
void	pushEvent (std::string const &id, void *info, const bool global=true, const bool delay=false)
	Envia un evento.
template<typename T >
bool	setValueFromMap (T &var, std::string const &varName, const CompMap &map)
	Da valor a una variable declarada en un CompMap.
GameObject *	getObject () const
	Devuelve el objeto al que esta adjunto este componente.
bool	isAlive () const
	Devuelve si el componente esta "vivo" (si se actualizan update, handleEvents, ...)
bool	isActive () const
	Devuelve si el componente esta activo (si es 'false' no se llama a ningun metodo excepto 'receiveEvent')
void	die ()
	Borra el componente.
virtual void	setActive (const bool b)
	Activa o desactiva el componente (si es 'false' no se llama a ningun metodo excepto 'receiveEvent')

Otros miembros heredados
Atributos protegidos heredados de Tapioca::Component
GameObject *	object
bool	alive
bool	active

Descripción detallada

Componente que se encarga de reproducir sonidos en el juego.

Documentación de constructores y destructores

AudioSourceComponent()

Tapioca::AudioSourceComponent::AudioSourceComponent

(

)

Constructor por defecto.

~AudioSourceComponent()

Tapioca::AudioSourceComponent::~AudioSourceComponent

(

)

Destructor por defecto.

Documentación de funciones miembro

awake()

void Tapioca::AudioSourceComponent::awake ( )

overridevirtual

Inicializa el componente. Se ejecuta antes que el start Garantiza que todos los componentes iniciales esten creados.

Reimplementado de Tapioca::Component.

handleEvent()

void Tapioca::AudioSourceComponent::handleEvent ( std::string const & id, void * info )

overridevirtual

Recibe eventos. Se llama nada mas se recibe el evento, si es un evento de ventana se recibe en el pushEvent.

Parámetros

id	Indica el tipo de mensaje
info	Puntero a void para pasar parametros

Reimplementado de Tapioca::Component.

hasFinished()

bool Tapioca::AudioSourceComponent::hasFinished

(

)

Devuelve si ha terminado de reproducirse el sonido.

Devuelve

Devuelve true si el sonido ha terminado, false para lo contrario.

hasStopped()

bool Tapioca::AudioSourceComponent::hasStopped

(

)

Devuelve si el sonido no esta reproduciendose.

Devuelve

Devuelve false si el sonido esta reproduciendose, true para lo contrario.

initComponent()

bool Tapioca::AudioSourceComponent::initComponent ( const CompMap & variables )

overridevirtual

Metodo que se usa para recibir los parametros iniciales y guardarlos. No garantiza que todos los componentes iniciales esten creados.

Parámetros

variables

unordered_map con los parametros iniciales

Devuelve

Devuelve true si se ha inicializado correctamente, false en caso contrario

Reimplementado de Tapioca::Component.

isPaused()

bool Tapioca::AudioSourceComponent::isPaused

(

)

Devuelve si el sonido esta pausado.

Devuelve

Devuelve true si el sonido esta pausado, false para lo contrario.

loop()

void Tapioca::AudioSourceComponent::loop

(

bool

l

)

Indica si el sonido se reproduce en bucle o no.

Parámetros

l	Indica si el sonido se reproduce en bucle o no

pause()

void Tapioca::AudioSourceComponent::pause

(

bool

p

)

Pausa o reanuda la reproduccion del sonido.

Parámetros

p	Indica si se pausa o reanuda la reproduccion

playLooped()

void Tapioca::AudioSourceComponent::playLooped

(

)

Reproduce el sonido en bucle.

playOnce()

void Tapioca::AudioSourceComponent::playOnce

(

)

Reproduce el sonido una vez.

setVolume()

void Tapioca::AudioSourceComponent::setVolume

(

float

v

)

Establece el volumen de reproduccion del sonido.

Parámetros

v	Volumen de reproduccion del sonido

stop()

void Tapioca::AudioSourceComponent::stop

(

)

Para la reproduccion del sonido.

---

La documentación de esta clase está generada de los siguientes archivos:

• src/Sound/Components/AudioSourceComponent.h
• src/Sound/Components/AudioSourceComponent.cpp