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
KSP.FX.Fireworks.FireworkFXComponent Class Reference

Class to customize a single firework artifice from the values fed by the module More...

Inheritance diagram for KSP.FX.Fireworks.FireworkFXComponent:

Public Member Functions

void ActivateBurstPS (Vector3 position)
 Activates the burst particle system More...
 
void Die ()
 Destroys the fx object More...
 
void Initialize (GameObject trailGO, FireworkFX controller, FireworkEffectType type)
 Configures the effect and assigns all the neccessary references More...
 

Public Attributes

AudioSource audioSource
 The audio source of this object More...
 
List< ParticleSystem > burstColor3Particles
 All the particle systems affected by the burst tertiary color More...
 
List< ParticleSystem > burstDurationParticles
 All the particle systems affected by the burst duration field More...
 
List< ParticleSystem > burstFlareSizeParticles
 All the particle systems affected by the burst flare size field More...
 
List< ParticleSystem > burstMainColorParticles
 All the particle systems affected by the burst primary and secondary color More...
 
List< ParticleSystem > burstSpreadParticles
 All the particle systems affected by the burst spread field More...
 
AudioClip crackleSFX
 The audio clip for crackles More...
 
FireworkEffectType fwEffectType
 The type of firework effect this object is More...
 
Quaternion initialRotation = Quaternion.identity
 The correct initial rotation of the effect More...
 
int maxAmountOfCrackleInstances = 6
 The maximum number of instances of crackle sounds allowed. Recommended value is the number of crackling sub-emitters. More...
 
ParticleSystem parentParticles
 Main particle system that spawns sub-emmiters (if any) More...
 
ParticleSystem[] particleSystems
 All the particle systems present in the hierarchy More...
 
List< ParticleSystem > trailMainColorParticles
 All the particle systems affected by the trail color 1 field More...
 

Detailed Description

Class to customize a single firework artifice from the values fed by the module

Member Function Documentation

void KSP.FX.Fireworks.FireworkFXComponent.ActivateBurstPS ( Vector3  position)
inline

Activates the burst particle system

void KSP.FX.Fireworks.FireworkFXComponent.Die ( )
inline

Destroys the fx object

void KSP.FX.Fireworks.FireworkFXComponent.Initialize ( GameObject  trailGO,
FireworkFX  controller,
FireworkEffectType  type 
)
inline

Configures the effect and assigns all the neccessary references

Member Data Documentation

AudioSource KSP.FX.Fireworks.FireworkFXComponent.audioSource

The audio source of this object

List<ParticleSystem> KSP.FX.Fireworks.FireworkFXComponent.burstColor3Particles

All the particle systems affected by the burst tertiary color

List<ParticleSystem> KSP.FX.Fireworks.FireworkFXComponent.burstDurationParticles

All the particle systems affected by the burst duration field

List<ParticleSystem> KSP.FX.Fireworks.FireworkFXComponent.burstFlareSizeParticles

All the particle systems affected by the burst flare size field

List<ParticleSystem> KSP.FX.Fireworks.FireworkFXComponent.burstMainColorParticles

All the particle systems affected by the burst primary and secondary color

List<ParticleSystem> KSP.FX.Fireworks.FireworkFXComponent.burstSpreadParticles

All the particle systems affected by the burst spread field

AudioClip KSP.FX.Fireworks.FireworkFXComponent.crackleSFX

The audio clip for crackles

FireworkEffectType KSP.FX.Fireworks.FireworkFXComponent.fwEffectType

The type of firework effect this object is

Quaternion KSP.FX.Fireworks.FireworkFXComponent.initialRotation = Quaternion.identity

The correct initial rotation of the effect

int KSP.FX.Fireworks.FireworkFXComponent.maxAmountOfCrackleInstances = 6

The maximum number of instances of crackle sounds allowed. Recommended value is the number of crackling sub-emitters.

ParticleSystem KSP.FX.Fireworks.FireworkFXComponent.parentParticles

Main particle system that spawns sub-emmiters (if any)

ParticleSystem [] KSP.FX.Fireworks.FireworkFXComponent.particleSystems

All the particle systems present in the hierarchy

List<ParticleSystem> KSP.FX.Fireworks.FireworkFXComponent.trailMainColorParticles

All the particle systems affected by the trail color 1 field


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