Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Classes | Public Member Functions | Public Attributes | Properties | List of all members
ModuleScienceExperiment Class Reference
Inheritance diagram for ModuleScienceExperiment:
PartModule IScienceDataContainer

Classes

class  EVASituation
 Class that Stores EVA situations that are loaded from EVASITUATION nodes within the MODULE node. More...
 

Public Member Functions

virtual bool CanBeDetached ()
 Returns true if experiment is not being reset. More...
 
virtual bool CanBeOffset ()
 Returns true if experiment is not being reset. More...
 
virtual bool CanBeRotated ()
 Returns true if experiment is not being reset. More...
 
void CleanUpExperimentExternal ()
 Event Method that resets an experiment that is Inoperable until a manual reset by a scientist More...
 
void CollectDataExternalEvent ()
 
void DeployAction (KSPActionParam actParams)
 
void DeployExperiment ()
 
void DeployExperimentExternal ()
 
void DumpData (ScienceData data)
 Caleld to discard stored data on the module. Will be called right after GetData if the data was moved. More...
 
ScienceData[] GetData ()
 Called when about to transmit data using comms equipment or when transferring data to another container. Return any gathered data or null if none, do not discard data. More...
 
override string GetInfo ()
 Returns formatted string of additional data for use in the VAB and SPH More...
 
override string GetModuleDisplayName ()
 Override this to provide a Localized version of the PartModules Name for UI components More...
 
int GetScienceCount ()
 Called to get the total count of ScienceDatas stored on this unit. More...
 
override string GetStagingDisableText ()
 
override string GetStagingEnableText ()
 
bool IsRerunnable ()
 
override bool IsStageable ()
 Should this module be counted when seeing whether to have a stack icon present? Override in a module for custom behavior; otherwise returns true if the module (or something the module inherits from above PartModule itself) overrides OnActive() More...
 
override void OnActive ()
 Called when the part is set active (after unpacking etc) More...
 
override void OnAwake ()
 Method fires once the module has been added to the part. Use for first time setup. Module will not have loaded fully by this point More...
 
void onCollectData (ModuleScienceContainer vesselContainer)
 
void OnCommandSeatInteraction (KerbalEVA eva, bool entered)
 
void OnDataTransfer (PartItemTransfer.DismissAction dma, Part containerPart)
 
void OnDestroy ()
 
override void OnInventoryModeDisable ()
 This method will be called when this modules part and itself is first disabled (when it is not attached to a vessel) when created in Inventory/Construction mode. More...
 
override void OnInventoryModeEnable ()
 This method will be called when this modules part and itself is first enabled (when it is attached to a vessel) when created in Inventory/Construction mode. More...
 
override void OnLoad (ConfigNode node)
 Use OnLoad to load any additional data from the ConfigNode provided More...
 
void OnModuleInventoryChanged (ModuleInventoryPart inventoryPart)
 
override void OnSave (ConfigNode node)
 Use OnSave to serialize additional module information into the ConfigNode provided More...
 
override void OnStart (PartModule.StartState state)
 
void OnVesselModified (Vessel v)
 
void OnVesselSituationChange (GameEvents.HostedFromToAction< Vessel, Vessel.Situations > vcs)
 
void ResetAction (KSPActionParam actParams)
 
delegate void ResetCallback ()
 Definition for the method which will be called when the experiment is finished with the reset. More...
 
void ResetExperiment ()
 Event Method that resets the experiment by deleting the data and resetting the variables More...
 
void ResetExperimentExternal ()
 Event Method that resets the experiment by deleting the data and resetting the variables - when on EVA More...
 
void ReturnData (ScienceData data)
 Called when a transmission (for whatever reason) fails. Attempts to return the data back to the container that it came from. More...
 
void ReviewData ()
 
void ReviewDataEvent ()
 
void ReviewDataItem (ScienceData data)
 
void SetInoperable ()
 
override bool StagingEnabled ()
 Gets current staging status (is staging enabled for this module) Override me! More...
 
override bool StagingToggleEnabledEditor ()
 
override bool StagingToggleEnabledFlight ()
 
void TransferDataEvent ()
 
void TransferToContainer (ModuleScienceContainer container, string destName)
 
void Update ()
 
- Public Member Functions inherited from PartModule
void AddPartModuleAdjuster (AdjusterPartModuleBase newAdjuster)
 Call this to add an adjuster to this part module. More...
 
