API:CelestialBody

CelestialBody Class

Inherits	Implements
UnityEngine.MonoBehaviour	ITargetable, IDiscoverable

A CelestialBody represents a planet, moon, or star that acts as a source of gravity and has some sphere of influence. You can find the CelestialBody whose sphere of influence you are currently in with the vessel.mainBody field.

Properties

The following are public properties available in CelestialBody.

Signature	Description
DiscoveryInfo DiscoveryInfo { get; }	?
int flightsGlobalIndex { get; set; }	?
string name { get; }	The name of the body, as it appears in e.g. the map view.
Orbit orbit { get; }	(not confirmed) The orbit of the celestial body around its reference body
Vector3d position { get; set; }	The position of the center of the body in world space.
CelestialBody referenceBody { get; }	(not confirmed) The celestial body that this one orbits.
Texture2D ResourceMap { get; }	?
PResource Resources { get; }	?
string theName { get; }	(not confirmed) Same as this.bodyName except prefixed with "the " (if appropriate)

Fields

The following is a list of publically-accessible fields in CelestialBody. This includes protected items, which can be accessed by subclasses.

Signature	Description
double Mass	the mass of the body, in KSP's arbitrary mass units. For calculating gravity, KSP seems to use a gravitational constant of G = 6.674E-11 (SI units), which is the same as the real one rounded to 3 decimal places.
double gravParamter	This is probably equal to G * Mass?
double maxAtmosphereAltitude	The height above sea level at which the atmosphere ends, in meters.
Orbit orbit	Contains all information about the body's orbit around whatever other body it is orbiting.
List<CelestialBody> orbitingBodies	A list of all the bodies that orbit this one (e.g., the moons of a planet)
PQS pqsController	An object that can give you information about the planet's terrain height as a function of position. See the documentation on the PQS class to see how to use it.
double Radius	The radius of the planet in meters. This defines sea level.
double rotationPeriod	How long it takes the planet to revolve once about its axis, in seconds.
double sphereOfInfluence	The radius of the body's sphere of influence, in meters, measured from the center of the planet (not sea level).

Methods

The following are methods included in CelestialBody.

Signature	Description
double GetAltitude(Vector3d worldPos)	The altitude above sea level of a given world position, in meters.
double GetLatitude(Vector3d worldPos)	The latitude of a given world position, in degrees.
double GetLongitude(Vector3d worldPos)	The longitude of a given world position, in degrees. The returned value doesn't seem to stay in any particular range. It may be > 360 or < 0. You'll probably want to do some modulo arithmetic to force this into a certain range like -180 to 180 or 0 to 360.
Vector3d GetRFrmVel(Vector3d worldPos)	The reference frame of the planet's surface rotates with respect to an inertial reference frame. For example, a ship landed on the planet's surface is actually moving with respect to an inertial frame, because the planet is rotating. This function gives the difference between a velocity in the rotating frame and the same velocity in the inertial frame. You can use it to convert an inertial frame velocity (like the one returned by Orbit.GetVel()) to a rotating frame velocity by (rotating frame velocity) = (inertial frame velocity) - body.GetRFrmVel(position).
Vector3d GetSurfaceNVector(double lat, double lon)	Returns a unit vector that is normal to the sphere of the planet at the given latitude and longitude.
Vector3d GetWorldSurfacePosition(double lat, double lon, double alt)	Probably this returns the world position corresponding to a given latitude, longitude, and altitude above sea level?