Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Properties | List of all members
Expansions.Serenity.Contracts.CollectDeployedScience Class Reference
Inheritance diagram for Expansions.Serenity.Contracts.CollectDeployedScience:
Contracts.ContractParameter Contracts.IContractParameterHost

Public Member Functions

 CollectDeployedScience ()
 
 CollectDeployedScience (CelestialBody targetBody, string subjectId, string scienceTitle, float sciencePercentage)
 
- Public Member Functions inherited from Contracts.ContractParameter
ContractParameter AddParameter (ContractParameter parameter, string id=null)
 
bool AllChildParametersComplete ()
 
bool AnyChildParametersFailed ()
 
long CreateID ()
 
void Disable (bool recursive=false)
 
void Enable ()
 
ContractParameter GetParameter (int index)
 
ContractParameter GetParameter (string id)
 
ContractParameter GetParameter (System.Type type)
 
GetParameter< T > (string id=null)
 
void Load (ConfigNode node)
 
void NestToParent (IContractParameterHost parent)
 
void ParameterStateUpdate (ContractParameter p)
 
void Register ()
 
void RemoveParameter (int index)
 
void RemoveParameter (string id)
 
void RemoveParameter (System.Type type)
 
void RemoveParameter (ContractParameter parameter)
 
void Reset ()
 
void Save (ConfigNode node)
 
void SetFunds (float completion, CelestialBody body=null)
 
void SetFunds (float completion, float failure, CelestialBody body=null)
 
void SetReputation (float completion, float failure, CelestialBody body=null)
 
void SetReputation (float completion, CelestialBody body=null)
 
void SetScience (float completion, CelestialBody body=null)
 
void Unregister ()
 
void Update ()
 

Public Attributes

float ScienceCollected
 The Percentage of Science collected More...
 
float SciencePercentage
 The Percentage of Science required (of the total available for the Science Subject) More...
 
string ScienceTitle
 The title of the science experiment More...
 
- Public Attributes inherited from Contracts.ContractParameter
double FundsCompletion
 The funds gained for completing this parameter More...
 
double FundsFailure
 The funds gained for failing this parameter More...
 
EventData< ContractParameter,
ParameterState
OnStateChange = new EventData<ContractParameter, ParameterState>("OnStateChange")
 
float ReputationCompletion
 The reputation gain for completing this parameter More...
 
float ReputationFailure
 The reputation gain for failing this parameter More...
 
float ScienceCompletion
 The science gained for completing this parameter More...
 

Protected Member Functions

override string GetHashString ()
 
override string GetTitle ()
 
override void OnLoad (ConfigNode node)
 
override void OnRegister ()
 
override void OnSave (ConfigNode node)
 
override void OnUnregister ()
 
- Protected Member Functions inherited from Contracts.ContractParameter
virtual void AwardCompletion ()
 
virtual string GetMessageComplete ()
 
virtual string GetMessageFailed ()
 
virtual string GetMessageIncomplete ()
 
virtual string GetNotes ()
 
virtual void OnParameterStateChange (ContractParameter p)
 
virtual void OnReset ()
 
virtual void OnUpdate ()
 
virtual void PenalizeFailure ()
 
void SendStateMessage (string title, string message, MessageSystemButton.MessageButtonColor color, MessageSystemButton.ButtonIcons icon)
 Sends user a text message via messaging system More...
 
void SetComplete ()
 
void SetFailed ()
 
void SetIncomplete ()
 

Protected Attributes

float scienceCollected
 
float sciencePercentage
 
string scienceTitle = ""
 
string subjectId = ""
 
CelestialBody targetBody
 
- Protected Attributes inherited from Contracts.ContractParameter
bool allowPartialFailure = false
 
bool disableOnStateChange = true
 
bool enabled = true
 
string id = null
 
bool optional = false
 
ParameterState state = ParameterState.Incomplete
 

Properties

string SubjectId [get]
 The Science Subject Id More...
 
CelestialBody TargetBody [get]
 The Target CelestialBody More...
 
- Properties inherited from Contracts.ContractParameter
bool AllowPartialFailure [get, set]
 Whether a parameter failure also fails the contract. More...
 
IEnumerable< ContractParameterAllParameters [get]
 
bool DisableOnStateChange [get, set]
 
bool Enabled [get, set]
 
string HashString [get]
 
string ID [get, set]
 
string MessageComplete [get]
 
string MessageFailed [get]
 
string MessageIncomplete [get]
 
string Notes [get]
 
bool Optional [get, set]
 
int ParameterCount [get]
 
IContractParameterHost Parent [get]
 
Contract Root [get]
 
ParameterState State [get]
 
ContractParameter this[int index] [get]
 
ContractParameter this[string id] [get]
 
ContractParameter this[System.Type type] [get]
 
string Title [get]
 
- Properties inherited from Contracts.IContractParameterHost
int ParameterCount [get]
 
IContractParameterHost Parent [get]
 
Contract Root [get]
 
ContractParameter this[int index] [get]
 
ContractParameter this[string id] [get]
 
ContractParameter this[System.Type type] [get]
 
string Title [get]
 

Constructor & Destructor Documentation

Expansions.Serenity.Contracts.CollectDeployedScience.CollectDeployedScience ( )
inline
Expansions.Serenity.Contracts.CollectDeployedScience.CollectDeployedScience ( CelestialBody  targetBody,
string  subjectId,
string  scienceTitle,
float  sciencePercentage 
)
inline

Member Function Documentation

override string Expansions.Serenity.Contracts.CollectDeployedScience.GetHashString ( )
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override string Expansions.Serenity.Contracts.CollectDeployedScience.GetTitle ( )
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override void Expansions.Serenity.Contracts.CollectDeployedScience.OnLoad ( ConfigNode  node)
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override void Expansions.Serenity.Contracts.CollectDeployedScience.OnRegister ( )
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override void Expansions.Serenity.Contracts.CollectDeployedScience.OnSave ( ConfigNode  node)
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override void Expansions.Serenity.Contracts.CollectDeployedScience.OnUnregister ( )
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

Member Data Documentation

float Expansions.Serenity.Contracts.CollectDeployedScience.scienceCollected
protected
float Expansions.Serenity.Contracts.CollectDeployedScience.ScienceCollected

The Percentage of Science collected

float Expansions.Serenity.Contracts.CollectDeployedScience.sciencePercentage
protected
float Expansions.Serenity.Contracts.CollectDeployedScience.SciencePercentage

The Percentage of Science required (of the total available for the Science Subject)

string Expansions.Serenity.Contracts.CollectDeployedScience.scienceTitle = ""
protected
string Expansions.Serenity.Contracts.CollectDeployedScience.ScienceTitle

The title of the science experiment

string Expansions.Serenity.Contracts.CollectDeployedScience.subjectId = ""
protected
CelestialBody Expansions.Serenity.Contracts.CollectDeployedScience.targetBody
protected

Property Documentation

string Expansions.Serenity.Contracts.CollectDeployedScience.SubjectId
get

The Science Subject Id

CelestialBody Expansions.Serenity.Contracts.CollectDeployedScience.TargetBody
get

The Target CelestialBody


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