OrbitModule

Celestial Body Schema / Definitions / OrbitModule

Schema Type: JSON Type: object

No Description Found

# staticPosition

Type: MVector3

Specify this if you want the body to remain stationary at a given location (ie not orbit its parent). Required for Bramble dimensions

See Definitions/MVector3

---

# primaryBody

Type: string

The name of the body this one will orbit around

---

# isMoon

Type: boolean

Is this the moon of a planet? Used for determining when its name is shown on the map.

---

# axialTilt

Type: number

The angle between the normal to the orbital plane and its axis of rotation.

---

# siderealPeriod

Type: number

Rotation period in minutes.

---

# initialRotation

Type: number Minimum: 0Maximum: 360

Offsets the planet's starting sidereal rotation. In degrees.

---

# isTidallyLocked

Type: boolean

Should the body always have one side facing its primary?

---

# isStatic

Type: boolean

Is the body meant to stay in one place without moving? If staticPosition is not set, the initial position
will be determined using its orbital parameters.

---

# alignmentAxis

Type: MVector3

If it is tidally locked, this direction will face towards the primary. Ex: Interloper uses `0, -1, 0`. Most planets
will want something like `-1, 0, 0`.

See Definitions/MVector3

---

# showOrbitLine

Type: boolean Default: true

Referring to the orbit line in the map screen.

---

# dottedOrbitLine

Type: boolean

Should the orbit line be dotted?

---

# tint

Type: MColor

Colour of the orbit-line in the map view.

See Definitions/MColor

---

# trackingOrbitLine

Type: boolean

Should we just draw a line behind its orbit instead of the entire circle/ellipse?

---

# orbitLineFadeEndDistance

Type: number

If the camera is farther than this distance the orbit line will fade out. Leave empty to not have it fade out.

---

# orbitLineFadeStartDistance

Type: number

If the camera is closer than this distance the orbit line will fade out. Leave empty to not have it fade out.

---

# semiMajorAxis

Type: number Minimum: 0

The semi-major axis of the ellipse that is the body's orbit. For a circular orbit this is the radius.

---

# inclination

Type: number

The angle (in degrees) between the body's orbit and the plane of the star system

---

# longitudeOfAscendingNode

Type: number

An angle (in degrees) defining the point where the orbit of the body rises above the orbital plane if it has
nonzero inclination.

---

# eccentricity

Type: number Minimum: 0Maximum: 1

At 0 the orbit is a circle. The closer to 1 it is, the more oval-shaped the orbit is.

---

# argumentOfPeriapsis

Type: number

An angle (in degrees) defining the location of the periapsis (the closest distance to it's primary body) if it has
nonzero eccentricity.

---

# trueAnomaly

Type: number

Where the planet should start off in its orbit in terms of the central angle.