Modding:SatelliteType (JSONObject)

From Starbounder - Starbound Wiki
Jump to: navigation, search

Quick Navigation


Satellite Types define new types of satellites that can orbit planets in the universe. They are defined as part of the Satellite Types Object in Celestial.config.

Key Value Pairs

Key Value Type Value Subtype Description Valid Values
selectionWeight Number Probability of spawning compared to other selectionWeights [0, 1]
baseParameters Object Base Parameters Object that defines in game details of the satellite
variationParameters Array Variation Parameters Parameters to vary the size of the satellite
orbitParameters Object Orbit Parameters Parameters to vary the temperature of the satellite

Example

 "Foo" : {
   "selectionWeight" : 0.1,
   "baseParameters" : {
     "type" : "Landable",
     "description" : "Foo Moon",
     "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.0375,
       "worldSize" : "tiny"
     },
     {
       "imageScale" : 0.055,
       "worldSize" : "small"
     },
     {
       "imageScale" : 0.07,
       "worldSize" : "large"
     },
     {
       "imageScale" : 0.09,
       "worldSize" : "verylarge"
     }
   ],
   "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 satellite. Known values include "Landable" "Landable"
description String Human readable description of the satellite type
liquidImages String Path to liquid images for rendering the star map and satellites in the sky
shadowImages String Path to shadow images for rendering the star map and satellites in the sky
biomeMaskImages String Path to biome masks for rendering the star map and satellites 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 satellites 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