Skip to content

Class endstone::BlockActorState

ClassList > endstone > BlockActorState

Represents a captured state of a block entity.

  • #include <endstone/block/block_actor_state.h>

Inherits the following classes: endstone::BlockState

Inherited by the following classes: endstone::Campfire, endstone::Container, endstone::CreatureSpawner, endstone::ItemFrame, endstone::Sign

Public Functions

Type Name
virtual bool isSnapshot () const = 0
Gets whether this state is backed by an independent block entity snapshot.
~BlockActorState () override

Public Functions inherited from endstone::BlockState

See endstone::BlockState

Type Name
virtual NotNull< Block > getBlock () const = 0
Gets the block represented by this block state.
virtual NotNull< BlockData > getData () const = 0
Gets the data for this block state.
virtual NotNull< Dimension > getDimension () const = 0
Gets the dimension which contains the block represented by this block state.
virtual Location getLocation () const = 0
Gets the location of this block state.
virtual const BlockType & getType () const = 0
Gets the type of this block state.
virtual int getX () const = 0
Gets the x-coordinate of this block state.
virtual int getY () const = 0
Gets the y-coordinate of this block state.
virtual int getZ () const = 0
Gets the z-coordinate of this block state.
virtual void setData (const BlockData & data) = 0
Sets the data for this block state.
virtual void setType (BlockTypeId type) = 0
Sets the type of this block state.
virtual bool update () = 0
Attempts to update the block represented by this state, setting it to yhe new values as defined by this state.
virtual bool update (bool force) = 0
Attempts to update the block represented by this state, setting it to the new values as defined by this state.
virtual bool update (bool force, bool apply_physics) = 0
Attempts to update the block represented by this state, setting it to the new values as defined by this state.
~BlockState () override

Public Functions inherited from endstone::Object

See endstone::Object

Type Name
T * as ()
Attempts to cast this object to the given type T.
const T * as () const
Attempts to cast this object to the given type T.
virtual ClassInfo getClassInfo () const = 0
bool is () const
Checks if this object is an instance of the given type T (or a subclass of T).
virtual bool isInstanceOf (ClassInfo target) const = 0
virtual ~Object () = default

Public Functions Documentation

function isSnapshot

Gets whether this state is backed by an independent block entity snapshot.

virtual bool endstone::BlockActorState::isSnapshot () const = 0

Returns:

true if this state is a snapshot, otherwise false.


function ~BlockActorState

endstone::BlockActorState::~BlockActorState () override


The documentation for this class was generated from the following file include/endstone/block/block_actor_state.h