Tapioca Engine 1.0
Motor de videojuegos creado por Bubble Studios
Cargando...
Buscando...
Nada coincide
Métodos públicos | Amigas | Lista de todos los miembros
Referencia de la clase Tapioca::GameObject

Clase que representa un objeto en el juego. Más...

#include <GameObject.h>

Métodos públicos

 GameObject ()
 Inicializa en true el atributo alive.
 
 ~GameObject ()
 Elimina los componentes del objeto.
 
void awake ()
 Inicializa los componentes del objeto. Se ejecuta antes del start. Garantiza que todos los componentes iniciales esten creados.
 
void start ()
 Inicializa los componentes del objeto. Garantiza que todos los componentes iniciales esten creados.
 
void handleEvent (std::string const &id, void *info)
 Procesa un evento recibido.
 
std::string getHandler () const
 Devuelve el handler del objeto.
 
bool isAlive () const
 Devuelve si el objeto esta "vivo" (si se actualizan update, handleEvents,... y si se va a borrar).
 
void die ()
 Marca al objeto como "muerto" (se dejan de actualizar update, handleEvents,...) y se borra.
 
void setScene (Scene *const sc)
 Cambia la escena a la que pertence el gameObject.
 
ScenegetScene () const
 Devuelve puntero de la escena a la que pertenece el objeto.
 
void setZOrder (int zOrder)
 Cambia el zOrder a la que pertence el gameObject.
 
int getZOrder () const
 Devuelve el zOrder del objeto.
 
void addComponent (Component *const comp, std::string const &id)
 Anade un componente al objeto, no se deberia de usar en ejecucion.
 
ComponentaddComponent (const std::string &id, const CompMap &variables=CompMap())
 Anade un componente al objeto.
 
template<IsComponent TComp>
TComp * addComponent (const CompMap &variables=CompMap())
 Anade un componente al objeto.
 
std::vector< Component * > addComponents (const std::vector< std::pair< std::string, CompMap > > &idsAndVariables)
 Anade varios componentes al objeto.
 
ComponentgetComponent (std::string const &id)
 Devuelve un puntero a un componente del objeto.
 
template<IsComponent TComp>
TComp * getComponent ()
 Devuelve un puntero a un componente del objeto.
 
std::vector< Component * > getAllComponents ()
 Devuelve todos los componentes de este objeto.
 
std::vector< Component * > getComponents (std::string const &id)
 Devuelve todos los componentes del objeto con la id marcada.
 
template<IsComponent TComp>
std::vector< TComp * > getComponents ()
 Devuelve todos los componentes del objeto de la misma clase.
 
void pushEvent (std::string const &id, void *info, const bool global=true, const bool delay=false)
 Metodo que se usa para enviar un evento.
 

Amigas

class Scene
 

Descripción detallada

Clase que representa un objeto en el juego.

Documentación de constructores y destructores

◆ GameObject()

Tapioca::GameObject::GameObject ( )

Inicializa en true el atributo alive.

◆ ~GameObject()

Tapioca::GameObject::~GameObject ( )

Elimina los componentes del objeto.

Documentación de funciones miembro

◆ addComponent() [1/3]

void Tapioca::GameObject::addComponent ( Component *const comp,
std::string const & id )

Anade un componente al objeto, no se deberia de usar en ejecucion.

Parámetros
compComponente que se quiere anadir al objeto
idId del componente que se quiere anadir

◆ addComponent() [2/3]

template<IsComponent TComp>
TComp * Tapioca::GameObject::addComponent ( const CompMap & variables = CompMap())
inline

Anade un componente al objeto.

Parámetros
variablesVariables con las que se inicializa el componente
Devuelve
Puntero al componente anadido, nullptr si no se ha podido inicializar

◆ addComponent() [3/3]

Component * Tapioca::GameObject::addComponent ( const std::string & id,
const CompMap & variables = CompMap() )

Anade un componente al objeto.

Parámetros
idId del componente que se quiere anadir
variablesVariables con las que se inicializa el componente
Devuelve
Puntero al componente anadido, nullptr si no se ha podido inicializar

◆ addComponents()

