Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | List of all members
ROCsSFX Class Reference
Inheritance diagram for ROCsSFX:
EffectBehaviour

Public Member Functions

void FadeInPlayback ()
 Returns the volume idle SFX . More...
 
void FadeOutPlayback ()
 Audio source volume starts fading out More...
 
float PlayBurstSFX ()
 Starts playback burst state SFX More...
 
void PlayIdleSFX ()
 Starts playback idle state SFX More...
 
void SetClipsPath (string idleClipPath, string burstClipPath)
 Stores the sfx clip path loaded from the rocs cfg file. More...
 
void SetSFXVolume (float value)
 Sets SFX audio source volume. More...
 
- Public Member Functions inherited from EffectBehaviour
virtual void OnEvent ()
 
virtual void OnEvent (int transformIdx)
 
virtual void OnEvent (float power)
 
virtual void OnEvent (float power, int transformIdx)
 
virtual void OnInitialize ()
 
virtual void OnLoad (ConfigNode node)
 
virtual void OnSave (ConfigNode node)
 

Public Attributes

string burstEffectName = "burst"
 Name of the sound effect for the burst state More...
 
float fadeInSpeed = 0.25f
 SFX audio clip fade in speed. More...
 
float fadeOutSpeed = 0.25f
 SFX audio clip fade out speed. More...
 
string idleEffectName = "idle"
 Name of the sound effect for the idle state More...
 
bool loop = false
 Is the audio clip looping? More...
 
float playDelay
 Plays the audio clip with a delay specified in seconds. More...
 
- Public Attributes inherited from EffectBehaviour
string effectName = ""
 
Part hostPart
 
string instanceName = ""
 

Additional Inherited Members

- Static Public Member Functions inherited from EffectBehaviour
static void AddParticleEmitter (KSPParticleEmitter emitter)
 
static void AddParticleEmitter (ParticleSystem emitter)
 
static void OffsetParticles (Vector3d offset)
 
static void RemoveParticleEmitter (KSPParticleEmitter emitter)
 
static void RemoveParticleEmitter (ParticleSystem emitter)
 

Member Function Documentation

void ROCsSFX.FadeInPlayback ( )
inline

Returns the volume idle SFX .

void ROCsSFX.FadeOutPlayback ( )
inline

Audio source volume starts fading out

float ROCsSFX.PlayBurstSFX ( )
inline

Starts playback burst state SFX

void ROCsSFX.PlayIdleSFX ( )
inline

Starts playback idle state SFX

void ROCsSFX.SetClipsPath ( string  idleClipPath,
string  burstClipPath 
)
inline

Stores the sfx clip path loaded from the rocs cfg file.

Parameters
idleClipPathIdle audio clip path.
burstClipPathBurst audio clip path.
void ROCsSFX.SetSFXVolume ( float  value)
inline

Sets SFX audio source volume.

Parameters
valueAudio source volume (0.0 to 1.0).

Member Data Documentation

string ROCsSFX.burstEffectName = "burst"

Name of the sound effect for the burst state

float ROCsSFX.fadeInSpeed = 0.25f

SFX audio clip fade in speed.

float ROCsSFX.fadeOutSpeed = 0.25f

SFX audio clip fade out speed.

string ROCsSFX.idleEffectName = "idle"

Name of the sound effect for the idle state

bool ROCsSFX.loop = false

Is the audio clip looping?

float ROCsSFX.playDelay

Plays the audio clip with a delay specified in seconds.


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