class MAGES::CollisionSound::CollisionSoundModule¶

Overview¶

The root module for the Collision Sound Framework. More…

class CollisionSoundModule: public MAGES::HubModule
{
public:
    // properties

    bool PitchModulationEnabled;
    float PitchModulationRange;
    float MinCollisionVolume;
    float PlayDelay;

    // methods

    override void Shutdown();
    override void Startup();
    AudioSource GetAudioSource();
    void ReturnAudioSource(AudioSource audioSource);
};

Inherited Members¶

public:
    // properties

    int Version;

    // methods

    void Startup();
    void Shutdown();
    virtual void UpdateModule(UpdatePhase updatePhase);

Detailed Documentation¶

The root module for the Collision Sound Framework.

Properties¶

bool PitchModulationEnabled

Gets a value indicating whether the pitch randomization of the collision sounds is enabled.

float PitchModulationRange

Gets the range of pitch of the collision sounds.

float MinCollisionVolume

Gets the minimum volume below which sounds will not play.

float PlayDelay

Gets the minimum time in seconds between sound per object.

Methods¶

AudioSource GetAudioSource()

Request an audioSource from the audiosource pool.

Returns:

The requested audio source.

void ReturnAudioSource(AudioSource audioSource)

Returns an audio source back to the pool.

Parameters: