Struct LuaPlanet 

pub struct LuaPlanet;

The runtime values of a planet

Implementations

impl LuaPlanet

pub fn name(&self) -> &str

The planets name.

pub fn object_name(&self) -> &str

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.

pub fn prototype(&self) -> LuaSpaceLocationPrototype

pub fn surface(&self) -> LuaSurface

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.

pub fn valid(&self) -> bool

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.

pub fn associate_surface(&self, surface: LuaAny)

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.

pub fn create_surface(&self) -> LuaSurface

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

pub fn get_space_platforms(&self, force: LuaAny) -> Vec<LuaSpacePlatform>

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

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

pub fn reset_map_gen_settings(&self)

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

Trait Implementations

impl Clone for LuaPlanet

fn clone(&self) -> LuaPlanet

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LuaPlanet

impl Debug for LuaPlanet

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LuaPlanet

fn default() -> LuaPlanet

Returns the “default value” for a type.

impl Eq for LuaPlanet

impl From<LuaPlanet> for LuaAny

fn from(_: LuaPlanet) -> Self

Converts to this type from the input type.

impl LuaObject for LuaPlanet

impl PartialEq for LuaPlanet

fn eq(&self, other: &LuaPlanet) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LuaPlanet