#include <BlockLever.h>

Inheritance diagram for cBlockLeverHandler:

Collaboration diagram for cBlockLeverHandler:

Static Public Member Functions
static bool	IsLeverOn (NIBBLETYPE a_BlockMeta)
	Extracts the ON bit from metadata and returns if true if it is set. More...

Static Public Member Functions inherited from cBlockHandler
static const cBlockHandler &	For (BLOCKTYPE a_BlockType)

static char	FortuneDiscreteRandom (char a_MinDrop, char a_DefaultMax, unsigned char a_BonusMax, char a_DropCap=25)
	Returns a random number of drops taking into account fortune. More...

static void	NeighborChanged (cChunkInterface &a_ChunkInterface, Vector3i a_NeighborPos, eBlockFace a_WhichNeighbor)
	Notifies the specified neighbor that the current block has changed. More...

static unsigned char	ToolFortuneLevel (const cItem *a_Tool)
	Returns the fortune level of a tool, if it is a valid tool. More...

static bool	ToolHasSilkTouch (const cItem *a_Tool)
	Returns true if the specified tool is valid and has a non-zero silk-touch enchantment. More...

Private Types
using	Super = cMetaRotator< cBlockHandler, 0x07, 0x04, 0x01, 0x03, 0x02, false >

Private Member Functions
virtual bool	CanBeAt (const cChunk &a_Chunk, const Vector3i a_Position, const NIBBLETYPE a_Meta) const override
	Checks if the block can stay at the specified relative coords in the chunk. More...

virtual cItems	ConvertToPickups (const NIBBLETYPE a_BlockMeta, const cItem *const a_Tool) const override
	Returns the pickups that would result if the block was mined by a_Digger using a_Tool. More...

virtual ColourID	GetMapBaseColourID (NIBBLETYPE a_Meta) const override
	Returns the base colour ID of the block, as will be represented on a map, as per documentation: https://minecraft.wiki/w/Map_item_format. More...

virtual bool	IsUseable (void) const override
	Called to check whether this block supports a rclk action. More...

virtual NIBBLETYPE	MetaRotateCCW (NIBBLETYPE a_Meta) const override
	Rotates a given block meta counter-clockwise. More...

virtual NIBBLETYPE	MetaRotateCW (NIBBLETYPE a_Meta) const override
	Rotates a given block meta clockwise. More...

virtual bool	OnUse (cChunkInterface &a_ChunkInterface, cWorldInterface &a_WorldInterface, cPlayer &a_Player, const Vector3i a_BlockPos, eBlockFace a_BlockFace, const Vector3i a_CursorPos) const override
	Called when the user right clicks the block and the block is useable. More...

Static Private Member Functions
static eBlockFace	BlockMetaDataToBlockFace (NIBBLETYPE a_Meta)
	Converts the leve block's meta to the block face of the neighbor to which the lever is attached. More...

Additional Inherited Members
Public Member Functions inherited from cMetaRotator< cBlockHandler, 0x07, 0x04, 0x01, 0x03, 0x02, false >
constexpr	cMetaRotator (BLOCKTYPE a_BlockType)

Public Member Functions inherited from cBlockHandler
virtual bool	CanSustainPlant (BLOCKTYPE a_Plant) const
	Checks whether the block has an effect on growing the plant. More...

constexpr	cBlockHandler (BLOCKTYPE a_BlockType)

void	Check (cChunkInterface &ChunkInterface, cBlockPluginInterface &a_PluginInterface, Vector3i a_RelPos, cChunk &a_Chunk) const
	Called when one of the neighbors gets set; equivalent to MC block update. More...

virtual bool	DoesIgnoreBuildCollision (const cWorld &a_World, const cItem &a_HeldItem, Vector3i a_Position, NIBBLETYPE a_Meta, eBlockFace a_ClickedBlockFace, bool a_ClickedDirectly) const
	Checks if the player can build "inside" this block. More...

