Struct LuaChunkIterator 

pub struct LuaChunkIterator;

A chunk iterator can be used for iterating chunks coordinates of a surface.

The returned type is a ChunkPositionAndArea containing the chunk coordinates and its area.

Implementations

impl LuaChunkIterator

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 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.

Trait Implementations

impl Clone for LuaChunkIterator

fn clone(&self) -> LuaChunkIterator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for LuaChunkIterator

impl Debug for LuaChunkIterator

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

Formats the value using the given formatter.

impl Default for LuaChunkIterator

fn default() -> LuaChunkIterator

Returns the “default value” for a type.

impl Eq for LuaChunkIterator

impl From<LuaChunkIterator> for LuaAny

fn from(_: LuaChunkIterator) -> Self

Converts to this type from the input type.

impl LuaObject for LuaChunkIterator

impl PartialEq for LuaChunkIterator

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LuaChunkIterator