Struct LuaEntityDestroyParams 

pub struct LuaEntityDestroyParams {
    pub do_cliff_correction: bool,
    pub player: PlayerIdentification,
    pub raise_destroy: bool,
    pub undo_index: u32,
}

Destroys the entity.

Not all entities can be destroyed - things such as rails under trains cannot be destroyed until the train is moved or destroyed.

Fields

do_cliff_correction: bool

Whether neighbouring cliffs should be corrected. Defaults to false.

player: PlayerIdentification

The player whose undo queue this action should be added to.

raise_destroy: bool

If true, script_raised_destroy will be called. Defaults to false.

undo_index: u32

The index of the undo item to add this action to. An index of 0 creates a new undo item for it. Defaults to putting it into the appropriate undo item automatically if not specified.

Trait Implementations

impl Clone for LuaEntityDestroyParams

fn clone(&self) -> LuaEntityDestroyParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LuaEntityDestroyParams

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

Formats the value using the given formatter.

impl Default for LuaEntityDestroyParams

fn default() -> LuaEntityDestroyParams

Returns the “default value” for a type.