ComponentSoundT Class Reference

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

Inheritance diagram for ComponentSoundT:

Public Member Functions
	Play ()
	This method plays the sound once. More...
Public Member Functions inherited from ComponentBaseT
any	get (string var_name)
	Returns the value of an attribute (a member variable) of this class. More...
	set (string var_name, any new_value)
	Sets an attribute (a member variable) of this class to a new value. More...
string	GetExtraMessage (string var_name)
	Returns the result of VarBaseT::GetExtraMessage() for the given member variable. More...
	interpolate (string var_name, number start_value, number end_value, number time)
	Schedules a value for interpolation between a start and end value over a given period of time. More...
EntityT	GetEntity ()
	Returns the entity that this component is a part of (or nil if the component is currently "stand-alone", not a part of any entity). More...
	InitClientApprox (string VarName)
	Registers the given attribute (a member variable) of this class for interpolation over client frames in order to bridge the larger intervals between server frames. More...
	OnInit ()
	This method is called for each component of each entity as the last step of initializing a newly loaded map. More...
	OnClientFrame (number t)
	This method is called for each component of each entity before the client renders the next frame. More...

Public Attributes
string	Name
	The name of the sound shader or sound file to play. More...
boolean	AutoPlay
	Whether the sound is played automatically in interval-spaced loops. More...
number	Interval
	If m_AutoPlay is true, this is the time in seconds between successive playbacks of the sound. More...

Detailed Description

This component adds 3D sound output to its entity.

Note that the variables of this class (also referred to as "Public Attributes" or "Member Data") must be used with the get() and set() methods at this time – see get() and set() for details.

If you would like to create a new component of this type explicitly (those defined in the CaWE Map Editor are instantiated automatically), use WorldT::new():

local comp = world:new("ComponentSoundT")

Implementing C++ Class:

cf::GameSys::ComponentSoundT

Member Function Documentation

Play

(

)

This method plays the sound once.

Member Data Documentation

boolean AutoPlay

Whether the sound is played automatically in interval-spaced loops.

If false, playbacks of the sound must be triggered by explicit calls to the Play() method.

Related C++ type:

bool

number Interval

If m_AutoPlay is true, this is the time in seconds between successive playbacks of the sound.

Related C++ type:

float

string Name

The name of the sound shader or sound file to play.

Related C++ type:

std::string