Struct LuaEntityMineParams 

pub struct LuaEntityMineParams {
    pub force: bool,
    pub ignore_minable: bool,
    pub inventory: LuaInventory,
    pub raise_destroyed: bool,
}

Mines this entity.

‘Standard’ operation is to keep calling LuaEntity.mine with an inventory until all items are transferred and the items dealt with.

The result of mining the entity (the item(s) it produces when mined) will be dropped on the ground if they don’t fit into the provided inventory. If no inventory is provided, the items will be destroyed.

Fields

force: bool

If true, when the item(s) don’t fit into the given inventory the entity is force mined. If false, the mining operation fails when there isn’t enough room to transfer all of the items into the inventory. Defaults to false. This is ignored and acts as true if no inventory is provided.

ignore_minable: bool

If true, the minable state of the entity is ignored. Defaults to false. If false, an entity that isn’t minable (set as not-minable in the prototype or isn’t minable for other reasons) will fail to be mined.

inventory: LuaInventory

If provided the item(s) will be transferred into this inventory. If provided, this must be an inventory created with LuaGameScript::create_inventory or be a basic inventory owned by some entity.

raise_destroyed: bool

If true, script_raised_destroy will be raised. Defaults to true.

Trait Implementations

impl Clone for LuaEntityMineParams

fn clone(&self) -> LuaEntityMineParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LuaEntityMineParams

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

Formats the value using the given formatter.

impl Default for LuaEntityMineParams

fn default() -> LuaEntityMineParams

Returns the “default value” for a type.