KSP API
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties
Public Member Functions | Public Attributes | List of all members
ScienceExperiment Class Reference

Class containing information from the experiment stored in the ScienceDefs file. More...

Public Member Functions

 ScienceExperiment ()
 
bool BiomeIsRelevantWhile (ExperimentSituations situation)
 Checks if the biome is relevent to the experiment given the biomeMask specified in the ScienceDefs file. More...
 
bool IsAvailableWhile (ExperimentSituations situation, CelestialBody body)
 Determines if the experiment is available given the situationMask and requireAtmosphere values specified in the ScienceDefs file. More...
 
void Load (ConfigNode node)
 
void Save (ConfigNode node)
 

Public Attributes

float baseValue
 Base science value from ScienceDefs file. More...
 
uint biomeMask
 Bitmask to determine when biomes are relevant. More...
 
float dataScale
 Multiplier to increase data amount in mits. More...
 
string experimentTitle
 Title to be displayed for experimental results dialog and science archives. More...
 
string id
 Matches ID from ModuleScienceExperiment field. More...
 
bool requireAtmosphere
 Can the experiment only be performed on planets with an atmosphere? More...
 
float scienceCap
 Maximum science value available for each experimental result. More...
 
uint situationMask
 Bitmask to determine which Experiment Situations the experiment can be performed in. More...
 

Detailed Description

Class containing information from the experiment stored in the ScienceDefs file.

Constructor & Destructor Documentation

ScienceExperiment.ScienceExperiment ( )

Member Function Documentation

bool ScienceExperiment.BiomeIsRelevantWhile ( ExperimentSituations  situation)

Checks if the biome is relevent to the experiment given the biomeMask specified in the ScienceDefs file.

Parameters
situationCurrent Experiment Situation
Returns
bool ScienceExperiment.IsAvailableWhile ( ExperimentSituations  situation,
CelestialBody  body 
)

Determines if the experiment is available given the situationMask and requireAtmosphere values specified in the ScienceDefs file.

Parameters
situationCurrent Experiment Situation
bodyCurrent Celestial Body
Returns
void ScienceExperiment.Load ( ConfigNode  node)
void ScienceExperiment.Save ( ConfigNode  node)

Member Data Documentation

float ScienceExperiment.baseValue

Base science value from ScienceDefs file.

uint ScienceExperiment.biomeMask

Bitmask to determine when biomes are relevant.

float ScienceExperiment.dataScale

Multiplier to increase data amount in mits.

string ScienceExperiment.experimentTitle

Title to be displayed for experimental results dialog and science archives.

string ScienceExperiment.id

Matches ID from ModuleScienceExperiment field.

bool ScienceExperiment.requireAtmosphere

Can the experiment only be performed on planets with an atmosphere?

float ScienceExperiment.scienceCap

Maximum science value available for each experimental result.

uint ScienceExperiment.situationMask

Bitmask to determine which Experiment Situations the experiment can be performed in.


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