HKI.Core.Audio.PlaySoundClip Class Reference

This MonoBehaviour allows playing of a SoundClip on one of the general purpose AudioPlayers. More...

Inheritance diagram for HKI.Core.Audio.PlaySoundClip:

Public Types
enum	AudioPlayerTypes {   AudioPlayerTypes.Music, AudioPlayerTypes.Ambient, AudioPlayerTypes.Voices, AudioPlayerTypes.FX,   AudioPlayerTypes.UIFX }
enum	AudioPlayerPlayTypes {   AudioPlayerPlayTypes.Start, AudioPlayerPlayTypes.Enable, AudioPlayerPlayTypes.Disable, AudioPlayerPlayTypes.Destroy,   AudioPlayerPlayTypes.Custom }

Public Member Functions
void	Play ()

Private Member Functions
void	Start ()
void	OnEnable ()
void	OnDisable ()
void	OnDestroy ()

Private Attributes
AudioSystem	AudioSystem = null
AudioPlayerTypes	AudioPlayerType = AudioPlayerTypes.Music
AudioPlayerPlayTypes	PlayType = AudioPlayerPlayTypes.Enable
SoundClip	SoundClip = null
float	DelayPlayInSeconds = 0.0f

Detailed Description

This MonoBehaviour allows playing of a SoundClip on one of the general purpose AudioPlayers.

Definition at line 8 of file PlaySoundClip.cs.

Member Enumeration Documentation

AudioPlayerPlayTypes

enum HKI.Core.Audio.PlaySoundClip.AudioPlayerPlayTypes

strong

Enumerator
Start
Enable
Disable
Destroy
Custom

Definition at line 22 of file PlaySoundClip.cs.

AudioPlayerTypes

enum HKI.Core.Audio.PlaySoundClip.AudioPlayerTypes

strong

Enumerator
Music
Ambient
Voices
FX
UIFX

Definition at line 12 of file PlaySoundClip.cs.

Member Function Documentation

OnDestroy()

void HKI.Core.Audio.PlaySoundClip.OnDestroy ( )

inlineprivate

Definition at line 78 of file PlaySoundClip.cs.

OnDisable()

void HKI.Core.Audio.PlaySoundClip.OnDisable ( )

inlineprivate

Definition at line 66 of file PlaySoundClip.cs.

OnEnable()

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

inlineprivate

Definition at line 54 of file PlaySoundClip.cs.

Play()

void HKI.Core.Audio.PlaySoundClip.Play ( )

inline

Definition at line 90 of file PlaySoundClip.cs.

Start()

void HKI.Core.Audio.PlaySoundClip.Start ( )

inlineprivate

Definition at line 42 of file PlaySoundClip.cs.

Member Data Documentation

AudioPlayerType

AudioPlayerTypes HKI.Core.Audio.PlaySoundClip.AudioPlayerType = AudioPlayerTypes.Music

private

Definition at line 34 of file PlaySoundClip.cs.

AudioSystem

AudioSystem HKI.Core.Audio.PlaySoundClip.AudioSystem = null

private

Definition at line 32 of file PlaySoundClip.cs.

DelayPlayInSeconds

float HKI.Core.Audio.PlaySoundClip.DelayPlayInSeconds = 0.0f

private

Definition at line 39 of file PlaySoundClip.cs.

PlayType

AudioPlayerPlayTypes HKI.Core.Audio.PlaySoundClip.PlayType = AudioPlayerPlayTypes.Enable

private

Definition at line 35 of file PlaySoundClip.cs.

SoundClip

SoundClip HKI.Core.Audio.PlaySoundClip.SoundClip = null

private

Definition at line 37 of file PlaySoundClip.cs.

---

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

• HKI Core/Audio/PlaySoundClip.cs