tram::Sound Class Reference

#include <sound.h>

Inheritance diagram for tram::Sound:

Public Member Functions
	Sound (const SharedEntityData &, const ValueArray &)
	Sound (name_t sound, float volume, vec3 position)
	PLays a sound, then removes itself. More...
void	UpdateParameters ()
void	SetParameters ()
void	Load ()
void	Unload ()
void	Serialize ()
void	MessageHandler (Message &msg)
name_t	GetType ()
Public Member Functions inherited from tram::Entity
	Entity ()
	Entity (name_t name)
	Entity (const SharedEntityData &)
virtual	~Entity ()
name_t	GetName () const
id_t	GetID () const
WorldCell *	GetCell ()
bool	IsLoaded () const
bool	IsAutoLoad () const
bool	IsInInterior () const
bool	IsPersistent () const
bool	IsChanged () const
virtual void	Update ()
void	SetAutoLoad (bool auto_load)
void	SetPersistent (bool persistent)
void	SetLocation (vec3 loc)
void	SetRotation (quat rot)
void	UpdateTransform (const vec3 &loc, const quat &rot)
const vec3 &	GetLocation ()
const quat &	GetRotation ()
virtual void	EventHandler (Event &event)
void	CheckTransition ()
SignalTable *	GetSignalTable ()

Static Public Member Functions
static void	Register ()
Static Public Member Functions inherited from tram::Entity
static void	RegisterType (name_t name, Entity *(*constr_func)(const SharedEntityData &, const ValueArray &), void(*destr_func)(Entity *), const uint32_t *fields, size_t fieldcount)
static void	RegisterType (name_t name, Entity *(*constr_func)(const SharedEntityData &, const ValueArray &), void(*destr_func)(Entity *), std::initializer_list< FieldInfo > fields)
static void	UpdateFromList ()
	Updates all of the entities in the update list. More...
static Entity *	Make (name_t type, File *file)
	Loads an Entity from a File. More...
static Entity *	Find (id_t entity_id)
static Entity *	Find (name_t entity_name)

Protected Attributes
Component< AudioComponent >	audio
name_t	sound
float	volume
int	sound_flags
Protected Attributes inherited from tram::Entity
id_t	id = 0
name_t	name
uint32_t	flags = 0
bool	is_persistent = true
bool	is_loaded = false
bool	auto_load = true
bool	in_interior = false
bool	changed = false
bool	is_serializable = true
WorldCell *	cell = nullptr
SignalTable *	signals = nullptr
quat	rotation = {1.0f, 0.0f, 0.0f, 0.0f}
vec3	location = {0.0f, 0.0f, 0.0f}

Additional Inherited Members
Public Types inherited from tram::Entity
enum	: uint32_t { FIELD_SERIALIZE = 1 }
Protected Member Functions inherited from tram::Entity
void	Register ()
void	FireSignal (signal_t type)
void	FireSignal (signal_t type, Value value)
void	AddUpdate ()
	Adds entity to update list. More...
void	RemoveUpdate ()
	Remove entity from the update list. More...

Constructor & Destructor Documentation

Sound() [1/2]

tram::Sound::Sound	(	const SharedEntityData &	,
		const ValueArray &
	)

Sound() [2/2]

tram::Sound::Sound	(	name_t	sound,
		float	volume,
		vec3	position
	)

PLays a sound, then removes itself.

Member Function Documentation

GetType()

name_t tram::Sound::GetType ( )

virtual

Implements tram::Entity.

Load()

void tram::Sound::Load ( )

virtual

Implements tram::Entity.

MessageHandler()

void tram::Sound::MessageHandler ( Message &  msg )

virtual

Implements tram::Entity.

Register()

void tram::Sound::Register ( )

static

Serialize()

void tram::Sound::Serialize ( )

virtual

Implements tram::Entity.

SetParameters()

void tram::Sound::SetParameters ( )

virtual

Implements tram::Entity.

Unload()

void tram::Sound::Unload ( )

virtual

Implements tram::Entity.

UpdateParameters()

void tram::Sound::UpdateParameters ( )

virtual

Implements tram::Entity.

Member Data Documentation

audio

Component<AudioComponent> tram::Sound::audio

protected

sound

name_t tram::Sound::sound

protected

sound_flags

int tram::Sound::sound_flags

protected

volume

float tram::Sound::volume

protected

---

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

• C:/Users/Poga/Desktop/painis/tram-sdk/src/entities/sound.h
• C:/Users/Poga/Desktop/painis/tram-sdk/src/entities/sound.cpp