Struct LuaSpacePlatform

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.

Source

pub fn paused(&self) -> bool

When true, the platform has paused thrust and does not advance its schedule.

Source

pub fn schedule(&self) -> PlatformSchedule

This platform’s current schedule, if any. Set to nil to clear.

The schedule can’t be changed by modifying the returned table. Instead, changes must be made by assigning a new table to this attribute.

This is a simplified schedule that does not include groups and interrupts. See LuaSpacePlatform::get_schedule for full access to the schedule, including interrupts and groups.

Source

pub fn scheduled_for_deletion(&self) -> u32

If this platform is scheduled for deletion.

Returns how many ticks are left before the platform will be deleted. 0 if not scheduled for deletion.

Source

pub fn space_connection(&self) -> LuaSpaceConnectionPrototype

The space connection this space platform is traveling through or nil.

Write operation requires a valid space connection and it sets the distance to 0.5.

Source

pub fn space_location(&self) -> LuaSpaceLocationPrototype

The space location this space platform is stopped at or nil.

Write operation requires a valid space location and will cancel pending item requests.

Source

pub fn speed(&self) -> f64

Source

pub fn starter_pack(&self) -> ItemIDAndQualityIDPair

The starter pack used to create this space platform.

Source

pub fn state(&self) -> &str

The current state of this space platform.

Source

pub fn surface(&self) -> LuaSurface

The surface that belongs to this platform (if it has been created yet).

Source

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.

Source

pub fn weight(&self) -> LuaAny

The total weight of the platform.

Source

pub fn apply_starter_pack(&self, silent: Option<bool>) -> Option<LuaEntity>

Applies the starter pack for this platform if it hasn’t already been applied.

Source

pub fn can_leave_current_location(&self) -> bool

Returns true when the space platform isn’t waiting on any delivery from the planet.

Source

pub fn cancel_deletion(&self)

Cancels deletion of this space platform if it was scheduled for deletion.

Source

pub fn clear_ejected_items(&self)

Removes all ejected items from this space platform.

Source

pub fn create_asteroid_chunks(&self, asteroid_chunks: Vec<AsteroidChunk>)

Creates the given asteroid chunks on this platform.

Source

pub fn damage_tile(&self, params: LuaSpacePlatformDamageTileParams)

Damages the given tile if it exists, the chunk is generated, and it is a platform foundation tile.

Source

pub fn destroy(&self, ticks: Option<u32>)

Schedules this space platform for deletion.

Source

pub fn destroy_asteroid_chunks( &self, params: LuaSpacePlatformDestroyAsteroidChunksParams, ) -> u32

Destroys all asteroid chunks from the given area. If no area and no position are given, then the entire surface is searched.

Source

pub fn eject_item(&self, item: LuaAny, movement: Vector, position: MapPosition)

Ejects an item into space on this space platform.

If a LuaItemStack is provided, the actual item is ejected and removed from the source.

Source

pub fn find_asteroid_chunks_filtered( &self, params: LuaSpacePlatformFindAsteroidChunksFilteredParams, ) -> Vec<AsteroidChunk>

Find asteroid chunks of a given name in a given area.

If no filters are given, returns all asteroid chunks in the search area. If multiple filters are specified, returns only asteroid chunks matching every given filter. If no area and no position are given, the entire surface is searched.

Source