Difference between revisions of "API:CelestialBody"

From Kerbal Space Program Wiki
Jump to: navigation, search
Line 66: Line 66:
 
{{Field|type=Vector3d|name=angularVelocity}}
 
{{Field|type=Vector3d|name=angularVelocity}}
 
{{Field|type=float|name=atmosphereTemperatureMultiplier}}
 
{{Field|type=float|name=atmosphereTemperatureMultiplier}}
−
{{Field|type=bool|name=atmosphere}}
 
  
−
{{Field|type=bool|name=atmosphereContainsOxygen}}
+
{{Field
 +
|type=bool
 +
|name=atmosphere
 +
|desc=Whether the body has an atmosphere
 +
}}
  
−
{{Field|type=float|name=atmosphereMultiplier}}
+
{{Field
 +
|type=bool
 +
|name=atmosphereContainsOxygen
 +
|desc=Whether oxygen is available (for jet engines)
 +
}}
  
−
{{Field|type=double|name=atmosphereScaleHeight}}
+
{{Field
 +
|type=float
 +
|name=atmosphereMultiplier
 +
|desc=Temperature at surface (atm)
 +
}}
 +
 
 +
{{Field
 +
|type=double
 +
|name=atmosphereScaleHeight
 +
|desc=Atmospheric [[w:Scale height|scale height]] (km)
 +
}}
  
 
{{Field|type=Color|name=atmosphericAmbientColor}}
 
{{Field|type=Color|name=atmosphericAmbientColor}}
Line 86: Line 103:
 
{{Field|type=double|name=directRotAngle}}
 
{{Field|type=double|name=directRotAngle}}
  
−
{{Field|type=double|name=GeeASL|desc=Force of gravity at sea level?}}
+
{{Field
 +
|type=double
 +
|name=GeeASL
 +
|desc=Acceleration due to gravity in multiple of g (“gees”) experienced At Sea Level
 +
}}
  
−
{{Field|type=double|name=gMagnitudeAtCenter|desc=Equal to <code>GeeASL</code> * 9.81 * <code>Radius</code>^2}}
+
{{Field
 +
|type=double
 +
|name=gMagnitudeAtCenter
 +
|desc=Same as gravParameter (below)
 +
}}
  
 
{{Field
 
{{Field
Line 94: Line 119:
 
|name=gravParameter
 
|name=gravParameter
 
|desc=Gravitational parameter (G × Mass)
 
|desc=Gravitational parameter (G × Mass)
 +
}}
  
 +
{{Field
 +
|type=double
 +
|name=hillSphere
 +
|desc=Radius of body's [[w:Hill sphere|Hill sphere]] computed as <math>R_H = a (1-e) \left(\frac{M_{\mathrm{planet}}}{M_\star}\right)^{1/3}</math>.
 
}}
 
}}
−
{{Field|type=double|name=hillSphere}}
 
  
 
{{Field|type=double|name=initialRotation}}
 
{{Field|type=double|name=initialRotation}}
Line 109: Line 138:
 
|desc=the mass of the body (kg). Computed as M = µ/G where µ is the gravitational parameter (exactly 6.674e-11 N⋅m²⋅kg⁻² in KSP)
 
|desc=the mass of the body (kg). Computed as M = µ/G where µ is the gravitational parameter (exactly 6.674e-11 N⋅m²⋅kg⁻² in KSP)
 
}}
 
}}
 +
 
{{Field
 
{{Field
 
|type=double
 
|type=double
 
|name=maxAtmosphereAltitude
 
|name=maxAtmosphereAltitude
−
|desc=The height above sea level at which the atmosphere ends, in meters.
+
|desc=Used when useLegacyAtmosphere is False; atmosphere top altitude (m)
 
}}
 
}}
 +
 
{{Field|type=bool|name=ocean}}
 
{{Field|type=bool|name=ocean}}
  
Line 123: Line 154:
 
|name=orbitingBodies
 
|name=orbitingBodies
 
|desc=A list of all the bodies that orbit this one (e.g., the moons of a planet)
 
