Skip to content

DreamCandleInfo

Celestial Body Schema / Definitions / DreamCandleInfo
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

isRelativeToParent

Type: boolean

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


parentPath

Type: string

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


rename

Type: string

An optional rename of this object


type

Type: DreamCandleType Default: Ground

The type of dream candle this is.

See Definitions/DreamCandleType

startLit

Type: boolean

Whether the candle should start lit or extinguished.