Used to modify parameters of a playing sound effect. More...

Public Member Functions
void	Scale (SoundModifier mod)
	Composes another sound modifier on top of this one, multiplying each parameter with the matching parameter in the other instance. More...

Properties
float	Pitch `[get, set]`
	Pitch scale, default is 1. More...

float	Volume `[get, set]`
	Volume scale, default is 1. More...

float	Priority `[get, set]`
	Sound culling priority scale, default is 1. More...

float	StartTime `[get, set]`
	Playback offset when the sound starts, in seconds. More...

bool	Looping `[get, set]`
	If true, the sound will loop on completion. More...

Detailed Description

Used to modify parameters of a playing sound effect.

Member Function Documentation

void Chunks.Audio.SoundModifier.Scale ( SoundModifier mod )

Composes another sound modifier on top of this one, multiplying each parameter with the matching parameter in the other instance.

Parameters

mod	Other instance to compose of top of this one

bool Chunks.Audio.SoundModifier.Looping

getset

If true, the sound will loop on completion.

float Chunks.Audio.SoundModifier.Pitch

getset

Pitch scale, default is 1.

float Chunks.Audio.SoundModifier.Priority

getset

Sound culling priority scale, default is 1.

float Chunks.Audio.SoundModifier.StartTime

getset

Playback offset when the sound starts, in seconds.

float Chunks.Audio.SoundModifier.Volume

getset

Volume scale, default is 1.

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