Sequine - Scripting API
Calcatz.CookieCutter.Audio.SoundLibrary Class Reference

Library of sound groups, each identified with a customizable ID. More...

Classes

class  SoundData
 

Public Member Functions

void Init ()
 Initialize the sound dictionary based on sound data. More...
 
float GetClipVolume (string id)
 
AudioClip GetClipByID (string id)
 Get an audio clip by ID. If there are more than one clip, the get at random index. More...
 
AudioClip GetClipByID (string id, int index)
 Get an audio clip at index of a clip group with the specified ID. More...
 
string[] GetAllIDs ()
 

Detailed Description

Library of sound groups, each identified with a customizable ID.

Member Function Documentation

◆ GetAllIDs()

string[] Calcatz.CookieCutter.Audio.SoundLibrary.GetAllIDs ( )

◆ GetClipByID() [1/2]

AudioClip Calcatz.CookieCutter.Audio.SoundLibrary.GetClipByID ( string  id)

Get an audio clip by ID. If there are more than one clip, the get at random index.

Parameters
id
Returns

◆ GetClipByID() [2/2]

AudioClip Calcatz.CookieCutter.Audio.SoundLibrary.GetClipByID ( string  id,
int  index 
)

Get an audio clip at index of a clip group with the specified ID.

Parameters
id
index
Returns

◆ GetClipVolume()

float Calcatz.CookieCutter.Audio.SoundLibrary.GetClipVolume ( string  id)

◆ Init()

void Calcatz.CookieCutter.Audio.SoundLibrary.Init ( )

Initialize the sound dictionary based on sound data.