virtual cBoundingBox	GetPlacementCollisionBox (BLOCKTYPE a_XM, BLOCKTYPE a_XP, BLOCKTYPE a_YM, BLOCKTYPE a_YP, BLOCKTYPE a_ZM, BLOCKTYPE a_ZP) const
	Returns the relative bounding box that must be entity-free in order for the block to be placed. More...

virtual int	Grow (cChunk &a_Chunk, Vector3i a_RelPos, int a_NumStages=1) const
	Grows this block, if it supports growing, by the specified amount of stages (at most). More...

virtual bool	IsInsideBlock (const Vector3d a_RelPosition, const NIBBLETYPE a_BlockMeta) const
	Tests if a_RelPosition is inside the block, where a_RelPosition is relative to the origin of the block. More...

virtual NIBBLETYPE	MetaMirrorXZ (NIBBLETYPE a_Meta) const
	Mirros a given block meta around the XZ plane. More...

virtual void	OnBroken (cChunkInterface &a_ChunkInterface, cWorldInterface &a_WorldInterface, Vector3i a_BlockPos, BLOCKTYPE a_OldBlockType, NIBBLETYPE a_OldBlockMeta, const cEntity *a_Digger) const
	Called after a block gets broken (replaced with air), by natural means. More...

virtual void	OnCancelRightClick (cChunkInterface &a_ChunkInterface, cWorldInterface &a_WorldInterface, cPlayer &a_Player, const Vector3i a_BlockPos, eBlockFace a_BlockFace) const
	Called when a right click to this block is cancelled. More...

virtual void	OnDigging (cChunkInterface &a_ChunkInterface, cWorldInterface &a_WorldInterface, cPlayer &a_Player, const Vector3i a_BlockPos) const
	Called when the player starts digging the block. More...

virtual void	OnNeighborChanged (cChunkInterface &a_ChunkInterface, Vector3i a_BlockPos, eBlockFace a_WhichNeighbor) const
	Called when a direct neighbor of this block has been changed. More...

virtual void	OnPlaced (cChunkInterface &a_ChunkInterface, cWorldInterface &a_WorldInterface, Vector3i a_BlockPos, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta) const
	Called by cWorld::SetBlock() after the block has been set. More...

virtual void	OnUpdate (cChunkInterface &a_ChunkInterface, cWorldInterface &a_WorldInterface, cBlockPluginInterface &a_BlockPluginInterface, cChunk &a_Chunk, const Vector3i a_RelPos) const
	Called when the block gets ticked either by a random tick or by a queued tick. More...

Protected Member Functions inherited from cMetaRotator< cBlockHandler, 0x07, 0x04, 0x01, 0x03, 0x02, false >
virtual NIBBLETYPE	MetaMirrorXY (NIBBLETYPE a_Meta) const override

virtual NIBBLETYPE	MetaMirrorYZ (NIBBLETYPE a_Meta) const override

	~cMetaRotator ()=default

Protected Member Functions inherited from cBlockHandler
	~cBlockHandler ()=default

Protected Attributes inherited from cBlockHandler
const BLOCKTYPE	m_BlockType

Detailed Description

Definition at line 12 of file BlockLever.h.

Member Typedef Documentation

◆ Super

using cBlockLeverHandler::Super = cMetaRotator<cBlockHandler, 0x07, 0x04, 0x01, 0x03, 0x02, false>

private

Definition at line 15 of file BlockLever.h.

Member Function Documentation

◆ BlockMetaDataToBlockFace()

static eBlockFace cBlockLeverHandler::BlockMetaDataToBlockFace ( NIBBLETYPE a_Meta )

inlinestaticprivate

Converts the leve block's meta to the block face of the neighbor to which the lever is attached.

Definition at line 71 of file BlockLever.h.

◆ CanBeAt()

