ProtoZed  awesome branch
A simple but powerful game framework
Public Member Functions | Static Public Attributes | List of all members
PZ::SoundEmitter Class Reference
Inheritance diagram for PZ::SoundEmitter:
PZ::Component PZ::NonCopyable PZ::PropertyList PZ::EventHandler

Public Member Functions

 SoundEmitter ()
 
 ~SoundEmitter ()
 
void Play ()
 
void Stop ()
 
const std::string & GetSound () const
 
float GetVolume () const
 
bool IsPlaying () const
 
bool IsRepeating () const
 
float GetMinDistance () const
 
float GetAttenuation () const
 
- Public Member Functions inherited from PZ::Component
virtual ~Component ()
 
virtual void Init ()
 Initializes the component.
 
virtual void Destroy ()
 Destroys the component.
 
virtual void Update (float deltaTime)
 Runs an update.
 
Application & GetApplication () const
 
EntityID GetOwnerID () const
 
MetaEntity GetOwnerEntity () const
 
EntityManager & GetManager () const
 
const Timestamp & GetTimestamp () const
 Gets the timestamp for when this component was last updated.
 
- Public Member Functions inherited from PZ::PropertyList
 PropertyList ()
 
virtual ~PropertyList ()
 
bool AddProperty (PropertyBase &prop)
 
bool RemoveProperty (const std::string &name)
 
void ClearProperties ()
 
bool HasProperty (const std::string &name) const
 
PropertyBase & GetProperty (const std::string &name)
 
const PropertyBase & GetProperty (const std::string &name) const
 
template<typename T >
Property< T > & GetProperty (const std::string &name)
 
template<typename T >
const Property< T > & GetProperty (const std::string &name) const
 
const PropertyMap & GetAllProperties () const
 
- Public Member Functions inherited from PZ::EventHandler
 EventHandler ()
 
virtual ~EventHandler ()
 
bool SubscribeTo (EventHandler &handler)
 
bool UnsubscribeTo (EventHandler &handler)
 
template<class T , class EventT >
bool RegisterEvent (T *obj, void(T::*memFn)(EventT &))
 
template<class T , class EventT >
bool UnregisterEvent (T *obj, void(T::*memFn)(EventT &))
 
void HandleEvent (const Event &e)
 
void EmitEvent (const Event &e) const
 

Static Public Attributes

static const HashString Family
 

Additional Inherited Members

- Protected Member Functions inherited from PZ::Component
 Component ()
 Default constructor.
 
void UpdateTimestamp ()
 
virtual void PropertyUpdated (const PropertyBase &prop)
 

Constructor & Destructor Documentation

PZ::SoundEmitter::SoundEmitter ( )
PZ::SoundEmitter::~SoundEmitter ( )

Member Function Documentation

float PZ::SoundEmitter::GetAttenuation ( ) const
inline
float PZ::SoundEmitter::GetMinDistance ( ) const
inline
const std::string& PZ::SoundEmitter::GetSound ( ) const
inline
float PZ::SoundEmitter::GetVolume ( ) const
inline
bool PZ::SoundEmitter::IsPlaying ( ) const
inline
bool PZ::SoundEmitter::IsRepeating ( ) const
inline
void PZ::SoundEmitter::Play ( )
void PZ::SoundEmitter::Stop ( )

Member Data Documentation

const HashString PZ::SoundEmitter::Family
static

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