Skip to content

SingularityModule

Celestial Body Schema / Definitions / SingularityModule
Schema Type: JSON Type: object

No Description Found

rotation

Type: MVector3

Rotation of the object

See Definitions/MVector3

alignRadial

Type: boolean or null

Do we try to automatically align this object to stand upright relative to the body's center? Stacks with rotation.
Defaults to true for geysers, tornados, and volcanoes, and false for everything else.


position

Type: MVector3

Position of the object

See Definitions/MVector3

parentPath

Type: string

The relative path from the planet to the parent of this object. Optional (will default to the root sector).


isRelativeToParent

Type: boolean

Whether the positional and rotational coordinates are relative to parent instead of the root planet object.


rename

Type: string

An optional rename of this object


curve

Type: array

Scale this object over time

Items

Type: TimeValuePair

No Description Found

See Definitions/TimeValuePair

pairedSingularity

Type: string

The uniqueID of the white hole or black hole that is paired to this one. If you don't set a value, entering will kill
the player


uniqueID

Type: string

The uniqueID of this white hole or black hole. If not set it will default to the name of the planet


horizonRadius

Type: number Minimum: 0

Radius of the event horizon (solid part)


distortRadius

Type: number Minimum: 0

Radius of the distortion effects. Defaults to 2.5 * horizonRadius


targetStarSystem

Type: string

If you want a black hole to load a new star system scene, put its name here.


type

Type: SingularityType

Type of singularity (white hole or black hole)

See Definitions/SingularityType

hasWarpEffects

Type: boolean

Whether a black hole emits blue particles upon warping. It doesn't scale, so disabling this for small black holes is recommended


renderQueueOverride

Type: integer Minimum: 2501Maximum: 3500

Optional override for the render queue. If the singularity is rendering oddly, increasing this to 3000 can help