C# Class kOS.Suffixed.WaypointValue

Inheritance: Structure

Mostra file Open project: KSP-KOS/KOS Class Usage Examples

Public Methods

Method	Description
BuildGeoCoordinates ( ) : GeoCoordinates
BuildSeaLevelAltitude ( ) : ScalarValue
CookedName ( ) : kOS.Safe.Encapsulation.StringValue
GetBody ( ) : CelestialBody
GetPosition ( ) : kOS.Suffixed.Vector
GreekToInteger ( string greekLetterName, int &index, string &baseName ) : bool	Return an integer to go with the alphabet position of the string given in greek lettering. For example, input "alpha" and get out 0. input "beta" and get out 1. If no match is found, -1 is returned. This is used by waypoints so that you can figure out that a waypoint named like "Jebadiah's lament Gamma" is really the 3rd (index 2) member of the "Jebadiah's lament" cluster of waypoints. Because that is its purpose, it actually operates on the LASTMOST word in the string it is given. given a string like "foo bar baz", it will check if "baz" is a greek letter, not "foo". Thus you can pass in exactly the name as it appears onscreen.
ToString ( ) : string
ToVerboseString ( ) : kOS.Safe.Encapsulation.StringValue
WaypointValue ( FinePrint.Waypoint wayPoint, SharedObjects shared ) : System

Private Methods

Method	Description
InitializeGreekMap ( ) : void
InitializeSuffixes ( ) : void

Method Details

BuildGeoCoordinates() public method

public BuildGeoCoordinates ( ) : GeoCoordinates
return	GeoCoordinates

BuildSeaLevelAltitude() public method

public BuildSeaLevelAltitude ( ) : ScalarValue
return	kOS.Safe.Encapsulation.ScalarValue

CookedName() public method

public CookedName ( ) : kOS.Safe.Encapsulation.StringValue
return	kOS.Safe.Encapsulation.StringValue

GetBody() public method

public GetBody ( ) : CelestialBody
return	CelestialBody

GetPosition() public method

public GetPosition ( ) : kOS.Suffixed.Vector
return	kOS.Suffixed.Vector

GreekToInteger() public static method

Return an integer to go with the alphabet position of the string given in greek lettering. For example, input "alpha" and get out 0. input "beta" and get out 1. If no match is found, -1 is returned.
This is used by waypoints so that you can figure out that a waypoint named like "Jebadiah's lament Gamma" is really the 3rd (index 2) member of the "Jebadiah's lament" cluster of waypoints.
Because that is its purpose, it actually operates on the LASTMOST word in the string it is given. given a string like "foo bar baz", it will check if "baz" is a greek letter, not "foo". Thus you can pass in exactly the name as it appears onscreen.

public static GreekToInteger ( string greekLetterName, int &index, string &baseName ) : bool
greekLetterName	string	string name to check. Case insensitively.
index	int	integer position in alphabet. -1 if no match.
baseName	string	the name after the last term has been stripped off, if there are /// space separated terms. Note that if the return value of this method is false, this /// shouldn't be used and you should stick with the original full name.
return	bool

ToString() public method

public ToString ( ) : string
return	string

ToVerboseString() public method

public ToVerboseString ( ) : kOS.Safe.Encapsulation.StringValue
return	kOS.Safe.Encapsulation.StringValue

WaypointValue() public method

public WaypointValue ( FinePrint.Waypoint wayPoint, SharedObjects shared ) : System
wayPoint	FinePrint.Waypoint
shared	SharedObjects
return	System