Expansions.Missions.SurfaceArea Class Reference

Contains the Ground Location Parameters for a vessel in a mission More...

Inheritance diagram for Expansions.Missions.SurfaceArea:

Public Member Functions
override bool	Equals (object obj)
string	GetExtraText ()
	Get extra text to be appended at the end of the node label caption. More...
override int	GetHashCode ()
string	GetNodeBodyParameterString ()
	Returns the string to be displayed when the parameter is displayed in the node body More...
Waypoint	GetWaypoint ()
	Get the waypoint marker to show the location of the surface area. More...
Vector3	GetWorldPosition ()
	Get location where the marker for the node should be displayed in world. More...
bool	HasNodeLabel ()
	Should we create a node label for this object or not? More...
bool	HasWaypoint ()
	Should we create a waypoint for this object or not? More...
bool	HasWorldPosition ()
	Does the label represent an actual world position? For example, biomes won't have a world position, but a point in space will. More...
bool	IsPointInCircle (double lat, double lon)
	Returns true if the point passed in is located inside the OuterCircle of the ground area. More...
void	Load (ConfigNode node)
double	PointInCircleAccuracy (double lat, double lon)
	Returns the accuracy of the point passed inside the ground area. More...
void	Save (ConfigNode node)
List< MEGUIDropDownItem >	SetCelestialBodies ()
	SurfaceArea ()
	SurfaceArea (CelestialBody targetBody, double longitude, double latitude, float radius)

Public Attributes
double	altitude
	altitude of the area center point More...
CelestialBody	body
	The Target CelestialBody for the vessel. Would be the one it is landed on, or in Orbit of. More...
double	latitude
	latitude of the area center point More...
double	longitude
	longitude of the area center point More...
float	radius
	The radius of the outer cicle of the surface area More...

Detailed Description

Contains the Ground Location Parameters for a vessel in a mission

Constructor & Destructor Documentation

Expansions.Missions.SurfaceArea.SurfaceArea ( )

inline

Expansions.Missions.SurfaceArea.SurfaceArea ( CelestialBody  targetBody, double  longitude, double  latitude, float  radius  )

inline

Member Function Documentation

override bool Expansions.Missions.SurfaceArea.Equals ( object  obj )

inline

string Expansions.Missions.SurfaceArea.GetExtraText ( )

inline

Get extra text to be appended at the end of the node label caption.

Returns

Text to be appended at the end of the node label caption.

override int Expansions.Missions.SurfaceArea.GetHashCode ( )

inline

string Expansions.Missions.SurfaceArea.GetNodeBodyParameterString ( )

inline

Returns the string to be displayed when the parameter is displayed in the node body

Returns

String to be displayed when the parameter is displayed in the node body,

Waypoint Expansions.Missions.SurfaceArea.GetWaypoint ( )

inline

Get the waypoint marker to show the location of the surface area.

Returns

Waypoint marker representing the current location.

Vector3 Expansions.Missions.SurfaceArea.GetWorldPosition ( )

inline

Get location where the marker for the node should be displayed in world.

Returns

Location of the node.

bool Expansions.Missions.SurfaceArea.HasNodeLabel ( )

inline

Should we create a node label for this object or not?

Returns

True if we should create a node label, false otherwise.

bool Expansions.Missions.SurfaceArea.HasWaypoint ( )

inline

Should we create a waypoint for this object or not?

Returns

True if we should create a waypoint, false otherwise.

bool Expansions.Missions.SurfaceArea.HasWorldPosition ( )

inline

Does the label represent an actual world position? For example, biomes won't have a world position, but a point in space will.

Returns

True if the node has a world position, false otherwise.

bool Expansions.Missions.SurfaceArea.IsPointInCircle ( double  lat, double  lon  )

inline

Returns true if the point passed in is located inside the OuterCircle of the ground area.

Parameters

point

Returns

true or false

void Expansions.Missions.SurfaceArea.Load ( ConfigNode  node )

inline

Implements IConfigNode.

double Expansions.Missions.SurfaceArea.PointInCircleAccuracy ( double  lat, double  lon  )

inline

Returns the accuracy of the point passed inside the ground area.

Parameters

lat	Latitude of the point
lon	Longitude of the point

Returns

void Expansions.Missions.SurfaceArea.Save ( ConfigNode  node )

inline

Implements IConfigNode.

List<MEGUIDropDownItem> Expansions.Missions.SurfaceArea.SetCelestialBodies ( )

inline

Member Data Documentation

double Expansions.Missions.SurfaceArea.altitude

altitude of the area center point

CelestialBody Expansions.Missions.SurfaceArea.body

The Target CelestialBody for the vessel. Would be the one it is landed on, or in Orbit of.

double Expansions.Missions.SurfaceArea.latitude

latitude of the area center point

double Expansions.Missions.SurfaceArea.longitude

longitude of the area center point

float Expansions.Missions.SurfaceArea.radius

The radius of the outer cicle of the surface area

---

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

• KSP/Assets/Expansions/Missions/Scripts/SurfaceArea.cs