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

Science Containers, unlike experiments, cannot gather their own data, they have to have it transferred to them. Used to store data like surface samples gathered while out on EVA. More...

Inheritance diagram for ModuleScienceContainer:
PartModule IScienceDataContainer

Public Member Functions

bool AddData (ScienceData data)
 
void CollectAllAction (KSPActionParam actParams)
 
void CollectAllEvent ()
 
void CollectDataExternalEvent ()
 
void DumpData (ScienceData data)
 Caleld to discard stored data on the module. Will be called right after GetData if the data was moved. More...
 
int GetActiveVesselDataCount ()
 
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 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...
 
int GetStoredDataCount ()
 
bool HasData (ScienceData data)
 
bool IsRerunnable ()
 
void OnDataTransfer (PartItemTransfer.DismissAction dma, Part containerPart)
 
void OnDestroy ()
 
override void OnLoad (ConfigNode node)
 Use OnLoad to load any additional data from the ConfigNode provided More...
 
override void OnSave (ConfigNode node)
 Use OnSave to serialize additional module information into the ConfigNode provided More...
 
override void OnStart (PartModule.StartState state)
 
void RemoveData (ScienceData data)
 
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)
 
bool StoreData (List< IScienceDataContainer > containers, bool dumpRepeats, bool excludeScienceContainers=false, bool scienceContainerPriority=false)
 Will store scienceData from a passed in list of IScienceDataContainer type. The List is first sorted in Order from highest sciencedata count to lowest. If excludeScienceContainers is true any ModuleScienceContainer's in the input list will be removed (default false). If scienceContainerPriority is false any ModuleScienceContainer's in the input list will be moved to the end of the list. (default false). More...
 
void StoreDataExternalEvent ()
 
void TransferDataEvent ()
 
void TransferToContainer (ModuleScienceContainer activeVesselContainer, string targetName)
 
- 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...
 
virtual string GetInfo ()
 Returns formatted string of additional data for use in the VAB and SPH 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 GetStagingDisableText ()
 
virtual string GetStagingEnableText ()
 
virtual string GetUpgradeInfo ()
 Called by Upgrade Stats dialog More...
 
bool HasUpgrades ()
 Returns true if upgrades exist for the partmodule More...
 
virtual 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...
 
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 OnActive ()
 Called when the part is set active (after unpacking etc) More...
 
virtual 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...
 
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...
 
virtual 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...
 
virtual 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...
 
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...
 
virtual bool StagingEnabled ()
 Gets current staging status (is staging enabled for this module) Override me! More...
 
virtual bool StagingToggleEnabledEditor ()
 
virtual bool StagingToggleEnabledFlight ()
 
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 allowRepeatedSubjects = false
 
bool canBeTransferredToInVessel = false
 
bool canTransferInVessel = false
 
int capacity = 0
 the data storage capacity (0 for unlimited) More...
 
string collectActionName = Localizer.Format("#autoLOC_238018")
 
bool CollectOnlyOwnData = false
 
bool dataIsCollectable = true
 
bool dataIsRecoverable = true
 
bool dataIsStorable = true
 
bool evaOnlyStorage = true
 
string reviewActionName = Localizer.Format("#autoLOC_6001313")
 
bool showStatus = false
 
string status = ""
 
float storageRange = 1f
 
string storeActionName = Localizer.Format("#autoLOC_6001314")
 
- 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
 

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>()
 
- 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]
 

Detailed Description

Science Containers, unlike experiments, cannot gather their own data, they have to have it transferred to them. Used to store data like surface samples gathered while out on EVA.

Member Function Documentation

bool ModuleScienceContainer.AddData ( ScienceData  data)
inline
void ModuleScienceContainer.CollectAllAction ( KSPActionParam  actParams)
inline
void ModuleScienceContainer.CollectAllEvent ( )
inline
void ModuleScienceContainer.CollectDataExternalEvent ( )
inline
void ModuleScienceContainer.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.

