Skip to content

StarModule

Schema Type: JSONType: object

No Description Found

curve

Type: array

Scale this object over time. Time is in minutes. Value is a multiplier of the size of the object.

Items

Type: TimeValuePair

No Description Found

See Definitions/TimeValuePair

endTint

Type: MColor

Colour of the star at the end of its lifespan.

See Definitions/MColor

lifespan

Type: numberDefault: 22

How long in minutes this star will last until it dies. This value is ignored if stellarDeathType is set to None.


hasStarController

Type: booleanDefault: true

The StarController component is used to calculate atmospheric shaders (e.g., sunrise/sunset and) on planets.
When there are multiple stars in a system, the closest and brightest one to the player is used to calculate these.
Sometimes you do not want a StarController, say if the star is within clouds or an atmosphere or is meant to be overpowered by a brighter star.
In those instances, set this to False. An atmosphere which has shaders enabled with a star inside it will appear bugged.


hasAtmosphere

Type: booleanDefault: true

The default sun has its own atmosphere that is different from regular planets. If you want that, set this to
`true`.


lightTint

Type: MColor

Colour of the light given off. Defaults to yellowish.

See Definitions/MColor

size

Type: numberMinimum: 0Default: 2000

Radius of the star.


solarLuminosity

Type: numberMinimum: 0Default: 1

Relative strength of the light compared to the sun.


supernovaSize

Type: numberMinimum: 0Default: 50000

Radius of the supernova. Any planets within this will be destroyed.


supernovaSpeed

Type: numberMinimum: 1Default: 1000

Speed of the supernova wall in meters per second.


supernovaTint

Type: MColor

The tint of the supernova this star creates when it dies.

See Definitions/MColor

tint

Type: MColor

Colour of the star.

See Definitions/MColor

starRampTexture

Type: string

Path to the texture to put as the star ramp. Optional.


starCollapseRampTexture

Type: string

Path to the texture to put as the star ramp while it is collapsing. Optional.


lightRadius

Type: numberMinimum: 0Default: 50000

How far the light from the star can reach.


stellarDeathType

Type: StellarDeathTypeDefault: default

The type of death your star will have.

See Definitions/StellarDeathType

stellarRemnantType

Type: StellarRemnantTypeDefault: default

The type of stellar remnant your star will leave behind.

See Definitions/StellarRemnantType

solarFlareSettings

Type: SolarFlareModule

Allows overriding solar flare graphical settings.

See Definitions/SolarFlareModule