Cuberite
A lightweight, fast and extensible game server for Minecraft
Static Public Member Functions | Protected Member Functions | Private Types | Private Member Functions | Static Private Member Functions | List of all members
cBlockTorchBaseHandler Class Reference

#include <BlockTorch.h>

Inheritance diagram for cBlockTorchBaseHandler:
Inheritance graph
[legend]
Collaboration diagram for cBlockTorchBaseHandler:
Collaboration graph
[legend]

Static Public Member Functions

static bool CanBePlacedOn (BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta, eBlockFace a_BlockFace)
 Returns true if the torch can be placed on the specified block's face. More...
 
- Static Public Member Functions inherited from cBlockHandler
static const cBlockHandlerFor (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...
 

Protected Member Functions

 ~cBlockTorchBaseHandler ()=default
 
- Protected Member Functions inherited from cMetaRotator< cBlockHandler, 0x7, 0x4, 0x1, 0x3, 0x2 >
virtual NIBBLETYPE MetaMirrorXY (NIBBLETYPE a_Meta) const override
 
virtual NIBBLETYPE MetaMirrorYZ (NIBBLETYPE a_Meta) const override
 
virtual NIBBLETYPE MetaRotateCCW (NIBBLETYPE a_Meta) const override
 
virtual NIBBLETYPE MetaRotateCW (NIBBLETYPE a_Meta) const override
 
 ~cMetaRotator ()=default
 
- Protected Member Functions inherited from cBlockHandler
 ~cBlockHandler ()=default
 

Private Types

using Super = cMetaRotator< cBlockHandler, 0x7, 0x4, 0x1, 0x3, 0x2 >
 

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 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...
 

Static Private Member Functions

static eBlockFace MetaDataToBlockFace (NIBBLETYPE a_MetaData)
 Converts the torch block's meta to the block face of the neighbor to which the torch is attached. More...
 

Additional Inherited Members

- Public Member Functions inherited from cMetaRotator< cBlockHandler, 0x7, 0x4, 0x1, 0x3, 0x2 >
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 cItems ConvertToPickups (NIBBLETYPE a_BlockMeta, const cItem *a_Tool=nullptr) const
 Returns the pickups that would result if the block was mined by a_Digger using a_Tool. 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 bool IsUseable (void) const
 Called to check whether this block supports a rclk action. 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...
 
virtual bool OnUse (cChunkInterface &a_ChunkInterface, cWorldInterface &a_WorldInterface, cPlayer &a_Player, const Vector3i a_BlockPos, eBlockFace a_BlockFace, const Vector3i a_CursorPos) const
 Called when the user right clicks the block and the block is useable. More...
 
- Protected Attributes inherited from cBlockHandler
const BLOCKTYPE m_BlockType
 

Detailed Description

Definition at line 16 of file BlockTorch.h.

Member Typedef Documentation

◆ Super

using cBlockTorchBaseHandler::Super = cMetaRotator<cBlockHandler, 0x7, 0x4, 0x1, 0x3, 0x2>
private

Definition at line 19 of file BlockTorch.h.

Constructor & Destructor Documentation

◆ ~cBlockTorchBaseHandler()

cBlockTorchBaseHandler::~cBlockTorchBaseHandler ( )
protecteddefault

Member Function Documentation

◆ CanBeAt()

virtual bool cBlockTorchBaseHandler::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 121 of file BlockTorch.h.

◆ CanBePlacedOn()

static bool cBlockTorchBaseHandler::CanBePlacedOn ( BLOCKTYPE  a_BlockType,
NIBBLETYPE  a_BlockMeta,
eBlockFace  a_BlockFace 
)
inlinestatic

Returns true if the torch can be placed on the specified block's face.

Definition at line 27 of file BlockTorch.h.

◆ GetMapBaseColourID()

virtual ColourID cBlockTorchBaseHandler::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.

Reimplemented in cBlockRedstoneTorchHandler.

Definition at line 140 of file BlockTorch.h.

◆ MetaDataToBlockFace()

static eBlockFace cBlockTorchBaseHandler::MetaDataToBlockFace ( NIBBLETYPE  a_MetaData)
inlinestaticprivate

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

Definition at line 98 of file BlockTorch.h.


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