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

# Factorio Runtime Docs Version 2.0.77

# LuaSpaceLocationPrototype - Runtime Docs

## Class LuaSpaceLocationPrototype extends LuaPrototypeBase

Prototype of a space location, such as a planet.

Inherits from LuaPrototypeBase

## Members

gravity_pull | :: R double |
distance | :: R double |
orientation | :: R RealOrientation |
starmap_icon_orientation | :: R RealOrientation |
position | :: R MapPosition |
magnitude | :: R double |
parked_platforms_orientation | :: R RealOrientation |
parked_platforms_position | :: R MapPosition |
label_orientation | :: R RealOrientation |
draw_orbit | :: R boolean |
fly_condition | :: R boolean |
solar_power_in_space | :: R double |
asteroid_spawn_influence | :: R double |
asteroid_spawn_definitions | :: R array[SpaceLocationAsteroidSpawnDefinition]? |
factoriopedia_alternative | :: R LuaSpaceLocationPrototype? | An alternative prototype that will be used to display info about this prototype in Factoriopedia.
An alternative prototype that will be used to display info about this prototype in Factoriopedia.
map_seed_offset | :: R uint32? |
map_gen_settings | :: R MapGenSettings? |
entities_require_heating | :: R boolean? |
pollutant_type | :: R LuaAirbornePollutantPrototype? |
player_effects | :: R array[TriggerItem]? |
ticks_between_player_effects | :: R uint32? |
surface_properties | :: R dictionary[string → double]? | A mapping of the surface property name to the value.
A mapping of the surface property name to the value.
valid | :: R boolean | Is this object valid? [...]
Is this object valid? [...]
object_name | :: R string | The class name of this object. [...]
The class name of this object. [...]

Inherited from LuaPrototypeBase

type | :: R string | Type of this prototype.
Type of this prototype.
name | :: R string | Name of this prototype.
Name of this prototype.
order | :: R string | The string used to alphabetically sort these prototypes. [...]
The string used to alphabetically sort these prototypes. [...]
localised_name | :: R LocalisedString |
localised_description | :: R LocalisedString |
factoriopedia_description | :: R LocalisedString | Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
group | :: R LuaGroup | Group of this prototype.
Group of this prototype.
subgroup | :: R LuaGroup | Subgroup of this prototype.
Subgroup of this prototype.
hidden | :: R boolean |
hidden_in_factoriopedia | :: R boolean |
parameter | :: R boolean |
custom_tooltip_fields | :: R array[CustomTooltipField]? | Extra description items in the tooltip and Factoriopedia.
Extra description items in the tooltip and Factoriopedia.

## Attributes

### gravity_pull :: Read double

### distance :: Read double

### orientation :: Read RealOrientation

### starmap_icon_orientation :: Read RealOrientation

### position :: Read MapPosition

### magnitude :: Read double

### parked_platforms_orientation :: Read RealOrientation

### parked_platforms_position :: Read MapPosition

### label_orientation :: Read RealOrientation

### draw_orbit :: Read boolean

### fly_condition :: Read boolean

### solar_power_in_space :: Read double

### asteroid_spawn_influence :: Read double

### asteroid_spawn_definitions :: Read array[SpaceLocationAsteroidSpawnDefinition]?

### factoriopedia_alternative :: Read LuaSpaceLocationPrototype?

An alternative prototype that will be used to display info about this prototype in Factoriopedia.

### map_seed_offset :: Read uint32?

Can only be used if this is Planet

### map_gen_settings :: Read MapGenSettings?

Can only be used if this is Planet

### entities_require_heating :: Read boolean?

Can only be used if this is Planet

### pollutant_type :: Read LuaAirbornePollutantPrototype?

Can only be used if this is Planet

### player_effects :: Read array[TriggerItem]?

Can only be used if this is Planet

### ticks_between_player_effects :: Read uint32?

Can only be used if this is Planet

### surface_properties :: Read dictionary[string → double]?

A mapping of the surface property name to the value.

Can only be used if this is Planet

### valid :: Read boolean

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be `false`. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

### object_name :: Read string

The class name of this object. Available even when `valid` is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

Class used in

- LuaItemPrototype::default_import_location
- LuaPlanet::prototype
- LuaPrototypes::space_location
- LuaSpaceConnectionPrototype::from
- LuaSpaceConnectionPrototype::to
- LuaSpaceLocationPrototype::factoriopedia_alternative
- LuaSpacePlatform::space_location
- LuaSpacePlatform::last_visited_space_location
- FactoriopediaID
- PipetteID
- SpaceLocationID