|desc=A list of all the bodies that orbit this one (e.g., the moons of a planet)
 +
}}
  
−
}}
 
 
{{Field
 
{{Field
 
|type=PQS
 
|type=PQS
Line 130: Line 161:
 
|desc=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.
 
|desc=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.
 
}}
 
}}
−
{{Field|type=AnimationCurve|name=pressureCurve|desc = Atmospheric pressure by altitude stored as an AnimationCurve. Altitude is in meters stored as Keys. Pressure is in atmospheres stored as Values. Multiplied by pressureMultiplier to determine final pressure for a given altitude. useLegacyAtmosphere must be set to False!}}
 
  
−
{{Field|type=float|name=pressureMultiplier|desc = Multiplies atmospheric pressure as determined by pressureCurve when useLegacyAtmosphere is False.}}
+
{{Field
 +
|type=AnimationCurve
 +
|name=pressureCurve
 +
|desc=Used when useLegacyAtmosphere is False; AnimationCurve mapping some altitudes (m) to pressure ratios (atm); actual pressure is obtained by multiplying by pressureMultiplier
 +
}}
 +
 
 +
{{Field
 +
|type=float
 +
|name=pressureMultiplier
 +
|desc=Used when useLegacyAtmosphere is False; linear factor in pressure (non-zero only on Kerbol, where it is set to 1000000)
 +
}}
  
 
{{Field
 
{{Field
Line 157: Line 197:
 
|type=double
 
|type=double
 
|name=sphereOfInfluence
 
|name=sphereOfInfluence
−
|desc=The radius of the body's sphere of influence, in meters, measured from the center of the planet (not sea level).
+
|desc=Radius of the body's [[w:Sphere of influence (astrodynamics)|sphere of influence]] (m); measured from the center of the planet, not from sea level.
  
 
}}
 
}}
−
{{Field|type=double|name=staticPressureASL}}
+
{{Field
 +
|type=double
 +
|name=staticPressureASL
 +
|desc=?; 21.46 on Kerbol, 1 everywhere else
 +
}}
  
 
{{Field|type=AnimationCurve|name=temperatureCurve}}
 
{{Field|type=AnimationCurve|name=temperatureCurve}}
Line 166: Line 210:
 
{{Field|type=PlanetQuadTreeController|name=terrainController}}
 
{{Field|type=PlanetQuadTreeController|name=terrainController}}
  
−
{{Field|type=bool|name=tidallyLocked}}
+
{{Field
 +
|type=bool
 +
|name=tidallyLocked
 +
|desc=Whether the body is tidally locked to its primary (its rotational period is its orbital period)
 +
}}
  
 
{{Field|type=array of float|name=timeWarpAltitudeLimits}}
 
{{Field|type=array of float|name=timeWarpAltitudeLimits}}
  
