Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Static Public Attributes | Properties | List of all members
Expansions.Serenity.DeployedScience.Runtime.DeployedScience Class Reference
Inheritance diagram for Expansions.Serenity.DeployedScience.Runtime.DeployedScience:
ScenarioModule IConfigNode

Public Member Functions

void DeRegisterCluster (uint controlUnitId)
 Deregister a DeployedScience Cluster (ModuleGroundExpControl) and all the deployable parts that are connected to it. This will also be Called automatically when GameEvent onGroundScienceDeregisterCluster is Fired. More...
 
float ExpDimReturnsRate (string experimentId, string celestialBodyName)
 Calculates and Returns the Diminishing Science Multiplier Rate based on the experimentId and Celestial Body name. Each additional Experiment on the same Celestial Body returns a diminishing amount of science. More...
 
DeployedSciencePart ExpMaxScienceMultiplier (string experimentId, string celestialBodyName)
 Finds and returns the first matching DeployedSciencePart that has an experiment matching ExperimentId and deployed on the Celestial Body passed in. If none found will return null. More...
 
float GetDiminishingReturnsMultiplier (int numExperiments)
 Will return the Diminishing Returns multiplier from the diminishing returns config based on the number passed in. More...
 
override void OnAwake ()
 
void OnDestroy ()
 
override void OnLoad (ConfigNode node)
 
override void OnSave (ConfigNode node)
 
void RegisterCluster (ModuleGroundExpControl controlUnit, List< ModuleGroundSciencePart > deployableScienceParts)
 Register a DeployedScience Cluster (ModuleGroundExpControl) and all the deployable parts that are connected to it. This will also be Called automatically when GameEvent onGroundScienceRegisterCluster is Fired. More...
 
void SetDiminishingScienceRate (string experimentId, string celestialBodyName)
 Will set the Diminishing Science Rate on all Deployed Science Experiments that match the ExperimentId and Celestial Body passed in. The First (highest) science returning experiment (based on buffs set based on traits for the kerbal that deployed it) returns a rate of 1. Then for each other instance of the same experiment a diminishing rate is applied based on what is defined in the Deployed Science cfg. More...
 
- Public Member Functions inherited from ScenarioModule
void Load (ConfigNode node)
 
void Save (ConfigNode node)
 

Public Attributes

double DataSendFailedTimeDelay = 600f
 How long to delay before attempting to resend Science Data More...
 
float MinimumSeismicEnergyRequired = 3000
 The Minimum amount of Energy Required for a Seismic Event to generate Science. More...
 
double ScienceTimeDelay = 60f
 How often Science is processed for timed Deployed Science Experiments in secs. More...
 
int SeismicScienceProcessingDelay = 3
 There is a delay after the first impact is detected on a CB before the science is processed. This is to allow all parts of the vessel to hit the ground and generate data. Changing this value will change the length of that delay. More...
 
- Public Attributes inherited from ScenarioModule
ScenarioRunner runner
 
ProtoScenarioModule snapshot
 
List< GameScenestargetScenes
 

Static Public Attributes

static string SeismicExperimentId = "deployedSeismicSensor"
 This is the experiment name for the Deployed Sesimic Sensor. Which processes seismic activity experiments when vessels crash into CBs. More...
 

Properties

DictionaryValueList< uint,
DeployedScienceCluster
DeployedScienceClusters [get]
 A Dictionary of the DeployedScienceCluster's in this save. Keyed by the ModuleGroundExpControl Part's PersistentId. More...
 
DictionaryValueList< int, float > DiminishingReturns [get]
 A dictionary of the diminishing returns science multipliers. Key is the Number of the same experiment per CB. Value is the multiplier to apply to science for the key. More...
 
static DeployedScience Instance [get, set]
 The singleton instance of DeployedScience More...
 
static bool IsActive [get, set]
 True if the DeployedScience Scenario is active. More...
 
DictionaryValueList< string,
float > 
SeismicEnergyRates [get]
 The Impact rates J(oules) for each Celestial Body to register Science for the Seismic Sensor Experiment. More...
 
- Properties inherited from ScenarioModule
int ClassID [get]
 
string ClassName [get]
 
BaseEventList Events [get]
 
BaseFieldList Fields [get]
 

Member Function Documentation

void Expansions.Serenity.DeployedScience.Runtime.DeployedScience.DeRegisterCluster ( uint  controlUnitId)
inline

Deregister a DeployedScience Cluster (ModuleGroundExpControl) and all the deployable parts that are connected to it. This will also be Called automatically when GameEvent onGroundScienceDeregisterCluster is Fired.

float Expansions.Serenity.DeployedScience.Runtime.DeployedScience.ExpDimReturnsRate ( string  experimentId,
string  celestialBodyName 
)
inline

