Cuberite
A lightweight, fast and extensible game server for Minecraft
Private Types | Private Member Functions | List of all members
cBlockCactusHandler Class Referencefinal

#include <BlockCactus.h>

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

Private Types

using Super = cClearMetaOnDrop< cBlockPlant< 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 PlantAction CanGrow (cChunk &a_Chunk, Vector3i a_RelPos) const override
 Checks whether a plant can grow grow, based on what is returned from cBlockPlant::HasEnoughLight and a random check based on what is returned from cBlockPlant::GetGrowthChance. 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 int Grow (cChunk &a_Chunk, Vector3i a_RelPos, int a_NumStages=1) const override
 Grows this block, if it supports growing, by the specified amount of stages (at most). More...
 

Additional Inherited Members

- Public Member Functions inherited from cClearMetaOnDrop< cBlockPlant< false > >
constexpr cClearMetaOnDrop (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 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 MetaMirrorXY (NIBBLETYPE a_Meta) const
 Mirrors a given block meta around the XY plane. More...
 
virtual NIBBLETYPE MetaMirrorXZ (NIBBLETYPE a_Meta) const
 Mirros a given block meta around the XZ plane. More...
 
virtual NIBBLETYPE MetaMirrorYZ (NIBBLETYPE a_Meta) const
 Mirros a given block meta around the YZ plane. More...
 
virtual NIBBLETYPE MetaRotateCCW (NIBBLETYPE a_Meta) const
 Rotates a given block meta counter-clockwise. More...
 
virtual NIBBLETYPE MetaRotateCW (NIBBLETYPE a_Meta) const
 Rotates a given block meta clockwise. 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 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...
 
- 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 Types inherited from cBlockPlant< false >
enum  PlantAction
 The action the plant can take on an update. More...
 
- Protected Member Functions inherited from cClearMetaOnDrop< cBlockPlant< false > >
 ~cClearMetaOnDrop ()=default
 
- Protected Member Functions inherited from cBlockPlant< false >
virtual int GetGrowthChance (cChunk &a_Chunk, Vector3i a_RelPos) const
 Generates an int value between 4 and 25 based on surrounding blocks that affect how quickly the plant grows. More...
 
 ~cBlockPlant ()=default
 
- Protected Member Functions inherited from cBlockHandler
 ~cBlockHandler ()=default
 
- Static Protected Member Functions inherited from cBlockPlant< false >
static PlantAction HasEnoughLight (cChunk &a_Chunk, Vector3i a_RelPos)
 Checks whether there is enough light for the plant to grow. More...
 
- Protected Attributes inherited from cBlockHandler
const BLOCKTYPE m_BlockType
 

Detailed Description

Definition at line 10 of file BlockCactus.h.

Member Typedef Documentation

◆ Super

Definition at line 13 of file BlockCactus.h.

Member Function Documentation

◆ CanBeAt()

virtual bool cBlockCactusHandler::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 21 of file BlockCactus.h.

◆ CanGrow()

virtual PlantAction cBlockCactusHandler::CanGrow ( cChunk a_Chunk,
Vector3i  a_RelPos 
) const
inlineoverrideprivatevirtual

Checks whether a plant can grow grow, based on what is returned from cBlockPlant::HasEnoughLight and a random check based on what is returned from cBlockPlant::GetGrowthChance.

Can return three values. paGrowth when the conditions are right for the plant to grow. paStay when the conditions are not quite right. paDeath is returned when there isn't enough light for the plant to survive. Plants that don't require light will never have a paDeath returned

Reimplemented from cBlockPlant< false >.

Definition at line 143 of file BlockCactus.h.

◆ GetMapBaseColourID()

virtual ColourID cBlockCactusHandler::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 66 of file BlockCactus.h.

◆ Grow()

virtual int cBlockCactusHandler::Grow ( cChunk a_Chunk,
Vector3i  a_RelPos,
int  a_NumStages = 1 
) const
inlineoverrideprivatevirtual

Grows this block, if it supports growing, by the specified amount of stages (at most).

Returns the number of stages actually grown, zero if not supported (default).

Reimplemented from cBlockHandler.

Definition at line 75 of file BlockCactus.h.


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