void AddPartModuleAdjusterList (List< AdjusterPartModuleBase > moduleAdjusters)
 Applies the appropriate module adjusters. Performs checks to make sure that the adjusters are valid too. More...
 
bool AppliedUpgrades ()
 Returns true if upgrades are applied More...
 
void ApplyAdjustersOnStart ()
 Called when a part module is loaded and applies all of the currently loaded adjusters. More...
 
virtual void ApplyUpgradeNode (List< string > appliedUps, ConfigNode node, bool doLoad)
 Applies the upgrades to a confignode. Will either copy the upgrades back to the node or (if doLoad) calls load/onload on it. More...
 
virtual bool ApplyUpgrades (StartState state)
 Will find and apply upgrades. Called during Part's ModulesOnStart, before a module's OnStart. More...
 
void Awake ()
 
delegate bool boolPMApplyUpgrades (PartModule pm, StartState state)
 
delegate bool boolPMBoolDelegate (PartModule pm, bool apply)
 
void ClearPersistentId ()
 Clear the modules persistentId More...
 
void Copy (PartModule fromModule)
 
virtual void DemoteToPhysicslessPart ()
 This method will be called from Part class DemoteToPhysicslessPart when the part is being converted from physical to physicsless part. It is called before the joints and rigidbodies are destroyed. More...
 
virtual bool FindUpgrades (bool fillApplied, ConfigNode node=null)
 Find applicable upgrades to the partmodule (isunlocked and isenabled) and add to the upgradesApplied list. Pass true if you want to add the upgrades to upgradesApplied, false if you just want to know if at least one upgrade is applicable (unlocked rather than enabled) More...
 
virtual Color GetCurrentColor ()
 Returns the current part module color. More...
 
virtual Color GetCurrentColor (string fieldName)
 Returns the current part module color for a field where usespe. More...
 
uint GetPersistenActiontId ()
 Get the modules persistentID, and create one if it doesnt already have one More...
 
uint GetPersistentId ()
 Get the modules persistentID, and create one if it doesnt already have one More...
 
virtual string GetUpgradeInfo ()
 Called by Upgrade Stats dialog More...
 
bool HasUpgrades ()
 Returns true if upgrades exist for the partmodule More...
 
bool IsValidContractObjective (string objectiveType)
 Returns if, for example, an antenna part module qualifies as an antenna for contracts. More...
 
void Load (ConfigNode node)
 
virtual void LoadUpgrades (ConfigNode node)
 Loads module-relevant upgrades from the partmodule confignode More...
 
uint NewPersistentId ()
 Reset the modules persistentId to a new number More...
 
virtual void OnColorChanged (Color color)
 Meant to be overwritten by part modules implementing color changes. In this case, it doesn't matter which color picker changed specifically. More...
 
virtual void OnColorChanged (Color color, string pickerID="")
 Meant to be overwritten by part modules implementing color changes More...
 
virtual void OnConstructionModeFixedUpdate ()
 This method will be called when in EVA Construction mode and this part and itself is disabled (when it is not attached to a vessel) every FixedUpdate(). More...
 
virtual void OnConstructionModeUpdate ()
 This method will be called when in EVA Construction mode and this part and itself is disabled (when it is not attached to a vessel) every Update(). More...
 
virtual void OnCopy (PartModule fromModule)
 Use OnCopy to copy any additional data from the PartModule provided More...
 
virtual void OnFixedUpdate ()
 Called every physics/fixed frame that the part is active More...
 
