ORK Framework  2.25.2
API Documentation
ORKFramework.MusicChannel Class Reference
Inheritance diagram for ORKFramework.MusicChannel:
ORKFramework.ISaveData

Public Member Functions

 MusicChannel (GameObject parent, int channel)
 
void FadeVolume (float toVolume, EaseType interpolation, float time)
 
void UpdateVolume ()
 
bool IsPlaying ()
 
bool IsPlaying (int clipID)
 
int GetCurrentID ()
 
float GetCurrentTime ()
 
float GetCurrentTargetVolume ()
 
void StoreCurrent (int id)
 
void PlayStored (int id)
 
void FadeInStored (int id, float time, EaseType type)
 
void FadeToStored (int id, float time, EaseType type)
 
bool CheckPlay (MusicClip clip)
 
void SetPCM (int pcm)
 
void SetTime (float time)
 
void Play (int index, float targetVolume, bool fromCurrentTime)
 
void PlayFromTime (int index, float targetVolume, float time)
 
void Play (MusicClip clip)
 
void Stop ()
 
void FadeIn (int index, float targetVolume, bool fromCurrentTime, float fadeTime, EaseType type)
 
void FadeIn (MusicClip clip, float fadeTime, EaseType type)
 
void FadeOut (float time, EaseType type)
 
void FadeTo (int index, float targetVolume, bool fromCurrentTime, float fadeTime, EaseType type)
 
void FadeTo (MusicClip clip, float fadeTime, EaseType type)
 
void DoTick ()
 
void Tick ()
 
DataObject SaveGame ()
 Used to save the data - you need to add the data to a ORKFramework.DataObject. More...
 
void LoadGame (DataObject data)
 Used to load the data - you need to get the data from the ORKFramework.DataObject. More...
 

Properties

float Volume [get, set]
 

Member Function Documentation

◆ LoadGame()

void ORKFramework.MusicChannel.LoadGame ( DataObject  data)

Used to load the data - you need to get the data from the ORKFramework.DataObject.

Parameters
dataA ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.

◆ SaveGame()

DataObject ORKFramework.MusicChannel.SaveGame ( )

Used to save the data - you need to add the data to a ORKFramework.DataObject.

Returns
A ORKFramework.DataObject containing the data.

Implements ORKFramework.ISaveData.