virtual bool cBlockLeverHandler::CanBeAt	(	const cChunk &	a_Chunk,
		const Vector3i	a_Position,
		const NIBBLETYPE	a_Meta
	)		const

inlineoverrideprivatevirtual

Checks if the block can stay at the specified relative coords in the chunk.

Reimplemented from cBlockHandler.

Definition at line 95 of file BlockLever.h.

◆ ConvertToPickups()

virtual cItems cBlockLeverHandler::ConvertToPickups	(	const NIBBLETYPE	a_BlockMeta,
		const cItem *const	a_Tool
	)		const

inlineoverrideprivatevirtual

Returns the pickups that would result if the block was mined by a_Digger using a_Tool.

Doesn't do any actual block change / mining, only calculates the pickups. a_Digger is the entity that caused the conversion, usually the player digging. a_Tool is the tool used for the digging. The default implementation drops a single item created from m_BlockType and the current meta.

Reimplemented from cBlockHandler.

Definition at line 51 of file BlockLever.h.

◆ GetMapBaseColourID()

virtual ColourID cBlockLeverHandler::GetMapBaseColourID ( NIBBLETYPE a_Meta ) const

inlineoverrideprivatevirtual

Returns the base colour ID of the block, as will be represented on a map, as per documentation: https://minecraft.wiki/w/Map_item_format.

Reimplemented from cBlockHandler.

Definition at line 188 of file BlockLever.h.

◆ IsLeverOn()

static bool cBlockLeverHandler::IsLeverOn ( NIBBLETYPE a_BlockMeta )

inlinestatic

Extracts the ON bit from metadata and returns if true if it is set.

Definition at line 22 of file BlockLever.h.

◆ IsUseable()

virtual bool cBlockLeverHandler::IsUseable ( void ) const

inlineoverrideprivatevirtual

Called to check whether this block supports a rclk action.

If it returns true, OnUse() is called

Reimplemented from cBlockHandler.

Definition at line 61 of file BlockLever.h.

◆ MetaRotateCCW()

virtual NIBBLETYPE cBlockLeverHandler::MetaRotateCCW ( NIBBLETYPE a_Meta ) const

inlineoverrideprivatevirtual

Rotates a given block meta counter-clockwise.

Default: no change Returns block meta following rotation

Reimplemented from cMetaRotator< cBlockHandler, 0x07, 0x04, 0x01, 0x03, 0x02, false >.

Definition at line 152 of file BlockLever.h.

◆ MetaRotateCW()

virtual NIBBLETYPE cBlockLeverHandler::MetaRotateCW ( NIBBLETYPE a_Meta ) const

inlineoverrideprivatevirtual

Rotates a given block meta clockwise.

Default: no change Returns block meta following rotation

Reimplemented from cMetaRotator< cBlockHandler, 0x07, 0x04, 0x01, 0x03, 0x02, false >.

Definition at line 170 of file BlockLever.h.

◆ OnUse()

virtual bool cBlockLeverHandler::OnUse	(	cChunkInterface &	a_ChunkInterface,
		cWorldInterface &	a_WorldInterface,
		cPlayer &	a_Player,
		const Vector3i	a_BlockPos,
		eBlockFace	a_BlockFace,
		const Vector3i	a_CursorPos
	)		const

inlineoverrideprivatevirtual

Called when the user right clicks the block and the block is useable.

a_CursorPos is the cursor position within the clicked block face. Returns true if the use was successful, return false to use the block as a "normal" block

Reimplemented from cBlockHandler.

Definition at line 29 of file BlockLever.h.

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

src/Blocks/BlockLever.h

Static Public Member Functions

Private Types

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ Super

Member Function Documentation

◆ BlockMetaDataToBlockFace()

◆ CanBeAt()

◆ ConvertToPickups()

◆ GetMapBaseColourID()

◆ IsLeverOn()

◆ IsUseable()

◆ MetaRotateCCW()

◆ MetaRotateCW()

◆ OnUse()