ROCEmitter Class Reference

This class controls the Vals' Cryovolcano particle system, also add their emitters to the EffectBehaviour.emitters list. More...

Inheritance diagram for ROCEmitter:

Public Member Functions
void	SetBurstEmitterMaxWait (float value)
	Set the maximum time between Burst Emissions More...
void	SetBurstEmitterMinWait (float value)
	Set the minimum time between Burst Emissions More...
void	SetForceScale (float burstClipTime)
	Sets the force applied by the emitter. More...
void	SetSFXClipPath (string idlepClip, string burstClip)
	Set the sfx clips path. More...
void	SetSFXPower (float value)
	Set the sfx volume scale, the greater the farest will be heard More...
void	StartBurstEmision (bool resetTimer=true)
	Start the Burst Emitters More...
void	StartIdleEmision ()
	Start the idle Emitters More...
void	StopBurstEmision ()
	Stop the Burst Emitters More...
void	StopIdleEmision ()
	Stop the idle Emitters 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...
Transform	burstEmitter
float	burstFraction
	The SFX burst time fraction to measures the burst duration. The minimum value is 0 (longer burst time), the maximum value is 1 (shorter burst time). More...
Vector3	forceDirection
	Direction vector to apply the force in. More...
Transform	forceOrigin
	The force origin used to measure the applied force within a radius. More...
Vector2	forceRadius
	Defines the VFX force collider dimensions. More...
string	idleEffectName = "idle"
	Name of the sound effect for the idle state More...
Transform	idleEmitter
float	secondsTillBurstEmission = 0
	Time till next burstEmission More...
float	vfxBaseForce
	Defines the burst emitter force base unit. More...
Public Attributes inherited from EffectBehaviour
string	effectName = ""
Part	hostPart
string	instanceName = ""

Properties
bool	TimedBurstEmissionsEnabled [get, set]
	Are burst emissions playing periodically More...

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)

Detailed Description

This class controls the Vals' Cryovolcano particle system, also add their emitters to the EffectBehaviour.emitters list.

Member Function Documentation

void ROCEmitter.SetBurstEmitterMaxWait ( float  value )

inline

Set the maximum time between Burst Emissions

If set to 0 the burst emissions will be disabled

Parameters

value

time in seconds

void ROCEmitter.SetBurstEmitterMinWait ( float  value )

inline

Set the minimum time between Burst Emissions

If set to 0 the burst emissions will be disabled

Parameters

value

time in seconds

void ROCEmitter.SetForceScale ( float  burstClipTime )

inline

Sets the force applied by the emitter.

void ROCEmitter.SetSFXClipPath ( string  idlepClip, string  burstClip  )

inline

Set the sfx clips path.

Parameters

idlepClip	The idle clip path.
burstClip	The burst clip path.

void ROCEmitter.SetSFXPower ( float  value )

inline

Set the sfx volume scale, the greater the farest will be heard

Parameters

value

time in seconds

void ROCEmitter.StartBurstEmision ( bool  resetTimer = true )

inline

Start the Burst Emitters

Parameters

resetTimer

reset the timer till next burst

void ROCEmitter.StartIdleEmision ( )

inline

Start the idle Emitters

void ROCEmitter.StopBurstEmision ( )

inline

Stop the Burst Emitters

void ROCEmitter.StopIdleEmision ( )

inline

Stop the idle Emitters

Member Data Documentation

string ROCEmitter.burstEffectName = "burst"

Name of the sound effect for the burst state

Transform ROCEmitter.burstEmitter

float ROCEmitter.burstFraction

The SFX burst time fraction to measures the burst duration. The minimum value is 0 (longer burst time), the maximum value is 1 (shorter burst time).

Vector3 ROCEmitter.forceDirection

Direction vector to apply the force in.

Transform ROCEmitter.forceOrigin

The force origin used to measure the applied force within a radius.

Vector2 ROCEmitter.forceRadius

Defines the VFX force collider dimensions.

string ROCEmitter.idleEffectName = "idle"

Name of the sound effect for the idle state

Transform ROCEmitter.idleEmitter

float ROCEmitter.secondsTillBurstEmission = 0

Time till next burstEmission

float ROCEmitter.vfxBaseForce

Defines the burst emitter force base unit.

Property Documentation

bool ROCEmitter.TimedBurstEmissionsEnabled

getset

Are burst emissions playing periodically

---

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

• KSP/Assets/Expansions/Serenity/Scripts/VFX/ROCEmitter.cs