Difference between revisions of "API:CelestialBody"
From Kerbal Space Program Wiki
| Line 46: | Line 46: | ||
|name=referenceBody | |name=referenceBody | ||
|hasget=1 | |hasget=1 | ||
| − | |desc= | + | |desc=The celestial body that this one orbits. |
}} | }} | ||
| Line 65: | Line 65: | ||
|name=theName | |name=theName | ||
|hasget=1 | |hasget=1 | ||
| − | |desc=( | + | |desc=Body's name preceded by appropriate article ("the" or nothing) |
}} | }} | ||
| Line 83: | Line 83: | ||
}} | }} | ||
| − | {{Field|type=Vector3d|name=angularVelocity}} | + | {{Field |
| + | |type=Vector3d | ||
| + | |name=angularVelocity | ||
| + | |desc=Similar to <code>zUpAngularVelocity</code>: [[w:Rotation_formalisms_in_three_dimensions#Euler_axis_and_angle_.28rotation_vector.29|Rotation vector]], with y and z axes swapped | ||
| + | }} | ||
| + | |||
{{Field|type=float|name=atmosphereTemperatureMultiplier}} | {{Field|type=float|name=atmosphereTemperatureMultiplier}} | ||
| Line 114: | Line 119: | ||
{{Field|type=CBAttributeMap|name=BiomeMap}} | {{Field|type=CBAttributeMap|name=BiomeMap}} | ||
| − | {{Field|type=string|name=bodyName|desc=Same as the <code>name</code> property}} | + | {{Field |
| + | |type=string | ||
| + | |name=bodyName | ||
| + | |desc=Same as the <code>name</code> property | ||
| + | }} | ||
{{Field|type=Transform|name=bodyTransition}} | {{Field|type=Transform|name=bodyTransition}} | ||
| Line 131: | Line 140: | ||
|type=double | |type=double | ||
|name=gMagnitudeAtCenter | |name=gMagnitudeAtCenter | ||
| − | |desc=Same as gravParameter (below) | + | |desc=Same as <code>gravParameter</code> (below) |
}} | }} | ||
| Line 155: | Line 164: | ||
|type=double | |type=double | ||
|name=Mass | |name=Mass | ||
| − | |desc=body's mass (kg), computed as M = µ/G where µ is the body's gravitational parameter and G=6.674e-11 N⋅m²⋅kg⁻² (instead of G=6.67384e-11 N⋅m²⋅kg⁻²) | + | |desc=body's mass (kg), computed as M = µ/G where µ is the body's gravitational parameter (<code>gravParameter</code>) and G=6.674e-11 N⋅m²⋅kg⁻² (instead of G=6.67384e-11 N⋅m²⋅kg⁻²) |
}} | }} | ||
| Line 178: | Line 187: | ||
|type=PQS | |type=PQS | ||
|name=pqsController | |name=pqsController | ||
| − | |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 <code>PQS</code> class to see how to use it. |
}} | }} | ||
| Line 184: | Line 193: | ||
|type=AnimationCurve | |type=AnimationCurve | ||
|name=pressureCurve | |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 | + | |desc=Used when <code>useLegacyAtmosphere</code> is False; <code>AnimationCurve</code> mapping some altitudes (m) to pressure ratios (atm); actual pressure is obtained by multiplying by pressureMultiplier |
}} | }} | ||
| Line 190: | Line 199: | ||
|type=float | |type=float | ||
|name=pressureMultiplier | |name=pressureMultiplier | ||
| − | |desc=Used when useLegacyAtmosphere is False; linear factor in pressure (non-zero only on Kerbol, where it is set to 1000000) | + | |desc=Used when <code>useLegacyAtmosphere</code> is False; linear factor in pressure (non-zero only on Kerbol, where it is set to 1000000) |
}} | }} | ||
| Line 250: | Line 259: | ||
|type=bool | |type=bool | ||
|name=use_The_InName | |name=use_The_InName | ||
| − | |desc= | + | |desc=Whether the body's name should be preceded by "the" in a sentence (e.g. "The Sun is pretty hot") |
}} | }} | ||
| Line 273: | Line 282: | ||
|returndesc= | |returndesc= | ||
|name=getBounds | |name=getBounds | ||
| − | |desc= | + | |desc=Collision sphere; larger than body, presumably to account for terrain height, atmospheric height and safety margin. |
}} | }} | ||
| Line 289: | Line 298: | ||
|name=GetLongitude | |name=GetLongitude | ||
|args={{arg|Vector3d|worldPos}} | |args={{arg|Vector3d|worldPos}} | ||
| − | |desc=The longitude of a given world position, in degrees | + | |desc=The longitude of a given world position, in degrees; value may be > 360 or < 0, you should modulo-reduce to an appropriate range (e.g. -180:180 or 0:360). |
}} | }} | ||
| Line 363: | Line 372: | ||
}} | }} | ||
| − | {{Method|returntype=bool|name=HasChild|args={{arg|CelestialBody|body}}|desc=True if the given body orbits this one. Doesn't seem to need to be a <i>direct</i> orbit—can be something that orbits something that orbits this. Inverse of <code>HasParent</code>.}} | + | {{Method |
| − | {{Method|returntype=bool|name=HasParent|args={{arg|CelestialBody|body}}|desc=True if the given body orbits is orbited by this one. Doesn't seem to need to be a <i>direct</i> orbit—can be something that's orbited by something that's orbited by this. Inverse of <code>HasChild</code>.}} | + | |returntype=bool |
| + | |name=HasChild | ||
| + | |args={{arg|CelestialBody|body}} | ||
| + | |desc=True if the given body orbits this one. Doesn't seem to need to be a <i>direct</i> orbit—can be something that orbits something that orbits this. Inverse of <code>HasParent</code>. | ||
| + | }} | ||
| + | |||
| + | {{Method | ||
| + | |returntype=bool | ||
| + | |name=HasParent | ||
| + | |args={{arg|CelestialBody|body}} | ||
| + | |desc=True if the given body orbits is orbited by this one. Doesn't seem to need to be a <i>direct</i> orbit—can be something that's orbited by something that's orbited by this. Inverse of <code>HasChild</code>. | ||
| + | }} | ||
| + | |||
{{MethodsEnd}} | {{MethodsEnd}} | ||
[[Category:Community API Documentation]] | [[Category:Community API Documentation]] | ||
Revision as of 07:54, 26 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; } | The celestial body that this one orbits. |
| Texture2D ResourceMap { get; } | ? |
| PResource Resources { get; } | ? |
| string theName { get; } | Body's name preceded by appropriate article ("the" or nothing) |
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 | Similar to zUpAngularVelocity: Rotation vector, with y and z axes swapped
|
| float atmosphereTemperatureMultiplier | ? |
| bool atmosphere | Whether the body has an atmosphere |
| bool atmosphereContainsOxygen | Whether oxygen is available (for jet engines) |
| float atmosphereMultiplier | Pressure at sea level (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 | Gravity At Sea Level (in multiple of g, aka “gees”, the gravity at sea level on Kerbin) |
| double gMagnitudeAtCenter | Same as gravParameter (below)
|
| double gravParameter | Gravitational parameter (G × Mass), computed as where m³/s² |
| double hillSphere | Radius of body's Hill sphere computed as . |
| double initialRotation | ? |
| bool inverseRotation | ? |
| float inverseRotThresholdAltitude | ? |
| double Mass | body's mass (kg), computed as M = µ/G where µ is the body's gravitational parameter (gravParameter) and G=6.674e-11 N⋅m²⋅kg⁻² (instead of G=6.67384e-11 N⋅m²⋅kg⁻²)
|
| 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 sea level pressure. Currently set to True for all bodies with an atmosphere. |
| bool use_The_InName | Whether the body's name should be preceded by "the" in a sentence (e.g. "The Sun is pretty hot") |
| Vector3d zUpAngularVelocity | Rotation vector |
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() | Collision sphere; larger than body, presumably to account for terrain height, atmospheric height and 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; value may be > 360 or < 0, you should modulo-reduce to an appropriate range (e.g. -180:180 or 0: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.
|
