Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Protected Member Functions | List of all members
KSP.FX.Fireworks.FireworkFX Class Reference

Class representing a single firework from a launcher - shell + trails + bursts More...

Inheritance diagram for KSP.FX.Fireworks.FireworkFX:

Public Member Functions

void FixedUpdate ()
 
Vector3 GetRBVelocity ()
 Returns the velocity of the shell rigidbody if it exists, vector zero otherwise More...
 
void Setup (float fDuration, GameObject trailGO, GameObject burst, Color burstColor1, Color burstColor2, Color trailColor1, Color burstColor3, Color trailColor2, float tVelocity, float bSpread, float bDuration, float bFlareSize, string crackleSFXPath, bool randomizeBurstOrientation)
 Initial configuration More...
 
void Setup (float fDuration, GameObject trailGO, GameObject burst, Color burstColor1, Color burstColor2, Color trailColor1, Color burstColor3, Color trailColor2, float tVelocity, float bSpread, float bDuration, float bFlareSize, string crackleSFXPath, bool randomizeBurstOrientation, float minTrailLifeTime, float maxTrailLifeTime)
 Initial configuration More...
 

Public Attributes

Color burstColor1
 Primary burst color, from the PAW More...
 
Color burstColor2
 Secondary burst color, from the PAW More...
 
Color burstColor3
 Tertiary burst color, from the PAW More...
 
float burstDuration
 Burst duration, from the PAW More...
 
float burstFlareSize
 Burst star size, from the PAW More...
 
GameObject burstInstance
 Instance of the burst effect More...
 
float burstSpread
 Burst force, from the PAW More...
 
float dopplerIntensity = 0.01f
 Controls how pronounced the doppler effect will be More...
 
AudioClip explosionSound
 Loud bang noise the shell makes when it explodes More...
 
float flightDuration
 How long the shell will fly before exploding More...
 
float flightTime
 How long the shell has flied up untill now More...
 
float maxTrailLifeTime
 The aximum life of trail particles More...
 
float minTrailLifeTime
 The minimum life of trail particles More...
 
bool randomizeBurstOrientation
 Defines if the burst direction is randomized. More...
 
Color trailColor1
 Primary trail color, from the PAW More...
 
Color trailColor2
 Secondary trail color, from the PAW More...
 
GameObject trailInstance
 Instance of the trail effect More...
 
float trailVelocity
 Trail velocity, from the PAW More...
 
AudioClip whistleSound
 High-pitched sound the shell makes as it moves away from the listener More...
 

Protected Member Functions

void OnCollisionEnter (Collision collision)
 

Detailed Description

Class representing a single firework from a launcher - shell + trails + bursts

Member Function Documentation

void KSP.FX.Fireworks.FireworkFX.FixedUpdate ( )
inline
Vector3 KSP.FX.Fireworks.FireworkFX.GetRBVelocity ( )
inline

Returns the velocity of the shell rigidbody if it exists, vector zero otherwise

void KSP.FX.Fireworks.FireworkFX.OnCollisionEnter ( Collision  collision)
inlineprotected
void KSP.FX.Fireworks.FireworkFX.Setup ( float  fDuration,
GameObject  trailGO,
GameObject  burst,
Color  burstColor1,
Color  burstColor2,
Color  trailColor1,
Color  burstColor3,
Color  trailColor2,
float  tVelocity,
float  bSpread,
float  bDuration,
float  bFlareSize,
string  crackleSFXPath,
bool  randomizeBurstOrientation 
)
inline

Initial configuration

void KSP.FX.Fireworks.FireworkFX.Setup ( float  fDuration,
GameObject  trailGO,
GameObject  burst,
Color  burstColor1,
Color  burstColor2,
Color  trailColor1,
Color  burstColor3,
Color  trailColor2,
float  tVelocity,
float  bSpread,
float  bDuration,
float  bFlareSize,
string  crackleSFXPath,
bool  randomizeBurstOrientation,
float  minTrailLifeTime,
float  maxTrailLifeTime 
)
inline

Initial configuration

Member Data Documentation

Color KSP.FX.Fireworks.FireworkFX.burstColor1

Primary burst color, from the PAW

Color KSP.FX.Fireworks.FireworkFX.burstColor2

Secondary burst color, from the PAW

Color KSP.FX.Fireworks.FireworkFX.burstColor3

Tertiary burst color, from the PAW

float KSP.FX.Fireworks.FireworkFX.burstDuration

Burst duration, from the PAW

float KSP.FX.Fireworks.FireworkFX.burstFlareSize

Burst star size, from the PAW

GameObject KSP.FX.Fireworks.FireworkFX.burstInstance

Instance of the burst effect

float KSP.FX.Fireworks.FireworkFX.burstSpread

Burst force, from the PAW

float KSP.FX.Fireworks.FireworkFX.dopplerIntensity = 0.01f

Controls how pronounced the doppler effect will be

AudioClip KSP.FX.Fireworks.FireworkFX.explosionSound

Loud bang noise the shell makes when it explodes

float KSP.FX.Fireworks.FireworkFX.flightDuration

How long the shell will fly before exploding

float KSP.FX.Fireworks.FireworkFX.flightTime

How long the shell has flied up untill now

float KSP.FX.Fireworks.FireworkFX.maxTrailLifeTime

The aximum life of trail particles

float KSP.FX.Fireworks.FireworkFX.minTrailLifeTime

The minimum life of trail particles

bool KSP.FX.Fireworks.FireworkFX.randomizeBurstOrientation

Defines if the burst direction is randomized.

Color KSP.FX.Fireworks.FireworkFX.trailColor1

Primary trail color, from the PAW

Color KSP.FX.Fireworks.FireworkFX.trailColor2

Secondary trail color, from the PAW

GameObject KSP.FX.Fireworks.FireworkFX.trailInstance

Instance of the trail effect

float KSP.FX.Fireworks.FireworkFX.trailVelocity

Trail velocity, from the PAW

AudioClip KSP.FX.Fireworks.FireworkFX.whistleSound

High-pitched sound the shell makes as it moves away from the listener


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