Calculates and Returns the Diminishing Science Multiplier Rate based on the experimentId and Celestial Body name. Each additional Experiment on the same Celestial Body returns a diminishing amount of science.

Parameters
experimentId
celestialBodyName
Returns
DeployedSciencePart Expansions.Serenity.DeployedScience.Runtime.DeployedScience.ExpMaxScienceMultiplier ( string  experimentId,
string  celestialBodyName 
)
inline

Finds and returns the first matching DeployedSciencePart that has an experiment matching ExperimentId and deployed on the Celestial Body passed in. If none found will return null.

Parameters
experimentId
celestialBodyName
Returns
float Expansions.Serenity.DeployedScience.Runtime.DeployedScience.GetDiminishingReturnsMultiplier ( int  numExperiments)
inline

Will return the Diminishing Returns multiplier from the diminishing returns config based on the number passed in.

Parameters
numExperimentsThe number of experiments
Returns
override void Expansions.Serenity.DeployedScience.Runtime.DeployedScience.OnAwake ( )
inlinevirtual

Reimplemented from ScenarioModule.

void Expansions.Serenity.DeployedScience.Runtime.DeployedScience.OnDestroy ( )
inline
override void Expansions.Serenity.DeployedScience.Runtime.DeployedScience.OnLoad ( ConfigNode  node)
inlinevirtual

Reimplemented from ScenarioModule.

override void Expansions.Serenity.DeployedScience.Runtime.DeployedScience.OnSave ( ConfigNode  node)
inlinevirtual

Reimplemented from ScenarioModule.

void Expansions.Serenity.DeployedScience.Runtime.DeployedScience.RegisterCluster ( ModuleGroundExpControl  controlUnit,
List< ModuleGroundSciencePart deployableScienceParts 
)
inline

Register a DeployedScience Cluster (ModuleGroundExpControl) and all the deployable parts that are connected to it. This will also be Called automatically when GameEvent onGroundScienceRegisterCluster is Fired.

void Expansions.Serenity.DeployedScience.Runtime.DeployedScience.SetDiminishingScienceRate ( string  experimentId,
string  celestialBodyName 
)
inline

Will set the Diminishing Science Rate on all Deployed Science Experiments that match the ExperimentId and Celestial Body passed in. The First (highest) science returning experiment (based on buffs set based on traits for the kerbal that deployed it) returns a rate of 1. Then for each other instance of the same experiment a diminishing rate is applied based on what is defined in the Deployed Science cfg.

Parameters
experimentId
celestialBodyName

Member Data Documentation

double Expansions.Serenity.DeployedScience.Runtime.DeployedScience.DataSendFailedTimeDelay = 600f

How long to delay before attempting to resend Science Data

float Expansions.Serenity.DeployedScience.Runtime.DeployedScience.MinimumSeismicEnergyRequired = 3000

The Minimum amount of Energy Required for a Seismic Event to generate Science.

double Expansions.Serenity.DeployedScience.Runtime.DeployedScience.ScienceTimeDelay = 60f

How often Science is processed for timed Deployed Science Experiments in secs.

string Expansions.Serenity.DeployedScience.Runtime.DeployedScience.SeismicExperimentId = "deployedSeismicSensor"
static

This is the experiment name for the Deployed Sesimic Sensor. Which processes seismic activity experiments when vessels crash into CBs.

int Expansions.Serenity.DeployedScience.Runtime.DeployedScience.SeismicScienceProcessingDelay = 3

There is a delay after the first impact is detected on a CB before the science is processed. This is to allow all parts of the vessel to hit the ground and generate data. Changing this value will change the length of that delay.

Property Documentation

DictionaryValueList<uint, DeployedScienceCluster> Expansions.Serenity.DeployedScience.Runtime.DeployedScience.DeployedScienceClusters
get

A Dictionary of the DeployedScienceCluster's in this save. Keyed by the ModuleGroundExpControl Part's PersistentId.

DictionaryValueList<int, float> Expansions.Serenity.DeployedScience.Runtime.DeployedScience.DiminishingReturns
get

A dictionary of the diminishing returns science multipliers. Key is the Number of the same experiment per CB. Value is the multiplier to apply to science for the key.

DeployedScience Expansions.Serenity.DeployedScience.Runtime.DeployedScience.Instance
staticgetset

The singleton instance of DeployedScience

bool Expansions.Serenity.DeployedScience.Runtime.DeployedScience.IsActive
staticgetset

True if the DeployedScience Scenario is active.

DictionaryValueList<string, float> Expansions.Serenity.DeployedScience.Runtime.DeployedScience.SeismicEnergyRates
get

The Impact rates J(oules) for each Celestial Body to register Science for the Seismic Sensor Experiment.


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