HKI.Core.Audio.Playlist Class Reference

This ScriptableObject contains the data of a playlist for the AudioPlayer. More...

Inheritance diagram for HKI.Core.Audio.Playlist:

Public Types
enum	PlaylistPlayTypes { PlaylistPlayTypes.RandomShuffelWithProtection, PlaylistPlayTypes.RandomShuffel, PlaylistPlayTypes.RandomTotal, PlaylistPlayTypes.Order }

Public Member Functions
SoundClip	GetNextClip ()
SoundClip	GetClipByName (string name)
SoundClip	GetClipByClipId (int clipId)
void	ChangeMusicPlaylist (bool playPlaylist=true)
void	ChangeAmbientPlaylist (bool playPlaylist=true)
void	ChangeFxPlaylist (bool playPlaylist=false)
void	ChangeUiFxPlaylist (bool playPlaylist=false)
void	ChangeVoicesPlaylist (bool playPlaylist=false)

Properties
int	GetNumberOfClips [get]
PlaylistPlayTypes	GetPlaylistPlayType [get]

Private Member Functions
void	OnEnable ()
void	Shuffle ()
void	CreateShuffleList ()

Private Attributes
PlaylistPlayTypes	PlaylistPlayType = PlaylistPlayTypes.RandomShuffelWithProtection
List< SoundClip >	Clips = new List<SoundClip>()
List< int >	shuffleList
int	index = -1

Detailed Description

This ScriptableObject contains the data of a playlist for the AudioPlayer.

The playorder can be shuffeled:

• RandomShuffelWithProtection (creates an order and if the playlist is finished it creates a new order with the first clip of the new is not the same as the last clip of the old list)
• RandomShuffel (creates an order and if the playlist is finished it creates a new order)
• RandomTotal (everytime a random clip)
• Order (same order as the are visible in the Unity Editor)

Create a GameEvent in Unity: HKI/Audio/Playlist

Definition at line 19 of file Playlist.cs.

Member Enumeration Documentation

PlaylistPlayTypes

enum HKI.Core.Audio.Playlist.PlaylistPlayTypes

strong

Enumerator
RandomShuffelWithProtection
RandomShuffel
RandomTotal
Order

Definition at line 23 of file Playlist.cs.

Member Function Documentation

ChangeAmbientPlaylist()

void HKI.Core.Audio.Playlist.ChangeAmbientPlaylist ( bool  playPlaylist = true )

inline

Definition at line 115 of file Playlist.cs.

ChangeFxPlaylist()

void HKI.Core.Audio.Playlist.ChangeFxPlaylist ( bool  playPlaylist = false )

inline

Definition at line 120 of file Playlist.cs.

ChangeMusicPlaylist()

void HKI.Core.Audio.Playlist.ChangeMusicPlaylist ( bool  playPlaylist = true )

inline

Definition at line 110 of file Playlist.cs.

ChangeUiFxPlaylist()

void HKI.Core.Audio.Playlist.ChangeUiFxPlaylist ( bool  playPlaylist = false )

inline

Definition at line 125 of file Playlist.cs.

ChangeVoicesPlaylist()

void HKI.Core.Audio.Playlist.ChangeVoicesPlaylist ( bool  playPlaylist = false )

inline

Definition at line 130 of file Playlist.cs.

CreateShuffleList()

void HKI.Core.Audio.Playlist.CreateShuffleList ( )

inlineprivate

Definition at line 174 of file Playlist.cs.

GetClipByClipId()

SoundClip HKI.Core.Audio.Playlist.GetClipByClipId ( int  clipId )

inline

Definition at line 96 of file Playlist.cs.

GetClipByName()

SoundClip HKI.Core.Audio.Playlist.GetClipByName ( string  name )

inline

Definition at line 82 of file Playlist.cs.

GetNextClip()

SoundClip HKI.Core.Audio.Playlist.GetNextClip ( )

inline

Definition at line 56 of file Playlist.cs.

OnEnable()

void HKI.Core.Audio.Playlist.OnEnable ( )

inlineprivate

Definition at line 44 of file Playlist.cs.

Shuffle()

void HKI.Core.Audio.Playlist.Shuffle ( )

inlineprivate

Definition at line 136 of file Playlist.cs.

Member Data Documentation

Clips

List<SoundClip> HKI.Core.Audio.Playlist.Clips = new List<SoundClip>()

private

Definition at line 34 of file Playlist.cs.

index

int HKI.Core.Audio.Playlist.index = -1

private

Definition at line 38 of file Playlist.cs.

PlaylistPlayType

PlaylistPlayTypes HKI.Core.Audio.Playlist.PlaylistPlayType = PlaylistPlayTypes.RandomShuffelWithProtection

private

Definition at line 32 of file Playlist.cs.

shuffleList

List<int> HKI.Core.Audio.Playlist.shuffleList

private

Definition at line 36 of file Playlist.cs.

Property Documentation

GetNumberOfClips

int HKI.Core.Audio.Playlist.GetNumberOfClips

get

Definition at line 41 of file Playlist.cs.

GetPlaylistPlayType

PlaylistPlayTypes HKI.Core.Audio.Playlist.GetPlaylistPlayType

get

Definition at line 53 of file Playlist.cs.

---

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

• HKI Core/Audio/Playlist.cs