int ModuleScienceContainer.GetActiveVesselDataCount ( )
inline
ScienceData [] ModuleScienceContainer.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 ModuleScienceContainer.GetModuleDisplayName ( )
inlinevirtual

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

Returns

Reimplemented from PartModule.

int ModuleScienceContainer.GetScienceCount ( )
inline

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

Returns

Implements IScienceDataContainer.

int ModuleScienceContainer.GetStoredDataCount ( )
inline
bool ModuleScienceContainer.HasData ( ScienceData  data)
inline
bool ModuleScienceContainer.IsRerunnable ( )
inline

Implements IScienceDataContainer.

void ModuleScienceContainer.OnDataTransfer ( PartItemTransfer.DismissAction  dma,
Part  containerPart 
)
inline
void ModuleScienceContainer.OnDestroy ( )
inline
override void ModuleScienceContainer.OnLoad ( ConfigNode  node)
inlinevirtual

Use OnLoad to load any additional data from the ConfigNode provided

Parameters
node

< load both types of data in, doesn't matter here

Reimplemented from PartModule.

override void ModuleScienceContainer.OnSave ( ConfigNode  node)
inlinevirtual

Use OnSave to serialize additional module information into the ConfigNode provided

Parameters
node

Reimplemented from PartModule.

override void ModuleScienceContainer.OnStart ( PartModule.StartState  state)
inline
void ModuleScienceContainer.RemoveData ( ScienceData  data)
inline
void ModuleScienceContainer.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 ModuleScienceContainer.ReviewData ( )
inline

Implements IScienceDataContainer.

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

Implements IScienceDataContainer.

bool ModuleScienceContainer.StoreData ( List< IScienceDataContainer containers,
bool  dumpRepeats,
bool  excludeScienceContainers = false,
bool  scienceContainerPriority = false 
)
inline

Will store scienceData from a passed in list of IScienceDataContainer type. The List is first sorted in Order from highest sciencedata count to lowest. If excludeScienceContainers is true any ModuleScienceContainer's in the input list will be removed (default false). If scienceContainerPriority is false any ModuleScienceContainer's in the input list will be moved to the end of the list. (default false).

Parameters
containersList of passed in IScienceDataContainer type
dumpRepeatsIf true repeat experiments found will be dumpled, if false they will be left where they are
excludeScienceContainersOptional Parameter (default false) - If true will Exclude any ModuleScienceContainers from the list before moving the science data
scienceContainerPriorityOptional Paramater (default false) - If true will give ModuleScienceContainers priority
Returns
void ModuleScienceContainer.StoreDataExternalEvent ( )
inline
void ModuleScienceContainer.TransferDataEvent ( )
inline
void ModuleScienceContainer.TransferToContainer ( ModuleScienceContainer  activeVesselContainer,
string  targetName 
)
inline

Member Data Documentation

bool ModuleScienceContainer.allowRepeatedSubjects = false
bool ModuleScienceContainer.canBeTransferredToInVessel = false
bool ModuleScienceContainer.canTransferInVessel = false
int ModuleScienceContainer.capacity = 0

the data storage capacity (0 for unlimited)

string ModuleScienceContainer.collectActionName = Localizer.Format("#autoLOC_238018")
bool ModuleScienceContainer.CollectOnlyOwnData = false
bool ModuleScienceContainer.dataIsCollectable = true
bool ModuleScienceContainer.dataIsRecoverable = true
bool ModuleScienceContainer.dataIsStorable = true
bool ModuleScienceContainer.evaOnlyStorage = true
string ModuleScienceContainer.reviewActionName = Localizer.Format("#autoLOC_6001313")
bool ModuleScienceContainer.showStatus = false
string ModuleScienceContainer.status = ""
float ModuleScienceContainer.storageRange = 1f
string ModuleScienceContainer.storeActionName = Localizer.Format("#autoLOC_6001314")

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