Modding:PlanetType (JSONObject)
From Starbounder - Starbound Wiki
(Redirected from JsonObject:planetType)
Contents
Planet Types define new types of planets that can occur in star systems. They are defined as part of the Planet Types Object in Modding:Celestial.config.
Key Value Pairs
Key | Value Type | Value Subtype | Description | Valid Values |
---|---|---|---|---|
selectionWeight | Number | Probability of spawning compared to other planetTypes. | ||
satelliteProbability | Number | Probability of satellites spawning around the planet. | [0, 1] | |
baseParameters | Object | Base Parameters | Object that defines in game details of the planet | |
variationParameters | Array | Variation Parameters | Parameters to vary the size of the planet | |
orbitParameters | Object | Orbit Parameters | Parameters to vary the biomes available in different temperatures |
Example
"Foo" : { "selectionWeight" : 0.1, "baseParameters" : { "type" : "Landable", "description" : "Foo Planet", "shadowNumber" : [1, 9], "smallImage" : "/celestial/system/planet_small.png", "liquidImages" : "/celestial/system/terrestrial/liquids/<liquid>.png", "shadowImages" : "/celestial/system/terrestrial/shadows/<num>.png", "biomeMaskImages" : "/celestial/system/terrestrial/biomes/<biome>/maskie<num>.png", "biomeMasks" : 3, "dynamicsImages" : "/celestial/system/terrestrial/dynamics/<num>.png", "dynamicsRange" : [1, 40] }, "variationParameters" : [ { "imageScale" : 0.125, "smallImageScale" : 0.5, "worldSize" : "large" }, { "imageScale" : 0.15, "smallImageScale" : 0.6, "worldSize" : "verylarge" }, { "imageScale" : 0.175, "smallImageScale" : 0.7, "worldSize" : "huge" } ], "orbitParameters" : { "Hot" : [ { "availableBiomes" : [ "steamybiome", "hotbiome", "warmbiome" ] } ], "Mild" : [ { "availableBiomes" : [ "warmbiome", "mildbiome", "chillybiome" ] } ], "Cold" : [ { "availableBiomes" : [ "chillybiome", "coldbiome", "freezingbiome" ] } ] } }
baseParameters
Key Value Pairs
Key | Value Type | Value Subtype | Description | Valid Values |
---|---|---|---|---|
type | String | Type of planet. | "Landable", "GasGiant" | |
description | String | Human readable description of the planet type | ||
smallImage | String | Path to the image file that renders on the zoomed out star map. | ||
shadowNumber | Array | Number | ||
liquidImages | String | Path to liquid images for rendering the star map and planets in the sky | ||
shadowImages | String | Path to shadow images for rendering the star map and planets in the sky | ||
biomeMaskImages | String | Path to biome masks for rendering the star map and planets in the sky | ||
biomeMasks | String | Number of masks, range for filling in <num> keyword in biomeMaskImages | ||
dynamicsImages | String | Path to dynamics images for rendering the star map and planets in the sky, used for continents on stock planets | ||
dynamicsRange | Array | Number | Range of integers to fill into <num> keyword in dynamicsImages | Array Size 2 |
variationParameters
Key Value Pairs
Key | Value Type | Value Subtype | Description | Valid Values |
---|---|---|---|---|
imageScale | Number | Scale of the image for rendering | ||
worldSize | String | id of the matching Planet Size Object defined in Modding:Planetgen.config |
orbitParameters
Key Value Pairs
Key | Value Type | Value Subtype | Description | Valid Values |
---|---|---|---|---|
Hot | Array | String | Array of ids of available Surface Biome Objects for hot temperatures | |
Mild | Array | String | Array of ids of available Surface Biome Objects for mild temperatures | |
Cold | Array | String | Array of ids of available Surface Biome Objects for cold temperatures |