std::vector< Component * > Tapioca::GameObject::addComponents ( const std::vector< std::pair< std::string, CompMap > > & idsAndVariables)

Anade varios componentes al objeto.

Parámetros
idsAndVariablesPareja de ids y variables para los componentes
Devuelve
Vector de punteros. Si no se ha podido inicializar un componente, se cancela la operacion completamente, borrando los componentes ya inicializados y devolviendo un vector vacio

◆ awake()

void Tapioca::GameObject::awake ( )

Inicializa los componentes del objeto. Se ejecuta antes del start. Garantiza que todos los componentes iniciales esten creados.

◆ die()

void Tapioca::GameObject::die ( )
inline

Marca al objeto como "muerto" (se dejan de actualizar update, handleEvents,...) y se borra.

◆ getAllComponents()

std::vector< Component * > Tapioca::GameObject::getAllComponents ( )

Devuelve todos los componentes de este objeto.

Devuelve
Vector que contiene los punteros de todos los componentes de este objeto

◆ getComponent() [1/2]

template<IsComponent TComp>
TComp * Tapioca::GameObject::getComponent ( )
inline

Devuelve un puntero a un componente del objeto.

Devuelve
Puntero al componente. nullptr si el objeto no contiene el componente

◆ getComponent() [2/2]

Component * Tapioca::GameObject::getComponent ( std::string const & id)

Devuelve un puntero a un componente del objeto.

Parámetros
idId del componente que se quiere conseguir del objeto
Devuelve
Puntero al componente. nullptr si el objeto no contiene el componente

◆ getComponents() [1/2]

template<IsComponent TComp>
std::vector< TComp * > Tapioca::GameObject::getComponents ( )
inline

Devuelve todos los componentes del objeto de la misma clase.

Devuelve
Vector que contiene los punteros de todos los componentes de la clase indicada

◆ getComponents() [2/2]

std::vector< Component * > Tapioca::GameObject::getComponents ( std::string const & id)

Devuelve todos los componentes del objeto con la id marcada.

Parámetros
idId de los componentes que se quieren obtener
Devuelve
Vector que contiene los punteros de todos los componentes con la id marcada

◆ getHandler()

std::string Tapioca::GameObject::getHandler ( ) const
inline

Devuelve el handler del objeto.

Devuelve
Handler del objeto

◆ getScene()

Scene * Tapioca::GameObject::getScene ( ) const
inline

Devuelve puntero de la escena a la que pertenece el objeto.

Devuelve
Escena a la que pertenece el objeto

◆ getZOrder()

int Tapioca::GameObject::getZOrder ( ) const
inline

Devuelve el zOrder del objeto.

Devuelve
zOrder del objeto

◆ handleEvent()

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

Procesa un evento recibido.

Parámetros
idIndica el tipo de evento
infoParametros del mensaje, cada evento gestiona sus propios parametros

◆ isAlive()

bool Tapioca::GameObject::isAlive ( ) const
inline

Devuelve si el objeto esta "vivo" (si se actualizan update, handleEvents,... y si se va a borrar).

Devuelve
true si esta "vivo", false en caso contrario

◆ pushEvent()

void Tapioca::GameObject::pushEvent ( std::string const & id,
void * info,
const bool global = true,
const bool delay = false )

Metodo que se usa para enviar un evento.

Parámetros
idIndica el tipo de mensaje
infoPuntero a void para pasar parametros
globalIndica si el evento debe ser enviado glabalmente
delayIndica si el evento se recibira un ciclo mas tarde. Si es false, se recibe immediatamente

◆ setScene()

void Tapioca::GameObject::setScene ( Scene *const sc)
inline

Cambia la escena a la que pertence el gameObject.

Parámetros
scEscena a la que se quiere mover el objeto

◆ setZOrder()

void Tapioca::GameObject::setZOrder ( int zOrder)
inline

Cambia el zOrder a la que pertence el gameObject.

Parámetros
zOrderzOrder al que se quiere mover el objeto

◆ start()

void Tapioca::GameObject::start ( )

Inicializa los componentes del objeto. Garantiza que todos los componentes iniciales esten creados.

Documentación de símbolos amigos y relacionados

◆ Scene

friend class Scene
friend

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