Factorio.com|Forums|Wiki|Mod Portal|API Docs

# Factorio Prototype Docs Version 2.0.77

# SpaceLocationPrototype - Prototype Docs

## SpaceLocationPrototype 'space-location'

A space location, such as a planet or the solar system edge.

Inherits from Prototype « PrototypeBase
Children PlanetPrototype - 'planet'

## Properties

- default
- sorted

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[overridden] optional | :: boolean | Hides the space location from the planet selection lists and the space map.
Hides the space location from the planet selection lists and the space map.
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.

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.
asteroid_spawn_definitions optional | :: array[SpaceLocationAsteroidSpawnDefinition] |
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. [...]
auto_save_on_first_trip optional | :: boolean |
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.
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
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.
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. [...]
icons optional | :: array[IconData] | Can't be an empty array.
Can't be an empty array.
label_orientation optional | :: RealOrientation | The orientation where the location's name will be drawn.
The orientation where the location's name will be drawn.
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.
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.
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.
procession_audio_catalogue optional | :: ProcessionAudioCatalogue |
procession_graphic_catalogue optional | :: ProcessionGraphicCatalogue |
solar_power_in_space optional | :: double |
starmap_icon optional | :: FileName | Path to the icon file. [...]
Path to the icon file. [...]
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.
starmap_icon_size optional | :: SpriteSizeType | The size of the starmap icon, in pixels. [...]
The size of the starmap icon, in pixels. [...]
starmap_icons optional | :: array[IconData] | Can't be an empty array.
Can't be an empty array.

Inherited from Prototype

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.
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. [...]

Inherited from PrototypeBase

name | :: string | Unique textual identification of the prototype. [...]
Unique textual identification of the prototype. [...]
type | :: string | Specifies the kind of prototype this is. [...]
Specifies the kind of prototype this is. [...]
factoriopedia_description optional | :: LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
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.
hidden[overridden] optional | :: boolean | Hides the space location from the planet selection lists and the space map.
Hides the space location from the planet selection lists and the space map.
hidden_in_factoriopedia optional | :: boolean |
localised_description optional | :: LocalisedString | Overwrites the description set in the locale file. [...]
Overwrites the description set in the locale file. [...]
localised_name optional | :: LocalisedString | Overwrites the name set in the locale file. [...]
Overwrites the name set in the locale file. [...]
order optional | :: Order | Used to order prototypes in inventory, recipes and GUIs. [...]
Used to order prototypes in inventory, recipes and GUIs. [...]
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.
subgroup optional | :: ItemSubGroupID | The name of an ItemSubGroup.
The name of an ItemSubGroup.

## Properties

### gravity_pull :: double optional

Default: `0`

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.

### orientation :: RealOrientation

Angle in relation to the sun.

### magnitude :: double optional

Default: `1.0`

The apparent size of the space location in map coordinates.

### parked_platforms_orientation :: RealOrientation optional

Default: same as orientation

The orientation where parked space platforms will be drawn.

### label_orientation :: RealOrientation optional

Default: `0.25`

The orientation where the location's name will be drawn.

### draw_orbit :: boolean optional

Default: `true`

If `false`, the orbital ring around the sun will not be drawn for this location.

### solar_power_in_space :: double optional

Default: `1.0`

### asteroid_spawn_influence :: double optional

Default: `0.1`

If greater than 0, `asteroid_spawn_definitions` will be used on space connections of this location, interpolated based on distance. The number specifies the percentage of the route where the location stops spawning its asteroids.

### fly_condition :: boolean optional

Default: `false`

When set to true, it means that this connection offers fly condition rather than wait condition at the destination

### auto_save_on_first_trip :: boolean optional

Default: `true`

### procession_graphic_catalogue :: ProcessionGraphicCatalogue optional

### procession_audio_catalogue :: ProcessionAudioCatalogue optional

### platform_procession_set :: ProcessionSet optional

These transitions are used for any platform stopped at this location.

### planet_procession_set :: ProcessionSet optional

These transitions are used for anything traveling from the surface associated with this location.

### icons :: array[IconData] optional

Can't be an empty array.

### icon :: FileName optional

Path to the icon file.

Only loaded, and mandatory if `icons` is not defined.

### icon_size :: SpriteSizeType optional

Default: `64`

The size of the square icon, in pixels. E.g. `32` for a 32px by 32px icon. Must be larger than `0`.

Only loaded if `icons` is not defined.

### starmap_icons :: array[IconData] optional

Can't be an empty array.

### starmap_icon :: FileName optional

Path to the icon file.

Only loaded if `starmap_icons` is not defined.

### starmap_icon_size :: SpriteSizeType optional

Default: `64`

The size of the starmap icon, in pixels. E.g. `32` for a 32px by 32px icon. Must be larger than `0`.

Only loaded if `starmap_icons` is not defined.

### starmap_icon_orientation :: RealOrientation optional

Orientation of the starmap icon, defaults to pointing towards the sun.

### asteroid_spawn_definitions :: array[SpaceLocationAsteroidSpawnDefinition] optional

## Overridden Properties

### hidden :: boolean optional

Default: `false`

Hides the space location from the planet selection lists and the space map.