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

Public Member Functions

override void CleanupWaypoints ()
 
 RoverWayPointParameter ()
 
 RoverWayPointParameter (double CraftStartLatitude, double CraftStartLongitude, double CraftEndLatitude, double CraftEndLongitude, CelestialBody targetBody)
 Construction More...
 
void UpdateRoverInfo (Vessel vsl)
 
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 ()
 

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

Protected Attributes

double craftEndLatitude
 
double craftEndLongitude
 
double craftStartLatitude
 
double craftStartLongitude
 
Waypoint endwp
 
bool outerWarning
 
Vessel roverVessel
 
uint roverVslId
 
Waypoint startwp
 
bool submittedWaypoint
 
int successCounter
 
- 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

double CraftEndLatitude [get]
 The rover ending latitude More...
 
double CraftEndLongitude [get]
 The rover ending longitude More...
 
double CraftStartLatitude [get]
 The rover starting latitude More...
 
double CraftStartLongitude [get]
 The rover starting longitude More...
 
Waypoint Endwp [get]
 The ending waypoint for the rover More...
 
Vessel RoverVessel [get]
 The rover vessel More...
 
uint RoverVslId [get]
 The rover More...
 
Waypoint Startwp [get]
 The starting waypoint for the rover 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]
 

Additional Inherited Members

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

Constructor & Destructor Documentation

FinePrint.Contracts.Parameters.RoverWayPointParameter.RoverWayPointParameter ( )
inline
FinePrint.Contracts.Parameters.RoverWayPointParameter.RoverWayPointParameter ( double  CraftStartLatitude,
double  CraftStartLongitude,
double  CraftEndLatitude,
double  CraftEndLongitude,
CelestialBody  targetBody 
)
inline

Construction

Parameters
CraftStartLatitudeThe starting latitude
CraftStartLongitudeThe starting longitude
CraftEndLatitudeThe ending latitude
CraftEndLongitudeThe ending longitude
targetBodyThe target CB

Member Function Documentation

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

Reimplemented from Contracts.ContractParameter.

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

Reimplemented from Contracts.ContractParameter.

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

Reimplemented from Contracts.ContractParameter.

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

Reimplemented from Contracts.ContractParameter.

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

Reimplemented from Contracts.ContractParameter.

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

Reimplemented from Contracts.ContractParameter.

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

Reimplemented from Contracts.ContractParameter.

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

Reimplemented from Contracts.ContractParameter.

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

Reimplemented from Contracts.ContractParameter.

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

Reimplemented from Contracts.ContractParameter.

void FinePrint.Contracts.Parameters.RoverWayPointParameter.UpdateRoverInfo ( Vessel  vsl)
inline
override void FinePrint.Contracts.Parameters.RoverWayPointParameter.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 from FinePrint.Utilities.WaypointParameter.

Member Data Documentation

double FinePrint.Contracts.Parameters.RoverWayPointParameter.craftEndLatitude
protected
double FinePrint.Contracts.Parameters.RoverWayPointParameter.craftEndLongitude
protected
double FinePrint.Contracts.Parameters.RoverWayPointParameter.craftStartLatitude
protected
double FinePrint.Contracts.Parameters.RoverWayPointParameter.craftStartLongitude
protected
Waypoint FinePrint.Contracts.Parameters.RoverWayPointParameter.endwp
protected
bool FinePrint.Contracts.Parameters.RoverWayPointParameter.outerWarning
protected
Vessel FinePrint.Contracts.Parameters.RoverWayPointParameter.roverVessel
protected
uint FinePrint.Contracts.Parameters.RoverWayPointParameter.roverVslId
protected
Waypoint FinePrint.Contracts.Parameters.RoverWayPointParameter.startwp
protected
bool FinePrint.Contracts.Parameters.RoverWayPointParameter.submittedWaypoint
protected
int FinePrint.Contracts.Parameters.RoverWayPointParameter.successCounter
protected

Property Documentation

double FinePrint.Contracts.Parameters.RoverWayPointParameter.CraftEndLatitude
get

The rover ending latitude

double FinePrint.Contracts.Parameters.RoverWayPointParameter.CraftEndLongitude
get

The rover ending longitude

double FinePrint.Contracts.Parameters.RoverWayPointParameter.CraftStartLatitude
get

The rover starting latitude

double FinePrint.Contracts.Parameters.RoverWayPointParameter.CraftStartLongitude
get

The rover starting longitude

Waypoint FinePrint.Contracts.Parameters.RoverWayPointParameter.Endwp
get

The ending waypoint for the rover

Vessel FinePrint.Contracts.Parameters.RoverWayPointParameter.RoverVessel
get

The rover vessel

uint FinePrint.Contracts.Parameters.RoverWayPointParameter.RoverVslId
get

The rover

Waypoint FinePrint.Contracts.Parameters.RoverWayPointParameter.Startwp
get

The starting waypoint for the rover


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