PlanetPrototype - Prototype Docs

PlanetPrototype 'planet'

Inherits from SpaceLocationPrototype « Prototype « PrototypeBase

Properties

map_seed_offset optional	:: uint32
entities_require_heating optional	:: boolean
pollutant_type optional	:: AirbornePollutantID
persistent_ambient_sounds optional	:: PersistentWorldAmbientSoundsDefinition
surface_render_parameters optional	:: SurfaceRenderParameters
player_effects optional	:: Trigger
ticks_between_player_effects optional	:: MapTick
map_gen_settings optional	:: PlanetPrototypeMapGenSettings
surface_properties optional	:: dictionary[SurfacePropertyID → double]
lightning_properties optional	:: LightningProperties

Inherited from SpaceLocationPrototype

gravity_pull optional	:: double	A value which modifies platform speed; is subtracted when traveling from this location and added when traveling to this location.
A value which modifies platform speed; is subtracted when traveling from this location and added when traveling to this location.
distance	:: double	Distance from the sun in map coordinates.
Distance from the sun in map coordinates.
orientation	:: RealOrientation	Angle in relation to the sun.
Angle in relation to the sun.
magnitude optional	:: double	The apparent size of the space location in map coordinates.
The apparent size of the space location in map coordinates.
parked_platforms_orientation optional	:: RealOrientation	The orientation where parked space platforms will be drawn.
The orientation where parked space platforms will be drawn.
label_orientation optional	:: RealOrientation	The orientation where the location's name will be drawn.
The orientation where the location's name will be drawn.
draw_orbit optional	:: boolean	If `false`, the orbital ring around the sun will not be drawn for this location.
If `false`, the orbital ring around the sun will not be drawn for this location.
solar_power_in_space optional	:: double
asteroid_spawn_influence optional	:: double	If greater than 0, `asteroid_spawn_definitions` will be used on space connections of this location, interpolated based on distance. [...]
If greater than 0, `asteroid_spawn_definitions` will be used on space connections of this location, interpolated based on distance. [...]
fly_condition optional	:: boolean	When set to true, it means that this connection offers fly condition rather than wait condition at the destination
When set to true, it means that this connection offers fly condition rather than wait condition at the destination
auto_save_on_first_trip optional	:: boolean
procession_graphic_catalogue optional	:: ProcessionGraphicCatalogue
procession_audio_catalogue optional	:: ProcessionAudioCatalogue
platform_procession_set optional	:: ProcessionSet	These transitions are used for any platform stopped at this location.
These transitions are used for any platform stopped at this location.
planet_procession_set optional	:: ProcessionSet	These transitions are used for anything traveling from the surface associated with this location.
These transitions are used for anything traveling from the surface associated with this location.
icons optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
icon optional	:: FileName	Path to the icon file. [...]
Path to the icon file. [...]
icon_size optional	:: SpriteSizeType	The size of the square icon, in pixels. [...]
The size of the square icon, in pixels. [...]
starmap_icons optional	:: array[IconData]	Can't be an empty array.
Can't be an empty array.
starmap_icon optional	:: FileName	Path to the icon file. [...]
Path to the icon file. [...]
starmap_icon_size optional	:: SpriteSizeType	The size of the starmap icon, in pixels. [...]
The size of the starmap icon, in pixels. [...]
starmap_icon_orientation optional	:: RealOrientation	Orientation of the starmap icon, defaults to pointing towards the sun.
Orientation of the starmap icon, defaults to pointing towards the sun.
asteroid_spawn_definitions optional	:: array[SpaceLocationAsteroidSpawnDefinition]

Inherited from Prototype

factoriopedia_alternative optional	:: string	The ID type corresponding to the prototype that inherits from this. [...]
The ID type corresponding to the prototype that inherits from this. [...]
custom_tooltip_fields optional	:: array[CustomTooltipField]	Allows to add extra description items to the tooltip and Factoriopedia.
Allows to add extra description items to the tooltip and Factoriopedia.

Inherited from PrototypeBase

type	:: string	Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
name	:: string	Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
order optional	:: Order	Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
localised_name optional	:: LocalisedString	Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
localised_description optional	:: LocalisedString	Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
factoriopedia_description optional	:: LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
subgroup optional	:: ItemSubGroupID	The name of an ItemSubGroup.
The name of an ItemSubGroup.
hidden optional	:: boolean
hidden_in_factoriopedia optional	:: boolean
parameter optional	:: boolean	Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
Whether the prototype is a special type which can be used to parametrize blueprints and doesn't have other function.
factoriopedia_simulation optional	:: SimulationDefinition	The simulation shown when looking at this prototype in the Factoriopedia GUI.
The simulation shown when looking at this prototype in the Factoriopedia GUI.

Properties

map_seed_offset :: uint32 optional

Default: CRC checksum of name

entities_require_heating :: boolean optional

Default: false

pollutant_type :: AirbornePollutantID optional

persistent_ambient_sounds :: PersistentWorldAmbientSoundsDefinition optional

surface_render_parameters :: SurfaceRenderParameters optional

player_effects :: Trigger optional

ticks_between_player_effects :: MapTick optional

Default: 0

Factorio Prototype Docs Version 2.0.72

PlanetPrototype 'planet'

Properties

Properties

map_seed_offset :: uint32 optional

entities_require_heating :: boolean optional

pollutant_type :: AirbornePollutantID optional

persistent_ambient_sounds :: PersistentWorldAmbientSoundsDefinition optional

surface_render_parameters :: SurfaceRenderParameters optional

player_effects :: Trigger optional

ticks_between_player_effects :: MapTick optional

map_gen_settings :: PlanetPrototypeMapGenSettings optional

surface_properties :: dictionary[SurfacePropertyID → double] optional

lightning_properties :: LightningProperties optional

Prototypes

Types

Defines

Factorio Prototype DocsVersion 2.0.72

PlanetPrototype 'planet'

Properties

Properties

map_seed_offset :: uint32 optional

entities_require_heating :: boolean optional

pollutant_type :: AirbornePollutantID optional

persistent_ambient_sounds :: PersistentWorldAmbientSoundsDefinition optional

surface_render_parameters :: SurfaceRenderParameters optional

player_effects :: Trigger optional

ticks_between_player_effects :: MapTick optional

map_gen_settings :: PlanetPrototypeMapGenSettings optional

surface_properties :: dictionary[SurfacePropertyID → double] optional

lightning_properties :: LightningProperties optional

Prototypes

Types

Defines

Factorio Prototype Docs Version 2.0.72