Collection¶

Amplitude collection asset.

Inherits the following classes: SparkyStudios::Audio::Amplitude::SoundObject, SparkyStudios::Audio::Amplitude::Asset

Detailed Description¶

A Collection is a container sound object that groups multiple sounds over the same name. Only one sound can be playing at a time in the same collection, and the sound picked for playback is chosen by the collection's Scheduler.

See also: SoundObject

Public Functions¶

Type	Name
virtual const std::vector< AmSoundID > &	GetSounds () const = 0 Returns the list of Sound objects referenced in this collection.
virtual void	ResetEntityScopeScheduler (const Entity & entity) = 0 Resets the internal state of the scheduler running for the given Entity .
virtual void	ResetWorldScopeScheduler () = 0 Resets the internal state of the scheduler running for the World.
virtual Sound *	SelectFromEntity (const Entity & entity, const std::unordered_set< AmSoundID > & toSkip) = 0 Returns a Sound from this collection from anEntity scope.
virtual Sound *	SelectFromWorld (const std::unordered_set< AmSoundID > & toSkip) const = 0 Picks a world-scoped Sound from this collection.

Public Functions inherited from SparkyStudios::Audio::Amplitude::SoundObject¶

See SparkyStudios::Audio::Amplitude::SoundObject

Type	Name
virtual const Attenuation *	GetAttenuation () const = 0 Gets the Attenuation object associated with this sound object.
virtual Bus	GetBus () const = 0 Returns the Bus this sound object will play on.
virtual const Effect *	GetEffect () const = 0 Gets the Effect object associated with this sound object.
virtual const RtpcValue &	GetGain () const = 0 Gets the linear gain of the sound object.
virtual const RtpcValue &	GetPitch () const = 0 Gets the current pitch of the sound object.
virtual const RtpcValue &	GetPriority () const = 0 Gets the current priority of the sound object.
virtual eScope	GetScope () const = 0 Returns the scope of the sound object.
virtual eSpatialization	GetSpatialization () const = 0 Returns the spatialization mode of the sound object.
virtual	~SoundObject () = default Default destructor.

Public Functions inherited from SparkyStudios::Audio::Amplitude::Asset¶

See SparkyStudios::Audio::Amplitude::Asset

Type	Name
virtual Id	GetId () const = 0 Returns the unique ID of this asset.
virtual const AmString &	GetName () const = 0 Gets the name of this asset.
virtual	~Asset () = default Destroys the asset and all related resources.

Public Functions Documentation¶

GetSounds

Returns the list of Sound objects referenced in this collection.

virtual const std::vector< AmSoundID > & Amplitude::Collection::GetSounds () const = 0

Returns:

The list of Sound IDs.

ResetEntityScopeScheduler

Resets the internal state of the scheduler running for the given Entity .

virtual void Amplitude::Collection::ResetEntityScopeScheduler (
    const Entity & entity
) = 0

Parameters:

entity The entity for which reset the scheduler state.

ResetWorldScopeScheduler

Resets the internal state of the scheduler running for the World.

virtual void Amplitude::Collection::ResetWorldScopeScheduler () = 0

SelectFromEntity

Returns a Sound from this collection from anEntity scope.

virtual Sound * Amplitude::Collection::SelectFromEntity (
    const Entity & entity,
    const std::unordered_set< AmSoundID > & toSkip
) = 0

Note:

The Scheduler is responsible for picking the sound to play.

Parameters:

entity The entity from which pick the sound.
toSkip The list of Sound IDs to skip from the selection.

Returns:

The selected Sound.

SelectFromWorld

Picks a world-scoped Sound from this collection.

virtual Sound * Amplitude::Collection::SelectFromWorld (
    const std::unordered_set< AmSoundID > & toSkip
) const = 0

Note:

The Scheduler is responsible for picking the sound to play.

Parameters:

toSkip The list of Sound IDs to skip from the selection.

Returns:

The selected Sound.

The documentation for this class was generated from the following file: include/SparkyStudios/Audio/Amplitude/Sound/Collection.h