−
{{Field|type=bool|name=useLegacyAtmosphere|desc = If True then atmospheric pressure is determined by atmosphere at sea level decreasing 1/2.718 every scaleHeight kilometers. Lowest possible pressure value is 1e-6 when useLegacyAtmosphere = True.}}
+
{{Field
 +
|type=bool
 +
|name=useLegacyAtmosphere
 +
|desc=If True, then atmospheric pressure is based on [[w:Scale height|scale height]] and atmosphere height threshold is a millionth of surface pressure. Currently set to True for all bodies with an atmosphere.
 +
}}
  
 
{{Field|type=bool|name=use_The_InName|When true, the <code>theName</code> property will include "the " in the body's name}}
 
{{Field|type=bool|name=use_The_InName|When true, the <code>theName</code> property will include "the " in the body's name}}

Revision as of 20:30, 25 December 2014

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. Same as bodyName field.
Orbit orbit { get; } Contains all information about the body's orbit around whatever other body it is orbiting.
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 name 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
float altitudeMultiplier ?
float altitudeOffset ?
double angularV The magnitude of angularVelocity
Vector3d angularVelocity ?
float atmosphereTemperatureMultiplier ?
bool atmosphere Whether the body has an atmosphere
bool atmosphereContainsOxygen Whether oxygen is available (for jet engines)
float atmosphereMultiplier Temperature at surface (atm)
double atmosphereScaleHeight Atmospheric scale height (km)
Color atmosphericAmbientColor ?
CBAttributeMap BiomeMap ?
string bodyName Same as the name property
Transform bodyTransition ?
CelestialBodyType bodyType ?
double directRotAngle ?
double GeeASL Acceleration due to gravity in multiple of g (“gees”) experienced At Sea Level
double gMagnitudeAtCenter Same as gravParameter (below)
double gravParameter Gravitational parameter (G × Mass)
double hillSphere Radius of body's Hill sphere computed as .
double initialRotation ?
bool inverseRotation ?
float inverseRotThresholdAltitude ?
double Mass the mass of the body (kg). Computed as M = µ/G where µ is the gravitational parameter (exactly 6.674e-11 N⋅m²⋅kg⁻² in KSP)
double maxAtmosphereAltitude Used when useLegacyAtmosphere is False; atmosphere top altitude (m)
bool ocean ?
OrbitDriver orbitDriver ?
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.
AnimationCurve pressureCurve Used when useLegacyAtmosphere is False; AnimationCurve mapping some altitudes (m) to pressure ratios (atm); actual pressure is obtained by multiplying by pressureMultiplier
float pressureMultiplier Used when useLegacyAtmosphere is False; linear factor in pressure (non-zero only on Kerbol, where it is set to 1000000)
double Radius The radius of the planet in meters. This defines sea level.
bool rotates ?
QuaternionD rotation ?
double rotationAngle The current angle of the body's rotation
double rotationPeriod How long it takes the planet to revolve once about its axis, in seconds.
CelestialBodyScienceParams scienceValues ?
double sphereOfInfluence Radius of the body's sphere of influence (m); measured from the center of the planet, not from sea level.
double staticPressureASL  ?; 21.46 on Kerbol, 1 everywhere else
AnimationCurve temperatureCurve ?
PlanetQuadTreeController terrainController ?
bool tidallyLocked Whether the body is tidally locked to its primary (its rotational period is its orbital period)
array of float timeWarpAltitudeLimits ?
bool useLegacyAtmosphere If True, then atmospheric pressure is based on scale height and atmosphere height threshold is a millionth of surface pressure. Currently set to True for all bodies with an atmosphere.
bool use_The_InName ?
Vector3d zUpAngularVelocity ?

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.
Bounds getBounds() Looks like a sphere for detecting potential collisions. Has a radius substantially larger than the body's radius—presumably to account for terrain and atmospheric height plus a safety margin.
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.
string GetName() Same as name property.
Vector3 GetObtVelocity() Infinite loop? (version 0.23.5)
Orbit GetOrbit() Same as orbit.
OrbitDriver GetOrbitDriver() Same as orbitDriver.
Vector3d GetRelSurfacePosition(Vector3d worldPosition) Converts a world position into a body-relative position?
Vector3d GetRelSurfacePosition(double lat, double lon, double alt) Returns position in body-relative coordinates for a given longitude/latitude/altitude. Same as GetSurfaceNVector * (body radius + alt).
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 GetSrfVelocity() Always returns a zero vector. (as of version 0.23.5)
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. (Tells you which way is "up" at a given point on the planet.)
Transform GetTransform() Same as bodyTransform field
Vector3d GetWorldSurfacePosition(double lat, double lon, double alt) Returns the world position corresponding to a given latitude, longitude, and altitude above sea level.
bool HasChild(CelestialBody body) True if the given body orbits this one. Doesn't seem to need to be a direct orbit—can be something that orbits something that orbits this. Inverse of HasParent.
bool HasParent(CelestialBody body) True if the given body orbits is orbited by this one. Doesn't seem to need to be a direct orbit—can be something that's orbited by something that's orbited by this. Inverse of HasChild.
Retrieved from "https://wiki.kerbalspaceprogram.com/index.php?title=API:CelestialBody&oldid=56084"