LuaPlanet

The runtime values of a planet

Attributes

name

• Read: string
• Write: unknown
• Optional: false

The planets name.

prototype

• Read: LuaSpaceLocationPrototype
• Write: unknown
• Optional: false

surface

• Read: LuaSurface
• Write: unknown
• Optional: true

The surface for this planet if one currently exists.

Planets do not default generate their surface. LuaPlanet::create_surface can be used to force the surface to exist.

LuaPlanet::associate_surface can be used to create an association with an existing surface.

valid

• Read: boolean
• Write: unknown
• Optional: false

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
• Write: unknown
• Optional: false

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.

Methods

create_surface

LuaPlanet.create_surface() -> LuaSurface

Call As

planet.create_surface()

Call Convention

• takes_table: false
• table_optional: false

Creates the associated surface if one doesn't already exist.

Returns

• LuaSurface

associate_surface

LuaPlanet.associate_surface(surface: SurfaceIdentification)

Call As

planet.associate_surface(surface)

Call Convention

• takes_table: false
• table_optional: false

Associates the given surface with this planet. Surface must not already be associated with a planet and the planet must not already have an associated surface.

Planet must not be using entities_require_heating.

Parameters

• surface: SurfaceIdentification — The surface to be associated.

reset_map_gen_settings

LuaPlanet.reset_map_gen_settings()

Call As

planet.reset_map_gen_settings()

Call Convention

• takes_table: false
• table_optional: false

Resets the map gen settings on this planet to the default from-prototype state.

get_space_platforms

LuaPlanet.get_space_platforms(force: ForceID) -> Array<LuaSpacePlatform>

Call As

planet.get_space_platforms(force)

Call Convention

• takes_table: false
• table_optional: false

Gets the built space platforms orbiting this planet on the given force.

Note, this does not include platforms that have not yet been built.

Parameters

• force: ForceID

Returns

• Array<LuaSpacePlatform>