virtual void OnIconCreate ()
 Method fires just before components are stripped from the gameobject to make it an icon. (The part is instantiated and then various components like Part, PartModule, EffectBehaviour, Colliders, Particles, etc are stripped and then it's set as the icon prefab. This lets PartModules do stuff to the model right before that happens. More...
 
virtual void OnInactive ()
 Called before the part goes inactive (after packing etc) More...
 
virtual void OnInitialize ()
 Called on all modules after all parts are loaded but before they give the ship to the game More...
 
void OnModuleAdjusterAddedWrapper (AdjusterPartModuleBase adjuster)
 Wrapper to check the mission expansion availability before performing processing specific to this part module when an adjuster is added. More...
 
virtual void OnModuleAdjusterRemoved (AdjusterPartModuleBase adjuster)
 Perform processing specific to this part module when an adjuster is removed. By default this does nothing is up to each part module to implement it properly. More...
 
virtual void OnPartCreatedFomInventory (ModuleInventoryPart moduleInventoryPart)
 This method is called when a part is being taken out from a slot while being in EVAConstruction mode. More...
 
virtual void OnStart (StartState state)
 Called when the part starts. The StartState gives an indication of where in flight you are. All values may not be plugged in! More...
 
virtual void OnStartBeforePartAttachJoint (StartState state)
 Called in flight scene in Part.Start just before the Part attachnode joints are created. More...
 
virtual void OnStartFinished (StartState state)
 Called when the part finishes starting. The StartState gives an indication of where in flight you are. All values may not be plugged in! More...
 
virtual void OnStoredInInventory (ModuleInventoryPart moduleInventoryPart)
 Called when the part is stored in an inventory. More...
 
virtual void OnUpdate ()
 Called every frame that the part is active More...
 
virtual void OnWasCopied (PartModule copyPartModule, bool asSymCounterpart)
 Called when the PartModule was copied, through Alt+Copy or symmetry More...
 
virtual void OnWillBeCopied (bool asSymCounterpart)
 Called when the PartModule is about to be copied, through Alt+Copy or symmetry More...
 
virtual bool OnWillBeMirrored (ref Quaternion rotation, AttachNode selPartNode, Part partParent)
 This is called in the Editor scene when a symmetry copy of a part is being positioned. Only called on the symmetry parts and only when symmetry mode is set to Mirror. It allows the mirror rotation to be changed and returned before being applied to the symmetry copy part.

Parameters
rotationThe current calculated rotation. Will be updated if method returns true.
selPartNodeThe attachnode.
partParentThe part that will become this part's parent.
Returns
True if the rotation was changed. Otherwise will return false.
More...
 
virtual List< Color > PresetColors ()
 Preset colors received for any part module. By default, returns only black, override to make your own selection. More...
 
virtual string PrintUpgrades ()
 
virtual void PromoteToPhysicalPart ()
 This method will be called from Part class PromoteToPhysicalPart when the part is being converted from physicsless to physical part. More...
 
void RemovePartModuleAdjuster (AdjusterPartModuleBase oldAdjuster)
 Call this to remove an adjuster from this part module. More...
 
void RemovePartModuleAdjusterList (List< AdjusterPartModuleBase > moduleAdjusters)
 Removes the appropriate module adjusters. Performs checks to make sure that the adjusters are valid too. More...
 
void Save (ConfigNode node)
 
virtual void SetStaging (bool newValue)
 Run by the part's staging toggle handler, sets staging on modules on symmetry counterparts. More...
 
void SetStagingState (bool newState)
 Set the staging enabled bool for this module. More...
 
void ToggleStaging ()
 
virtual void UpdateStagingToggle ()
 Updates the staging toggle More...
 
delegate void voidPMApplyNodeDelegate (PartModule pm, List< string > appliedUps, ConfigNode node, bool doLoad)
 
delegate void voidPMDelegate (PartModule pm)
 
delegate void voidPMNodeDelegate (PartModule pm, ConfigNode node)
 

Public Attributes

bool availableShielded = true
 
string collectActionName = "#autoLOC_238018"
 
string collectWarningText = Localizer.Format("#autoLOC_6001027")
 
bool containersDirty = false
 
string cooldownString
 the experiment is defined in R&D. here we just store a reference to it. More...
 
double cooldownTimer = 0d
 If given, must wait this many seconds between taking the data out (EVA or transmit) and More...
 
double cooldownToGo = 0d
 
bool dataIsCollectable = false
 
bool deployableSeated = true
 
bool Deployed
 
bool DeployEventDisabled
 Set to True will disable the Deploy Event and Deploy Experiment External Event and Deploy Action group for the Experiment. You then have to deploy the experiment in another modules code. More...
 
float dialogDelay = 0f
 Set this to a value (in seconds) to delay the science results dialog from being displayed. More...
 
List< EVASituationevaSituations
 This is a list of EVASituations tha was read from the confignode. More...
 
ScienceExperiment experiment
 the subject is given by R&D when deploying an experiment in some particular situation More...
 
string experimentActionName = "#autoLOC_6001437"
 Display string for the Experiment Action PAW item More...
 
string experimentID
 
string extraResultString
 
int[] fxModuleIndices
 
bool hasContainer = false
 
bool hideFxModuleUI = true
 
bool hideUIwhenUnavailable
 
bool Inoperable
 
float interactionRange = 1.5f
 
ResetCallback OnExperimentReset
 Method which will be called when the experiment is finished with the reset. Will be set to null once the call has been made. More...
 
string requiredInventoryPart = "evaScienceKit"
 The Part name of the Cargo Part required. More...
 
bool requiresEVASituation = false
 Set to true if this experiment requires a specific EVA Situation to be runnable. More...
 
bool requiresInventoryPart = false
 Set to true if this Experiment requires a Cargo Part to be in ModuleInventoryPart on this part. More...
 
bool rerunnable = false
 Set to true if it should be possible to perform this experiment again without having to clean the experiment with the lab or a scientist on EVA. More...
 
string resetActionName = "#autoLOC_6001438"
 Display string for the Experiment Reset PAW item More...
 
bool resettable = true
 Whether an experiment can be reset - usually via the Part Action Window More...
 
bool resettableOnEVA = true
 Whether an experiment can be reset from a Kerbal on EVA - usually via the Part Action Window More...
 
float resourceResetCost = 1.0f
 Amount of resourceToReset Resource that will be spent when the experiment is restored to a runnable state via the lab More...
 
string resourceToReset = "ElectricCharge"
 The Resource that will be spent when the experiment is restored to a runnable state via the lab More...
 
string reviewActionName = "#autoLOC_6001439"
 Display string for the Experiment Review PAW item More...
 
float scienceValueRatio = 1.0f
 Different parts can generate different amounts of science. We control how much using the science value ratio. It should be a value between 0 and 1 representing a percentage of the overall scienceCap. More...
 
bool showScienceValueRatio = false
 Should the science value ratio be displayed in the part extended information in the VAB/SPH? More...
 
string transmitWarningText = Localizer.Format("#autoLOC_6001026")
 
int usageReqMaskExternal = (int)ExperimentUsageReqs.Never
 
int usageReqMaskInternal = (int)ExperimentUsageReqs.VesselControl
 
string usageReqMessage = ""
 
bool useActionGroups
 
bool useCooldown = false
 
bool useStaging
 
float xmitDataScalar = 0.5f
 
- Public Attributes inherited from PartModule
bool isEnabled = true
 
bool moduleIsEnabled = true
 
string moduleName
 
bool overrideStagingIconIfBlank = true
 
ModuleResourceHandler resHandler = new ModuleResourceHandler()
 
bool showUpgradesInModuleInfo = false
 
ProtoPartModuleSnapshot snapshot
 
string stagingDisableText = ""
 
bool stagingEnabled = true
 
string stagingEnableText = ""
 
bool stagingToggleEnabledEditor = false
 
bool stagingToggleEnabledFlight = false
 
List< ConfigNodeupgrades
 
List< string > upgradesApplied = new List<string>()
 
bool upgradesApply = true
 
bool upgradesAsk = true
 

Properties

bool HasExperimentData [get]
 True if the ModuleScienceExperiment has already recorded data from an experiment, false otherwise. More...
 
- Properties inherited from PartModule
BaseActionList Actions [get]
 
int ClassID [get]
 
string ClassName [get]
 
List< AdjusterPartModuleBaseCurrentModuleAdjusterList [get]
 List of all the module adjusters that are currently active on this part module. More...
 
BaseEventList Events [get]
 
BaseFieldList Fields [get]
 
string GUIName [get]
 
bool HasAdjusters [get]
 Has this part module been adjusted? More...
 
ReflectedAttributes ModuleAttributes [get, set]
 
Part part [get, set]
 
uint PersistentActionsId [get, set]
 A unique identifier for each vessel including from when it was Shipconstruct More...
 
uint PersistentId [get]
 A unique identifier for each vessel including from when it was Shipconstruct More...
 
Vessel vessel [get]
 

Additional Inherited Members

- Public Types inherited from PartModule
enum  PartUpgradeState { PartUpgradeState.NONE, PartUpgradeState.LOCKED, PartUpgradeState.AVAILABLE }
 
enum  StartState {
  StartState.None = 0, StartState.Editor = 1, StartState.PreLaunch = 2, StartState.Landed = 4,
  StartState.Docked = 8, StartState.Flying = 16, StartState.Splashed = 32, StartState.SubOrbital = 64,
  StartState.Orbital = 128
}
 
- Static Public Member Functions inherited from PartModule
static ReflectedAttributes GetReflectedAttributes (Type partModuleType)
 
static PartUpgradeState UpgradesAvailable (Part part)
 Returns true if at least one module on the part has at least one upgrade available (isUnlocked) More...
 
static PartUpgradeState UpgradesAvailable (Part part, ConfigNode node)
 Returns true if at least one module on the part has at least one upgrade available (isUnlocked) More...
 
- Static Public Attributes inherited from PartModule
static voidPMApplyNodeDelegate ApplyUpgradeNodeDel
 
static boolPMApplyUpgrades ApplyUpgradesDel
 
static bool ApplyUpgradesEditorAuto = true
 
static boolPMBoolDelegate FindUpgradesDel
 
static voidPMNodeDelegate LoadExpansionNodes
 Hook for loading extra nodes common to all part modules. More...
 
static voidPMNodeDelegate LoadUpgradesDel
 
static voidPMNodeDelegate SaveExpansionNodes
 Hook for saving extra nodes common to all part modules. More...
 
static voidPMDelegate SetupExpansion
 Hook for performing extra setup common to all part modules. More...
 
static string UpgradesAvailableString = "#autoLOC_6002273"
 
static string UpgradesLockedString = "#autoLOC_6002274"
 
- Protected Member Functions inherited from PartModule
ConfigNode GetUpgrade (string name)
 
virtual void LoadUpgradesApplied (List< string > applieds, ConfigNode node)
 Load the applied upgrade names More...
 
virtual void OnModuleAdjusterAdded (AdjusterPartModuleBase adjuster)
 Perform processing specific to this part module when an adjuster is added. By default this does nothing is up to each part module to implement it properly. More...
 
virtual void SaveUpgradesApplied (ConfigNode node)
 Save the applied upgrades. More...
 
IEnumerator UpgradeWaitForScenarioModules ()
 
- Static Protected Attributes inherited from PartModule
static Dictionary< string,
ConfigNode
exclusives = new Dictionary<string, ConfigNode>()
 
static Dictionary< Type,
ReflectedAttributes
reflectedAttributeCache = new Dictionary<Type, ReflectedAttributes>()
 

Member Function Documentation

virtual bool ModuleScienceExperiment.CanBeDetached ( )
inlinevirtual

Returns true if experiment is not being reset.

Returns
virtual bool ModuleScienceExperiment.CanBeOffset ( )
inlinevirtual

Returns true if experiment is not being reset.

Returns
virtual bool ModuleScienceExperiment.CanBeRotated ( )
inlinevirtual

Returns true if experiment is not being reset.

Returns
void ModuleScienceExperiment.CleanUpExperimentExternal ( )
inline

Event Method that resets an experiment that is Inoperable until a manual reset by a scientist

void ModuleScienceExperiment.CollectDataExternalEvent ( )
inline
void ModuleScienceExperiment.DeployAction ( KSPActionParam  actParams)
inline
void ModuleScienceExperiment.DeployExperiment ( )
inline
void ModuleScienceExperiment.DeployExperimentExternal ( )
inline
void ModuleScienceExperiment.DumpData ( ScienceData  data)
inline

Caleld to discard stored data on the module. Will be called right after GetData if the data was moved.

Implements IScienceDataContainer.

ScienceData [] ModuleScienceExperiment.GetData ( )
inline

Called when about to transmit data using comms equipment or when transferring data to another container. Return any gathered data or null if none, do not discard data.

Returns

Implements IScienceDataContainer.

override string ModuleScienceExperiment.GetInfo ( )
inlinevirtual

Returns formatted string of additional data for use in the VAB and SPH

Returns

Reimplemented from PartModule.

override string ModuleScienceExperiment.GetModuleDisplayName ( )
inlinevirtual

Override this to provide a Localized version of the PartModules Name for UI components

Returns

Reimplemented from PartModule.

int ModuleScienceExperiment.GetScienceCount ( )
inline

Called to get the total count of ScienceDatas stored on this unit.

Returns

Implements IScienceDataContainer.

override string ModuleScienceExperiment.GetStagingDisableText ( )
inlinevirtual

Reimplemented from PartModule.

override string ModuleScienceExperiment.GetStagingEnableText ( )
inlinevirtual

Reimplemented from PartModule.

bool ModuleScienceExperiment.IsRerunnable ( )
inline

Implements IScienceDataContainer.

override bool ModuleScienceExperiment.IsStageable ( )
inlinevirtual

Should this module be counted when seeing whether to have a stack icon present? Override in a module for custom behavior; otherwise returns true if the module (or something the module inherits from above PartModule itself) overrides OnActive()

Reimplemented from PartModule.

override void ModuleScienceExperiment.OnActive ( )
inlinevirtual

Called when the part is set active (after unpacking etc)

Reimplemented from PartModule.

override void ModuleScienceExperiment.OnAwake ( )
inlinevirtual

Method fires once the module has been added to the part. Use for first time setup. Module will not have loaded fully by this point

Reimplemented from PartModule.

void ModuleScienceExperiment.onCollectData ( ModuleScienceContainer  vesselContainer)
inline
void ModuleScienceExperiment.OnCommandSeatInteraction ( KerbalEVA  eva,
bool  entered 
)
inline
void ModuleScienceExperiment.OnDataTransfer ( PartItemTransfer.DismissAction  dma,
Part  containerPart 
)
inline
void ModuleScienceExperiment.OnDestroy ( )
inline
override void ModuleScienceExperiment.OnInventoryModeDisable ( )
inlinevirtual

This method will be called when this modules part and itself is first disabled (when it is not attached to a vessel) when created in Inventory/Construction mode.

Reimplemented from PartModule.

override void ModuleScienceExperiment.OnInventoryModeEnable ( )
inlinevirtual

This method will be called when this modules part and itself is first enabled (when it is attached to a vessel) when created in Inventory/Construction mode.

Reimplemented from PartModule.

override void ModuleScienceExperiment.OnLoad ( ConfigNode  node)
inlinevirtual

Use OnLoad to load any additional data from the ConfigNode provided

Parameters
node

Reimplemented from PartModule.

void ModuleScienceExperiment.OnModuleInventoryChanged ( ModuleInventoryPart  inventoryPart)
inline
override void ModuleScienceExperiment.OnSave ( ConfigNode  node)
inlinevirtual

Use OnSave to serialize additional module information into the ConfigNode provided

Parameters
node

Reimplemented from PartModule.

override void ModuleScienceExperiment.OnStart ( PartModule.StartState  state)
inline
void ModuleScienceExperiment.OnVesselModified ( Vessel  v)
inline
void ModuleScienceExperiment.OnVesselSituationChange ( GameEvents.HostedFromToAction< Vessel, Vessel.Situations vcs)
inline
void ModuleScienceExperiment.ResetAction ( KSPActionParam  actParams)
inline
delegate void ModuleScienceExperiment.ResetCallback ( )

Definition for the method which will be called when the experiment is finished with the reset.

void ModuleScienceExperiment.ResetExperiment ( )
inline

Event Method that resets the experiment by deleting the data and resetting the variables

void ModuleScienceExperiment.ResetExperimentExternal ( )
inline

Event Method that resets the experiment by deleting the data and resetting the variables - when on EVA

void ModuleScienceExperiment.ReturnData ( ScienceData  data)
inline

Called when a transmission (for whatever reason) fails. Attempts to return the data back to the container that it came from.

Implements IScienceDataContainer.

void ModuleScienceExperiment.ReviewData ( )
inline

Implements IScienceDataContainer.

void ModuleScienceExperiment.ReviewDataEvent ( )
inline
void ModuleScienceExperiment.ReviewDataItem ( ScienceData  data)
inline

Implements IScienceDataContainer.

void ModuleScienceExperiment.SetInoperable ( )
inline
override bool ModuleScienceExperiment.StagingEnabled ( )
inlinevirtual

Gets current staging status (is staging enabled for this module) Override me!

Returns
True iff staging enabled for this module

Reimplemented from PartModule.

override bool ModuleScienceExperiment.StagingToggleEnabledEditor ( )
inlinevirtual

Reimplemented from PartModule.

override bool ModuleScienceExperiment.StagingToggleEnabledFlight ( )
inlinevirtual

Reimplemented from PartModule.

void ModuleScienceExperiment.TransferDataEvent ( )
inline
void ModuleScienceExperiment.TransferToContainer ( ModuleScienceContainer  container,
string  destName 
)
inline
void ModuleScienceExperiment.Update ( )
inline

Member Data Documentation

bool ModuleScienceExperiment.availableShielded = true
string ModuleScienceExperiment.collectActionName = "#autoLOC_238018"
string ModuleScienceExperiment.collectWarningText = Localizer.Format("#autoLOC_6001027")
bool ModuleScienceExperiment.containersDirty = false
string ModuleScienceExperiment.cooldownString

the experiment is defined in R&D. here we just store a reference to it.

double ModuleScienceExperiment.cooldownTimer = 0d

If given, must wait this many seconds between taking the data out (EVA or transmit) and

double ModuleScienceExperiment.cooldownToGo = 0d
bool ModuleScienceExperiment.dataIsCollectable = false
bool ModuleScienceExperiment.deployableSeated = true
bool ModuleScienceExperiment.Deployed
bool ModuleScienceExperiment.DeployEventDisabled

Set to True will disable the Deploy Event and Deploy Experiment External Event and Deploy Action group for the Experiment. You then have to deploy the experiment in another modules code.

float ModuleScienceExperiment.dialogDelay = 0f

Set this to a value (in seconds) to delay the science results dialog from being displayed.

List<EVASituation> ModuleScienceExperiment.evaSituations

This is a list of EVASituations tha was read from the confignode.

ScienceExperiment ModuleScienceExperiment.experiment

the subject is given by R&D when deploying an experiment in some particular situation

string ModuleScienceExperiment.experimentActionName = "#autoLOC_6001437"

Display string for the Experiment Action PAW item

string ModuleScienceExperiment.experimentID
string ModuleScienceExperiment.extraResultString
int [] ModuleScienceExperiment.fxModuleIndices
bool ModuleScienceExperiment.hasContainer = false
bool ModuleScienceExperiment.hideFxModuleUI = true
bool ModuleScienceExperiment.hideUIwhenUnavailable
bool ModuleScienceExperiment.Inoperable
float ModuleScienceExperiment.interactionRange = 1.5f
ResetCallback ModuleScienceExperiment.OnExperimentReset

Method which will be called when the experiment is finished with the reset. Will be set to null once the call has been made.

string ModuleScienceExperiment.requiredInventoryPart = "evaScienceKit"

The Part name of the Cargo Part required.

bool ModuleScienceExperiment.requiresEVASituation = false

Set to true if this experiment requires a specific EVA Situation to be runnable.

bool ModuleScienceExperiment.requiresInventoryPart = false

Set to true if this Experiment requires a Cargo Part to be in ModuleInventoryPart on this part.

bool ModuleScienceExperiment.rerunnable = false

Set to true if it should be possible to perform this experiment again without having to clean the experiment with the lab or a scientist on EVA.

See the resourceToReset and resourceResetCost variables for the cost of cleaning

string ModuleScienceExperiment.resetActionName = "#autoLOC_6001438"

Display string for the Experiment Reset PAW item

bool ModuleScienceExperiment.resettable = true

Whether an experiment can be reset - usually via the Part Action Window

bool ModuleScienceExperiment.resettableOnEVA = true

Whether an experiment can be reset from a Kerbal on EVA - usually via the Part Action Window

float ModuleScienceExperiment.resourceResetCost = 1.0f

Amount of resourceToReset Resource that will be spent when the experiment is restored to a runnable state via the lab

string ModuleScienceExperiment.resourceToReset = "ElectricCharge"

The Resource that will be spent when the experiment is restored to a runnable state via the lab

string ModuleScienceExperiment.reviewActionName = "#autoLOC_6001439"

Display string for the Experiment Review PAW item

float ModuleScienceExperiment.scienceValueRatio = 1.0f

Different parts can generate different amounts of science. We control how much using the science value ratio. It should be a value between 0 and 1 representing a percentage of the overall scienceCap.

bool ModuleScienceExperiment.showScienceValueRatio = false

Should the science value ratio be displayed in the part extended information in the VAB/SPH?

string ModuleScienceExperiment.transmitWarningText = Localizer.Format("#autoLOC_6001026")
int ModuleScienceExperiment.usageReqMaskExternal = (int)ExperimentUsageReqs.Never
int ModuleScienceExperiment.usageReqMaskInternal = (int)ExperimentUsageReqs.VesselControl
string ModuleScienceExperiment.usageReqMessage = ""
bool ModuleScienceExperiment.useActionGroups
bool ModuleScienceExperiment.useCooldown = false
bool ModuleScienceExperiment.useStaging
float ModuleScienceExperiment.xmitDataScalar = 0.5f

Property Documentation

bool ModuleScienceExperiment.HasExperimentData
get

True if the ModuleScienceExperiment has already recorded data from an experiment, false otherwise.


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