Class SoundEffect

The sound effect created in the sound effect creator, consisting of a set of tones.

Inheritance
System.Object
UnityEngine.Object
UnityEngine.ScriptableObject
EditorSampleSetAssetScriptableObject
SoundEffect
Inherited Members
Namespace: InsaneScatterbrain.RetroKit.Editor
Syntax
public class SoundEffect : EditorSampleSetAssetScriptableObject

Properties

Item[Int32]

Gets/sets a tone.

Declaration
public Tone this[int index] { get; set; }
Parameters
Type Name Description
System.Int32 index
Property Value
Type Description
Tone

SampleProvider

The sample provider that is used to generate the samples for this sound effect. Basically, this is the "instrument" that is used for this pattern.

Declaration
public ISampleProvider SampleProvider { get; set; }
Property Value
Type Description
ISampleProvider

ToneCount

Gets/sets the number of tones this sound effect consists of.

Declaration
public int ToneCount { get; set; }
Property Value
Type Description
System.Int32

ToneDuration

Gets/sets the duration of each tone.

Declaration
public int ToneDuration { get; set; }
Property Value
Type Description
System.Int32

Methods

AddTone(Tone)

Declaration
public void AddTone(Tone tone)
Parameters
Type Name Description
Tone tone

Create(String)

Declaration
public static SoundEffect Create(string name)
Parameters
Type Name Description
System.String name
Returns
Type Description
SoundEffect

GenerateAudioClip()

Declaration
public void GenerateAudioClip()

GenerateSamples()

Declaration
public void GenerateSamples()

RemoveTone(Int32)

Declaration
public void RemoveTone(int toneIndex)
Parameters
Type Name Description
System.Int32 toneIndex

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
UnityEngine.Object.ToString()