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
CometOrbitType Class Reference

Public Member Functions

Orbit CalculateHomeOrbit ()
 Generate an orbit for this comet type when discovered from the home body More...
 
Orbit CalculateSentinelOrbit (Orbit sentinelOrbit, double minDiscoveryDistance, out bool validOrbit)
 Generate an orbit for this comet type when discovered by a sentinel in the supplied orbit More...
 
 CometOrbitType (string name, float inclination1Min, float inclination1Max, float inclination2Min, float inclination2Max, float inclination1Chance, float PEMin, float PEMax, float APMin, float APMax, bool UseEcc, float EccMin, float EccMax, UntrackedObjectClass minCometClass, UntrackedObjectClass maxCometClass)
 
UntrackedObjectClass GetRandomObjClass ()
 
void Load (ConfigNode node)
 Load the info of the Comet from the config file More...
 

Public Attributes

float apMax
 Maximum apoapsis of the orbit relative to the Comet Perturber defined in PSystem More...
 
float apMin
 Minimum apoapsis of the orbit relative to the Comet Perturber defined in PSystem More...
 
int chanceWeight = 5
 Weighting of this comet type among all comet types when a new type is chosen More...
 
string description
 Descripotion of this type of comet for kbInfo. More...
 
string displayName
 Name of the discovered comet, should be stored as a localization tag. More...
 
float eccentricityMax = 1.4f
 Maximum eccentricity of the orbit (if useEccentirity == true) More...
 
float eccentricityMin = 1.01f
 Minimum eccentricity of the orbit (if useEccentirity == true) More...
 
float inclination1Chance = 0.8f
 Chance for the first inclination to be choosen More...
 
float inclination1Max
 Maximum first chance inclination of the orbit, we have 2 possible inclinations for the orbits, this one have 80% chance of getting picked if the default chance is not changed. More...
 
float inclination1Min
 Minimum first chance inclination of the orbit, we have 2 possible inclinations for the orbits, this one have 80% chance of getting picked if the default chance is not changed. More...
 
float inclination2Max
 Maximum second chance inclination of the orbit, we have 2 possible inclinations for the orbits, this one have 20% chance of getting picked if the default chance is not changed. More...
 
float inclination2Min
 Minimum second chance inclination of the orbit, we have 2 possible inclinations for the orbits, this one have 20% chance of getting picked if the default chance is not changed. More...
 
UntrackedObjectClass maxCometClass = UntrackedObjectClass.I
 MAximum size class of the comet, we have 9 different size classes, for the comets goes from "Huge"to "Gargantuan" More...
 
UntrackedObjectClass minCometClass = UntrackedObjectClass.F
 Minimum size class of the comet, we have 9 different size classes, for the comets goes from "Huge"to "Gargantuan" More...
 
string name
 Name of the orbit More...
 
float peMax
 Maximum periapsis of the orbit relative to the Comet Perturber defined in PSystem More...
 
float peMin
 Minimum periapsis of the orbit relative to the Comet Perturber defined in PSystem More...
 
bool useEccentricity = false
 If we are using eccentricity and Pe rather than Ap and Pe to calculate the orbit More...
 

Constructor & Destructor Documentation

CometOrbitType.CometOrbitType ( string  name,
float  inclination1Min,
float  inclination1Max,
float  inclination2Min,
float  inclination2Max,
float  inclination1Chance,
float  PEMin,
float  PEMax,
float  APMin,
float  APMax,
bool  UseEcc,
float  EccMin,
float  EccMax,
UntrackedObjectClass  minCometClass,
UntrackedObjectClass  maxCometClass 
)
inline

Member Function Documentation

Orbit CometOrbitType.CalculateHomeOrbit ( )
inline

Generate an orbit for this comet type when discovered from the home body

Returns
Generated orbit
Orbit CometOrbitType.CalculateSentinelOrbit ( Orbit  sentinelOrbit,
double  minDiscoveryDistance,
out bool  validOrbit 
)
inline

Generate an orbit for this comet type when discovered by a sentinel in the supplied orbit

Parameters
validOrbitTrue id the comet orbit is larger than the sentinels
Returns
Generated orbit
UntrackedObjectClass CometOrbitType.GetRandomObjClass ( )
inline
void CometOrbitType.Load ( ConfigNode  node)
inline

Load the info of the Comet from the config file

Member Data Documentation

float CometOrbitType.apMax

Maximum apoapsis of the orbit relative to the Comet Perturber defined in PSystem

float CometOrbitType.apMin

Minimum apoapsis of the orbit relative to the Comet Perturber defined in PSystem

int CometOrbitType.chanceWeight = 5

Weighting of this comet type among all comet types when a new type is chosen

string CometOrbitType.description

Descripotion of this type of comet for kbInfo.

string CometOrbitType.displayName

Name of the discovered comet, should be stored as a localization tag.

float CometOrbitType.eccentricityMax = 1.4f

Maximum eccentricity of the orbit (if useEccentirity == true)

float CometOrbitType.eccentricityMin = 1.01f

Minimum eccentricity of the orbit (if useEccentirity == true)

float CometOrbitType.inclination1Chance = 0.8f

Chance for the first inclination to be choosen

float CometOrbitType.inclination1Max

Maximum first chance inclination of the orbit, we have 2 possible inclinations for the orbits, this one have 80% chance of getting picked if the default chance is not changed.

float CometOrbitType.inclination1Min

Minimum first chance inclination of the orbit, we have 2 possible inclinations for the orbits, this one have 80% chance of getting picked if the default chance is not changed.

float CometOrbitType.inclination2Max

Maximum second chance inclination of the orbit, we have 2 possible inclinations for the orbits, this one have 20% chance of getting picked if the default chance is not changed.

float CometOrbitType.inclination2Min

Minimum second chance inclination of the orbit, we have 2 possible inclinations for the orbits, this one have 20% chance of getting picked if the default chance is not changed.

UntrackedObjectClass CometOrbitType.maxCometClass = UntrackedObjectClass.I

MAximum size class of the comet, we have 9 different size classes, for the comets goes from "Huge"to "Gargantuan"

UntrackedObjectClass CometOrbitType.minCometClass = UntrackedObjectClass.F

Minimum size class of the comet, we have 9 different size classes, for the comets goes from "Huge"to "Gargantuan"

string CometOrbitType.name

Name of the orbit

float CometOrbitType.peMax

Maximum periapsis of the orbit relative to the Comet Perturber defined in PSystem

float CometOrbitType.peMin

Minimum periapsis of the orbit relative to the Comet Perturber defined in PSystem

bool CometOrbitType.useEccentricity = false

If we are using eccentricity and Pe rather than Ap and Pe to calculate the orbit


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