Skip to content

BaseModule

Schema Type: JSON Type: object

No Description Found

centerOfSolarSystem

Type: boolean

Set this to true if you are replacing the sun with a different body. Only one object in a star system should ever
have this set to true.


gravityFallOff

Type: GravityFallOff Default: linear

How gravity falls off with distance. Most planets use linear but the sun and some moons use inverseSquared.

See Definitions/GravityFallOff

groundSize

Type: number

Radius of a simple sphere used as the ground for the planet. If you want to use more complex terrain, leave this as
0.


hasMapMarker

Type: boolean

If the body should have a marker on the map screen.


invulnerableToSun

Type: boolean

Can this planet survive entering a star?


showMinimap

Type: boolean Default: true

Do we show the minimap when walking around this planet?


soiOverride

Type: number

An override for the radius of the planet's gravitational sphere of influence. Optional


surfaceGravity

Type: number

The acceleration due to gravity felt as the surfaceSize. Timber Hearth has 12 for reference


surfaceSize

Type: number

A scale height used for a number of things. Should be the approximate radius of the body.


gravityVolumePriority

Type: integer Default: 0

Optional. You can force this planet's gravity to be felt over other gravity/zero-gravity sources by increasing this number.


pushable

Type: boolean

Apply physics to this planet when you bump into it. Will have a spherical collider the size of surfaceSize.
For custom colliders they have to all be convex and you can leave surface size as 0.
This is meant for stuff like satellites which are relatively simple and can be de-orbited.
If you are using an orbit line but a tracking line, it will be removed when the planet is bumped in to.


hideProxy

Type: boolean

Set this to true to have no proxy be generated for this planet.
This is a small representation of the planet that appears when it is outside of the regular Unity camera range.