cBedEntity Class Reference

#include <BedEntity.h>

Inheritance diagram for cBedEntity:

Collaboration diagram for cBedEntity:

Public Member Functions
	cBedEntity (BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta, Vector3i a_Pos, cWorld *a_World, short a_Color=E_META_WOOL_RED)
virtual cItems	ConvertToPickups () const override
	Returns the contents of this block entity that it would drop if broken. More...
virtual void	CopyFrom (const cBlockEntity &a_Src) override
	Copies all properties of a_Src into this entity, except for its m_World and location. More...
short	GetColor (void) const
	Returns the color of the bed. More...
bool	IsPillowBlock (void)
	Returns true if this is the pillow block, it has then the meta 8. More...
virtual void	SendTo (cClientHandle &a_Client) override
	Sends the packet defining the block entity to the client specified. More...
void	SetColor (short a_Color)
	Set the color of the bed. More...
virtual bool	UsedBy (cPlayer *a_Player) override
	Called when a player uses this entity; should open the UI window. More...
Public Member Functions inherited from cBlockEntity
OwnedBlockEntity	Clone (Vector3i a_Pos)
	Makes an exact copy of this block entity, except for its m_World (set to nullptr), and at a new position. More...
virtual void	Destroy ()
	Called when this block entity's associated block is destroyed. More...
BLOCKTYPE	GetBlockType () const
int	GetChunkX () const
int	GetChunkZ () const
Vector3i	GetPos () const
int	GetPosX () const
int	GetPosY () const
int	GetPosZ () const
Vector3i	GetRelPos () const
int	GetRelX () const
int	GetRelZ () const
cWorld *	GetWorld () const
virtual void	OnAddToWorld (cWorld &a_World, cChunk &a_Chunk)
	Called when the block entity object is added to a world. More...
virtual void	OnRemoveFromWorld ()
	Called when the block entity object is removed from a world. More...
void	SetPos (Vector3i a_NewPos)
	Updates the internally stored position. More...
void	SetWorld (cWorld *a_World)
virtual bool	Tick (std::chrono::milliseconds a_Dt, cChunk &a_Chunk)
	Ticks the entity; returns true if the chunk should be marked as dirty as a result of this ticking. More...
virtual	~cBlockEntity ()=default

Private Types
using	Super = cBlockEntity

Private Attributes
short	m_Color

Additional Inherited Members
Static Public Member Functions inherited from cBlockEntity
static OwnedBlockEntity	CreateByBlockType (BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta, Vector3i a_Pos, cWorld *a_World=nullptr)
	Creates a new block entity for the specified block type at the specified absolute pos. More...
static bool	IsBlockEntityBlockType (BLOCKTYPE a_BlockType)
	Returns true if the specified blocktype is supposed to have an associated block entity. More...
Protected Member Functions inherited from cBlockEntity
	cBlockEntity (BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta, Vector3i a_Pos, cWorld *a_World)
Protected Attributes inherited from cBlockEntity
NIBBLETYPE	m_BlockMeta
	The block meta representing this particular instance in the world Mainly used for directional entities, such as dispensers. More...
BLOCKTYPE	m_BlockType
	The blocktype representing this particular instance in the world. More...
Vector3i	m_Pos
	Position in absolute block coordinates. More...
int	m_RelX
	Position relative to the chunk, used to speed up ticking. More...
int	m_RelZ
cWorld *	m_World

Detailed Description

Definition at line 15 of file BedEntity.h.

Member Typedef Documentation

Super

using cBedEntity::Super = cBlockEntity

private

Definition at line 19 of file BedEntity.h.

Constructor & Destructor Documentation

cBedEntity()

cBedEntity::cBedEntity	(	BLOCKTYPE	a_BlockType,
		NIBBLETYPE	a_BlockMeta,
		Vector3i	a_Pos,
		cWorld *	a_World,
		short	a_Color = E_META_WOOL_RED
	)

Definition at line 16 of file BedEntity.cpp.

Member Function Documentation

ConvertToPickups()

cItems cBedEntity::ConvertToPickups ( ) const

overridevirtual

Returns the contents of this block entity that it would drop if broken.

Note that the block handler will usually handle pickups for the block itself, in addition to any items returned here.

Reimplemented from cBlockEntity.

Definition at line 27 of file BedEntity.cpp.

CopyFrom()

void cBedEntity::CopyFrom ( const cBlockEntity &  a_Src )

overridevirtual

Copies all properties of a_Src into this entity, except for its m_World and location.

Each non-abstract descendant should override to copy its specific properties, and call Super::CopyFrom(a_Src) to copy the common ones.

Reimplemented from cBlockEntity.

Definition at line 36 of file BedEntity.cpp.

GetColor()

short cBedEntity::GetColor ( void  ) const

inline

Returns the color of the bed.

Definition at line 28 of file BedEntity.h.

IsPillowBlock()

bool cBedEntity::IsPillowBlock ( void  )

inline

Returns true if this is the pillow block, it has then the meta 8.

Definition at line 34 of file BedEntity.h.

SendTo()

void cBedEntity::SendTo ( cClientHandle &  a_Client )

overridevirtual

Sends the packet defining the block entity to the client specified.

To send to all eligible clients, use cWorld::BroadcastBlockEntity()

Implements cBlockEntity.

Definition at line 47 of file BedEntity.cpp.

SetColor()

void cBedEntity::SetColor

(

short

a_Color

)

Set the color of the bed.

Definition at line 56 of file BedEntity.cpp.

UsedBy()

virtual bool cBedEntity::UsedBy ( cPlayer *  a_Player )

inlineoverridevirtual

Called when a player uses this entity; should open the UI window.

returns true if the use was successful, return false to use the block as a "normal" block

Implements cBlockEntity.

Definition at line 41 of file BedEntity.h.

Member Data Documentation

m_Color

short cBedEntity::m_Color

private

Definition at line 46 of file BedEntity.h.

---

The documentation for this class was generated from the following files:

• src/BlockEntities/BedEntity.h
• src/BlockEntities/BedEntity.cpp