cf::GameSys::ComponentSoundT Class Reference

This component adds 3D sound output to its entity. More...

#include "CompSound.hpp"

Inheritance diagram for cf::GameSys::ComponentSoundT:

Public Member Functions
	ComponentSoundT ()
	The constructor. More...
	ComponentSoundT (const ComponentSoundT &Comp)
	The copy constructor. More...
	~ComponentSoundT ()
	The destructor. More...
ComponentSoundT *	Clone () const
	The virtual copy constructor. More...
const char *	GetName () const
	Returns the name of this component. More...
unsigned int	GetEditorColor () const
	Returns a color that the Map Editor can use to render the representation of this component's entity. More...
void	DoClientFrame (float t)
	Derived classes override this method in order to implement the real work proposed by OnClientFrame(), which explicitly calls this method for this purpose. More...
const cf::TypeSys::TypeInfoT *	GetType () const
Public Member Functions inherited from cf::GameSys::ComponentBaseT
	ComponentBaseT ()
	The constructor. More...
	ComponentBaseT (const ComponentBaseT &Comp)
	The copy constructor. More...
virtual	~ComponentBaseT ()
	The virtual destructor. More...
EntityT *	GetEntity () const
	Returns the parent entity that contains this component, or NULL if this component is currently not a part of any entity. More...
TypeSys::VarManT &	GetMemberVars ()
	Returns the variable manager that keeps generic references to our member variables, providing a simple kind of "reflection" or "type introspection" feature. More...
template<class T >
void	SetMember (const char *Name, const T &Value)
	Sets the member variable with the given name to the given value. More...
ArrayT< ApproxBaseT * > &	GetInterpolators ()
	Returns the interpolators that have been registered with this component. More...
bool	InitClientApprox (const char *VarName)
	Registers the member variable with the given name for interpolation over client frames in order to bridge the larger intervals between server frames. More...
void	Serialize (cf::Network::OutStreamT &Stream) const
	Writes the current state of this component into the given stream. More...
void	Deserialize (cf::Network::InStreamT &Stream, bool IsIniting)
	Reads the state of this component from the given stream, and updates the component accordingly. More...
bool	CallLuaMethod (const char *MethodName, int NumExtraArgs, const char *Signature="",...)
	Calls the given Lua method of this component. More...
virtual void	UpdateDependencies (EntityT *Entity)
	This method is called whenever something "external" to this component has changed: More...
virtual BoundingBox3fT	GetEditorBB () const
	Returns a bounding-box that the Map Editor can use to render the representation of this component's entity and for related hit tests in the 2D and 3D views after mouse clicks. More...
virtual BoundingBox3fT	GetCullingBB () const
	This method returns a bounding-box that encloses the visual representation of this component. More...
virtual const cf::ClipSys::ClipModelT *	GetClipModel ()
	This method returns the clip model of this component, if any. More...
virtual void	PreCache ()
	Initializes any resources that may be needed on the client or server ahead of time. More...
virtual bool	Render (bool FirstPersonView, float LodDist) const
	This method implements the graphical output of this component. More...
virtual void	PostRender (bool FirstPersonView)
	This method provides an opportunity for another render pass. More...
virtual void	OnPostLoad (bool OnlyStatic)
	This method is called after all entities and their components have been loaded. More...
virtual bool	OnInputEvent (const CaKeyboardEventT &KE)
	This method handles keyboard input events. More...
virtual bool	OnInputEvent (const CaMouseEventT &ME, float PosX, float PosY)
	This method handles mouse input events. More...
void	OnServerFrame (float t)
	Advances the component one frame (one "clock-tick") on the server. More...
void	OnClientFrame (float t)
	Advances the component one frame (one "clock-tick") on the client. More...
Public Member Functions inherited from RefCountedT
unsigned int	GetRefCount () const

Static Public Member Functions
static void *	CreateInstance (const cf::TypeSys::CreateParamsT &Params)
Static Public Member Functions inherited from cf::GameSys::ComponentBaseT
static void *	CreateInstance (const cf::TypeSys::CreateParamsT &Params)

Static Public Attributes
static const cf::TypeSys::TypeInfoT	TypeInfo
Static Public Attributes inherited from cf::GameSys::ComponentBaseT
static const cf::TypeSys::TypeInfoT	TypeInfo

