Skip to main content

PlanetRegionInfo

The region info format of a planet. It is the combination of the following types:


Subtype A


PlanetData


Atmosphere

It is of the type boolean. It is read-only, it cannot be assigned to.


DayCycleIncrement

It is of the type number. It is read-only, it cannot be assigned to.


EnterLocation

It is of the type RegionEntryLocation. It is read-only, it cannot be assigned to.


GenerationHeightScale

It is of the type number. It is read-only, it cannot be assigned to.


Gravity

It is of the type number. It is read-only, it cannot be assigned to.


PlanetMaterial

It can be any of the following strings: "Grass", "Sand", "Snow", "Rock1", "Rock2". It is read-only, it cannot be assigned to.


PlanetType

It is of the type PlanetType. It is read-only, it cannot be assigned to.


PrimaryColor

It is of the type RegionColor. It is read-only, it cannot be assigned to.


Resources

It is an array whose values are of the type string. It is read-only, it cannot be assigned to.


Rings

It is of the type RingData. It may also be nil. It is read-only, it cannot be assigned to.


SecondaryColor

It is of the type RegionColor. It is read-only, it cannot be assigned to.


StartingTime

It is of the type number. It is read-only, it cannot be assigned to.


Temperature

It is of the type number. It is read-only, it cannot be assigned to.


TerrainConfig

It is of the type TerrainData. It is read-only, it cannot be assigned to.

It is read-only, it cannot be assigned to.


Subtype B

It is of the type PlayableRegionInfo.

Luau Type

This is the luau type for PlanetRegionInfo. It may help clear up mistranslations from the raw data to the wiki page (as it is an automatic process).

export type PlanetRegionInfo = {
read StarType: never,
read BlackHoleSize: never,
read StarSize: never,
read OrbitBody: never,
read PlanetData: {
read DayCycleIncrement: number,
read EnterLocation: RegionEntryLocation,
read PrimaryColor: RegionColor,
read Gravity: number,
read TerrainConfig: TerrainData,
read GenerationHeightScale: number,
read Temperature: number,
read Rings: RingData?,
read PlanetType: PlanetType,
read StartingTime: number,
read Atmosphere: boolean,
read Resources: { string },
read SecondaryColor: RegionColor,
read PlanetMaterial: "Grass" | "Sand" | "Snow" | "Rock1" | "Rock2",
},
} & PlayableRegionInfo