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
FinePrint.Utilities.WaypointParameter Class Reference

A simple abstract class that abstracts parameters with waypoints to set up, clean up, and update via WaypointManager. More...

Inheritance diagram for FinePrint.Utilities.WaypointParameter:
Contracts.ContractParameter Contracts.IContractParameterHost FinePrint.Contracts.Parameters.RoverWayPointParameter FinePrint.Contracts.Parameters.SpecificVesselParameter

Public Member Functions

virtual void CleanupWaypoints ()
 
virtual void SetupWaypoints ()
 
virtual void UpdateWaypoints (bool focused)
 Updates a WaypointParameter's waypoints on the map if the parameter's contract has the IUpdateWaypoints marker interface. More...
 
- 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

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

Additional Inherited Members

- Protected Member Functions inherited from Contracts.ContractParameter
virtual void AwardCompletion ()
 
virtual string GetHashString ()
 
virtual string GetMessageComplete ()
 
virtual string GetMessageFailed ()
 
virtual string GetMessageIncomplete ()
 
virtual string GetNotes ()
 
virtual string GetTitle ()
 
virtual void OnLoad (ConfigNode node)
 
virtual void OnParameterStateChange (ContractParameter p)
 
virtual void OnRegister ()
 
virtual void OnReset ()
 
virtual void OnSave (ConfigNode node)
 
virtual void OnUnregister ()
 
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 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]
 

Detailed Description

A simple abstract class that abstracts parameters with waypoints to set up, clean up, and update via WaypointManager.

Member Function Documentation

virtual void FinePrint.Utilities.WaypointParameter.CleanupWaypoints ( )
inlinevirtual
virtual void FinePrint.Utilities.WaypointParameter.SetupWaypoints ( )
inlinevirtual
virtual void FinePrint.Utilities.WaypointParameter.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.

Reimplemented in FinePrint.Contracts.Parameters.RoverWayPointParameter, and FinePrint.Contracts.Parameters.SpecificVesselParameter.

Member Data Documentation

CelestialBody FinePrint.Utilities.WaypointParameter.TargetBody

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