Class endstone::Sign¶

Represents a captured state of a sign.

#include <endstone/block/sign.h>

Inherits the following classes: endstone::BlockState

Public Types¶

Type	Name
enum	Side Represents a side of a sign.

Public Functions¶

Type	Name
virtual SignSide &	getSide (Side side) const = 0 Gets the side of this sign.
virtual bool	isWaxed () const = 0 Gets whether this sign is waxed.
virtual void	setWaxed (bool waxed) = 0 Sets whether this sign is waxed.

Public Functions inherited from endstone::BlockState¶

See endstone::BlockState

Type	Name
virtual std::unique_ptr< Block >	getBlock () const = 0 Gets the block represented by this block state.
virtual std::unique_ptr< 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 const std::type_info &	getClassTypeId () 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 (const std::type_info & target) const = 0
virtual	~Object () = default

Public Types Documentation¶

enum Side¶

Represents a side of a sign.

enum endstone::Sign::Side {
    Front = 0,
    Back = 1
};

Public Functions Documentation¶

function getSide¶

Gets the side of this sign.

virtual SignSide & endstone::Sign::getSide (
    Side side
) const = 0

Parameters:

side the side of the sign

Returns:

the given side of the sign

function isWaxed¶

Gets whether this sign is waxed.

virtual bool endstone::Sign::isWaxed () const = 0

A waxed sign cannot be edited by players.

Returns:

true if this sign is waxed

function setWaxed¶

Sets whether this sign is waxed.

virtual void endstone::Sign::setWaxed (
    bool waxed
) = 0

Parameters:

waxed whether this sign is waxed

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