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 | List of all members
FinePrint.Contracts.Parameters.SpecificVesselParameter Class Reference
Inheritance diagram for FinePrint.Contracts.Parameters.SpecificVesselParameter:
FinePrint.Utilities.WaypointParameter Contracts.ContractParameter Contracts.IContractParameterHost

Public Member Functions

override void CleanupWaypoints ()
 
 SpecificVesselParameter ()
 
 SpecificVesselParameter (Vessel v)
 
void SpecificVesselRename (Guid id, string name)
 
void SpecificVesselScan (HashSet< Guid > ids)
 
void TargetVesselSearch (bool cached)
 
override void UpdateWaypoints (bool focus)
 Updates a WaypointParameter's waypoints on the map if the parameter's contract has the IUpdateWaypoints marker interface. More...
 
- Public Member Functions inherited from FinePrint.Utilities.WaypointParameter
virtual void SetupWaypoints ()
 
- 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

List< uint > partIDs
 
Vessel targetVessel
 
Guid targetVesselID
 
string targetVesselName
 
int targetVesselPartCount
 
Vessel.Situations targetVesselSituation
 
Waypoint wp
 
- Public Attributes inherited from FinePrint.Utilities.WaypointParameter
CelestialBody TargetBody
 
- 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 GetMessageComplete ()
 
override string GetNotes ()
 
override string GetTitle ()
 
override void OnLoad (ConfigNode node)
 
override void OnRegister ()
 
override void OnReset ()
 
override void OnSave (ConfigNode node)
 
override void OnUnregister ()
 
override void OnUpdate ()
 
- Protected Member Functions inherited from Contracts.ContractParameter
virtual void AwardCompletion ()
 
virtual string GetMessageFailed ()
 
virtual string GetMessageIncomplete ()
 
virtual void OnParameterStateChange (ContractParameter p)
 
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 ()
 

Additional Inherited Members

- 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 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

FinePrint.Contracts.Parameters.SpecificVesselParameter.SpecificVesselParameter ( )
inline
FinePrint.Contracts.Parameters.SpecificVesselParameter.SpecificVesselParameter ( Vessel  v)
inline

Member Function Documentation

override void FinePrint.Contracts.Parameters.SpecificVesselParameter.CleanupWaypoints ( )
inlinevirtual
override string FinePrint.Contracts.Parameters.SpecificVesselParameter.GetHashString ( )
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override string FinePrint.Contracts.Parameters.SpecificVesselParameter.GetMessageComplete ( )
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override string FinePrint.Contracts.Parameters.SpecificVesselParameter.GetNotes ( )
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override string FinePrint.Contracts.Parameters.SpecificVesselParameter.GetTitle ( )
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override void FinePrint.Contracts.Parameters.SpecificVesselParameter.OnLoad ( ConfigNode  node)
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override void FinePrint.Contracts.Parameters.SpecificVesselParameter.OnRegister ( )
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override void FinePrint.Contracts.Parameters.SpecificVesselParameter.OnReset ( )
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override void FinePrint.Contracts.Parameters.SpecificVesselParameter.OnSave ( ConfigNode  node)
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override void FinePrint.Contracts.Parameters.SpecificVesselParameter.OnUnregister ( )
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

override void FinePrint.Contracts.Parameters.SpecificVesselParameter.OnUpdate ( )
inlineprotectedvirtual

Reimplemented from Contracts.ContractParameter.

void FinePrint.Contracts.Parameters.SpecificVesselParameter.SpecificVesselRename ( Guid  id,
string  name 
)
inline
void FinePrint.Contracts.Parameters.SpecificVesselParameter.SpecificVesselScan ( HashSet< Guid >  ids)
inline
void FinePrint.Contracts.Parameters.SpecificVesselParameter.TargetVesselSearch ( bool  cached)
inline

< Can't run a cached search without a cached ID.

override void FinePrint.Contracts.Parameters.SpecificVesselParameter.UpdateWaypoints ( bool  focused)
inlinevirtual

Updates a WaypointParameter's waypoints on the map if the parameter's contract has the IUpdateWaypoints marker interface.

Parameters
focusedIf Targetbody has map focus.

< On non-active contracts this is the only function that will run. This simple check can keep an eye on changing vessels. It isn't fool proof, but on non-actives that's okay. Actives run this on top of the events for extra security.

< This only updates things that might have changed, set up is elsewhere.

Reimplemented from FinePrint.Utilities.WaypointParameter.

Member Data Documentation

List<uint> FinePrint.Contracts.Parameters.SpecificVesselParameter.partIDs
Vessel FinePrint.Contracts.Parameters.SpecificVesselParameter.targetVessel
Guid FinePrint.Contracts.Parameters.SpecificVesselParameter.targetVesselID
string FinePrint.Contracts.Parameters.SpecificVesselParameter.targetVesselName
int FinePrint.Contracts.Parameters.SpecificVesselParameter.targetVesselPartCount
Vessel.Situations FinePrint.Contracts.Parameters.SpecificVesselParameter.targetVesselSituation
Waypoint FinePrint.Contracts.Parameters.SpecificVesselParameter.wp

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