Class endstone::Lectern¶
ClassList > endstone > Lectern
Represents a captured state of a lectern.
#include <endstone/block/lectern.h>
Inherits the following classes: endstone::Container
Public Functions¶
| Type | Name |
|---|---|
| virtual int | getPage () const = 0 Gets the page currently displayed on the lectern. |
| virtual void | setPage (int page) = 0 Sets the page currently displayed on the lectern. |
Public Functions inherited from endstone::Container¶
| Type | Name |
|---|---|
| virtual Inventory & | getInventory () const = 0 Gets the inventory of the block represented by this block state. |
Public Functions inherited from 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 Functions Documentation¶
function getPage¶
Gets the page currently displayed on the lectern.
The page is 0-indexed.
Returns:
the page
function setPage¶
Sets the page currently displayed on the lectern.
The page is 0-indexed, and is clamped to the number of pages in the book the lectern holds.
Parameters:
pagethe page
The documentation for this class was generated from the following file include/endstone/block/lectern.h