Static Protected Member Functions
static int	Play (lua_State *LuaState)
static int	toString (lua_State *LuaState)
Static Protected Member Functions inherited from cf::GameSys::ComponentBaseT
static int	Get (lua_State *LuaState)
static int	Set (lua_State *LuaState)
static int	GetExtraMessage (lua_State *LuaState)
static int	Interpolate (lua_State *LuaState)
static int	GetEntity (lua_State *LuaState)
static int	InitClientApprox (lua_State *LuaState)
static int	toString (lua_State *LuaState)

Static Protected Attributes
static const luaL_Reg	MethodsList []
	The list of Lua methods for this class. More...
static const char *	DocClass
static const cf::TypeSys::MethsDocT	DocMethods []
static const cf::TypeSys::VarsDocT	DocVars []
Static Protected Attributes inherited from cf::GameSys::ComponentBaseT
static const luaL_Reg	MethodsList []
	The list of Lua methods for this class. More...
static const char *	DocClass
static const cf::TypeSys::MethsDocT	DocMethods []
static const cf::TypeSys::MethsDocT	DocCallbacks []

Additional Inherited Members
Protected Member Functions inherited from RefCountedT
	RefCountedT (const RefCountedT &)
RefCountedT &	operator= (const RefCountedT &)

Detailed Description

This component adds 3D sound output to its entity.

Constructor & Destructor Documentation

ComponentSoundT::ComponentSoundT

(

)

The constructor.

ComponentSoundT::ComponentSoundT

(

const ComponentSoundT &

Comp

)

The copy constructor.

Parameters

Comp	The component to create a copy of.

ComponentSoundT::~ComponentSoundT

(

)

The destructor.

Member Function Documentation

ComponentSoundT * ComponentSoundT::Clone ( ) const

virtual

The virtual copy constructor.

Callers can use this method to create a copy of this component without knowing its concrete type. Overrides in derived classes use a covariant return type to facilitate use when the concrete type is known. The newly cloned component is initially not a part of any entity, even if the source component was.

Reimplemented from cf::GameSys::ComponentBaseT.

void ComponentSoundT::DoClientFrame ( float  t )

virtual

Derived classes override this method in order to implement the real work proposed by OnClientFrame(), which explicitly calls this method for this purpose.

(This follows the "Non-Virtual Interface Idiom" as described by Scott Meyers in "Effective C++, 3rd Edition", item 35 ("Consider alternatives to virtual functions.").)

Reimplemented from cf::GameSys::ComponentBaseT.

unsigned int cf::GameSys::ComponentSoundT::GetEditorColor ( ) const

inlinevirtual

Returns a color that the Map Editor can use to render the representation of this component's entity.

The Map Editor may use the color of an entity's first component as returned by this method to render the visual representation of the entity.

Reimplemented from cf::GameSys::ComponentBaseT.

const char* cf::GameSys::ComponentSoundT::GetName ( ) const

inlinevirtual

Returns the name of this component.

Reimplemented from cf::GameSys::ComponentBaseT.

Member Data Documentation

const char * ComponentSoundT::DocClass

staticprotected

Initial value:

=
    "This component adds 3D sound output to its entity."

const cf::TypeSys::MethsDocT ComponentSoundT::DocMethods

staticprotected

Initial value:

=
{
    META_Play,
    META_toString,
    { NULL, NULL, NULL, NULL }
}

const cf::TypeSys::VarsDocT ComponentSoundT::DocVars

staticprotected

Initial value:

=
{
    { "Name",     "The name of the sound shader or sound file to play." },
    { "AutoPlay", "Whether the sound is played automatically in interval-spaced loops.\nIf `false`, playbacks of the sound must be triggered by explicit calls to the Play() method." },
    { "Interval", "If `m_AutoPlay` is `true`, this is the time in seconds between successive playbacks of the sound." },
    { NULL, NULL }
}

const luaL_Reg ComponentSoundT::MethodsList

staticprotected

Initial value:

=
{
    { "Play",       Play },
    { "__tostring", toString },
    { NULL, NULL }
}

The list of Lua methods for this class.

---

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

• Libs/GameSys/CompSound.hpp
• Libs/GameSys/CompSound.cpp