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

#include <BlockRail.h>

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

Public Member Functions

virtual bool CanBeAt (cChunkInterface &a_ChunkInterface, int a_RelX, int a_RelY, int a_RelZ, const cChunk &a_Chunk) override
 Checks if the block can stay at the specified relative coords in the chunk. More...
 
bool CanThisRailCurve (void)
 
 cBlockRailHandler (BLOCKTYPE a_BlockType)
 
NIBBLETYPE FindMeta (cChunkInterface &a_ChunkInterface, Vector3i a_BlockPos)
 
virtual ColourID GetMapBaseColourID (NIBBLETYPE a_Meta) override
 Returns the base colour ID of the block, as will be represented on a map, as per documentation: https://minecraft.gamepedia.com/Map_item_format. More...
 
virtual bool GetPlacementBlockTypeMeta (cChunkInterface &a_ChunkInterface, cPlayer &a_Player, int a_BlockX, int a_BlockY, int a_BlockZ, eBlockFace a_BlockFace, int a_CursorX, int a_CursorY, int a_CursorZ, BLOCKTYPE &a_BlockType, NIBBLETYPE &a_BlockMeta) override
 Called before a block is placed into a world. More...
 
bool IsNotConnected (cChunkInterface &a_ChunkInterface, Vector3i a_Pos, eBlockFace a_BlockFace, char a_Pure=0)
 
bool IsUnstable (cChunkInterface &a_ChunkInterface, Vector3i a_Pos)
 
virtual NIBBLETYPE MetaMirrorXY (NIBBLETYPE a_Meta) override
 Mirrors a given block meta around the XY plane. More...
 
virtual NIBBLETYPE MetaMirrorYZ (NIBBLETYPE a_Meta) override
 Mirros a given block meta around the YZ plane. More...
 
virtual NIBBLETYPE MetaRotateCCW (NIBBLETYPE a_Meta) override
 Rotates a given block meta counter-clockwise. More...
 
virtual NIBBLETYPE MetaRotateCW (NIBBLETYPE a_Meta) override
 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) override
 Called after a block gets broken (replaced with air), either by player or by natural means. More...
 
virtual void OnNeighborChanged (cChunkInterface &a_ChunkInterface, Vector3i a_BlockPos, eBlockFace a_WhichNeighbor) override
 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) override
 Called by cWorld::SetBlock() after the block has been set. More...
 
- Public Member Functions inherited from cClearMetaOnDrop< cBlockHandler >
 cClearMetaOnDrop (BLOCKTYPE a_BlockType)
 
virtual cItems ConvertToPickups (NIBBLETYPE a_BlockMeta, cBlockEntity *a_BlockEntity, const cEntity *a_Digger, const cItem *a_Tool) override
 
- Public Member Functions inherited from cBlockHandler
virtual bool CanSustainPlant (BLOCKTYPE a_Plant)
 Checks whether the block has an effect on growing the plant. More...
 
 cBlockHandler (BLOCKTYPE a_BlockType)
 
virtual void Check (cChunkInterface &ChunkInterface, cBlockPluginInterface &a_PluginInterface, Vector3i a_RelPos, cChunk &a_Chunk)
 Called when one of the neighbors gets set; equivalent to MC block update. More...
 
virtual bool DoesDropOnUnsuitable (void)
 Returns if this block drops if it gets destroyed by an unsuitable situation. More...
 
virtual bool DoesIgnoreBuildCollision (cChunkInterface &ChunkInterface, Vector3i a_Pos, cPlayer &a_Player, NIBBLETYPE a_Meta)
 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)
 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)
 Grows this block, if it supports growing, by the specified amount of stages (at most). More...
 
virtual bool IsClickedThrough (void)
 Indicates whether the client will click through this block. More...
 
virtual bool IsInsideBlock (Vector3d a_Position, const BLOCKTYPE a_BlockType, const NIBBLETYPE a_BlockMeta)
 Tests if a_Position is inside the block where a_Position is relative to the origin of the block Note that this is considered from a "top-down" perspective i.e. More...
 
virtual bool IsUseable (void)
 Checks if the block can be placed at this point. More...
 
virtual NIBBLETYPE MetaMirrorXZ (NIBBLETYPE a_Meta)
 Mirros a given block meta around the XZ plane. More...
 
virtual void OnBreaking (cChunkInterface &a_ChunkInterface, cWorldInterface &a_WorldInterface, Vector3i a_BlockPos)
 Called before a block gets broken (replaced with air), either by player or by natural means. More...
 
virtual void OnCancelRightClick (cChunkInterface &a_ChunkInterface, cWorldInterface &a_WorldInterface, cPlayer &a_Player, int a_BlockX, int a_BlockY, int a_BlockZ, eBlockFace a_BlockFace)
 Called when a right click to this block is cancelled. More...
 
virtual void OnDigging (cChunkInterface &cChunkInterface, cWorldInterface &a_WorldInterface, cPlayer &a_Player, int a_BlockX, int a_BlockY, int a_BlockZ)
 Called when the player starts digging the block. More...
 
virtual void OnPlacedByPlayer (cChunkInterface &a_ChunkInterface, cWorldInterface &a_WorldInterface, cPlayer &a_Player, const sSetBlock &a_BlockChange)
 Called by cPlayer::PlaceBlocks() for each block after it has been set to the world. More...
 
virtual void OnPlayerBreakingBlock (cChunkInterface &a_ChunkInterface, cWorldInterface &a_WorldInterface, cPlayer &a_Player, Vector3i a_BlockPos)
 Called just before the player breaks the block. More...
 
virtual void OnPlayerBrokeBlock (cChunkInterface &a_ChunkInterface, cWorldInterface &a_WorldInterface, cPlayer &a_Player, Vector3i a_BlockPos, BLOCKTYPE a_OldBlockType, NIBBLETYPE a_OldBlockMeta)
 Called just after the player breaks the block. More...
 
virtual void OnUpdate (cChunkInterface &cChunkInterface, cWorldInterface &a_WorldInterface, cBlockPluginInterface &a_BlockPluginInterface, cChunk &a_Chunk, int a_RelX, int a_RelY, int a_RelZ)
 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, int a_BlockX, int a_BlockY, int a_BlockZ, eBlockFace a_BlockFace, int a_CursorX, int a_CursorY, int a_CursorZ)
 Called if the user right clicks the block and the block is useable returns true if the use was successful, return false to use the block as a "normal" block. More...
 
virtual ~cBlockHandler ()
 

Private Types

using super = cClearMetaOnDrop< cBlockHandler >
 

Additional Inherited Members

- Static Public Member Functions inherited from cBlockHandler
static void NeighborChanged (cChunkInterface &a_ChunkInterface, Vector3i a_NeighborPos, eBlockFace a_WhichNeighbor)
 Notifies the specified neighbor that the current block has changed. 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...
 
- Static Protected Member Functions inherited from cBlockHandler
static cBlockHandlerCreateBlockHandler (BLOCKTYPE a_BlockType)
 
- Protected Attributes inherited from cBlockHandler
BLOCKTYPE m_BlockType
 

Detailed Description

Definition at line 19 of file BlockRail.h.

Member Typedef Documentation

Definition at line 22 of file BlockRail.h.

Constructor & Destructor Documentation

cBlockRailHandler::cBlockRailHandler ( BLOCKTYPE  a_BlockType)
inline

Definition at line 26 of file BlockRail.h.

Member Function Documentation

virtual bool cBlockRailHandler::CanBeAt ( cChunkInterface a_ChunkInterface,
int  a_RelX,
int  a_RelY,
int  a_RelZ,
const cChunk a_Chunk 
)
inlineoverridevirtual

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

Reimplemented from cBlockHandler.

Definition at line 114 of file BlockRail.h.

bool cBlockRailHandler::CanThisRailCurve ( void  )
inline

Definition at line 282 of file BlockRail.h.

NIBBLETYPE cBlockRailHandler::FindMeta ( cChunkInterface a_ChunkInterface,
Vector3i  a_BlockPos 
)
inline

Definition at line 158 of file BlockRail.h.

virtual ColourID cBlockRailHandler::GetMapBaseColourID ( NIBBLETYPE  a_Meta)
inlineoverridevirtual

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

Reimplemented from cBlockHandler.

Definition at line 671 of file BlockRail.h.

virtual bool cBlockRailHandler::GetPlacementBlockTypeMeta ( cChunkInterface a_ChunkInterface,
cPlayer a_Player,
int  a_BlockX,
int  a_BlockY,
int  a_BlockZ,
eBlockFace  a_BlockFace,
int  a_CursorX,
int  a_CursorY,
int  a_CursorZ,
BLOCKTYPE a_BlockType,
NIBBLETYPE a_BlockMeta 
)
inlineoverridevirtual

Called before a block is placed into a world.

The handler should return true to allow placement, false to refuse. Also, the handler should set a_BlockType and a_BlockMeta to correct values for the newly placed block. Called by cItemHandler::GetPlacementBlockTypeMeta() if the item is a block

Reimplemented from cBlockHandler.

Definition at line 31 of file BlockRail.h.

bool cBlockRailHandler::IsNotConnected ( cChunkInterface a_ChunkInterface,
Vector3i  a_Pos,
eBlockFace  a_BlockFace,
char  a_Pure = 0 
)
inline

Definition at line 419 of file BlockRail.h.

bool cBlockRailHandler::IsUnstable ( cChunkInterface a_ChunkInterface,
Vector3i  a_Pos 
)
inline

Definition at line 287 of file BlockRail.h.

virtual NIBBLETYPE cBlockRailHandler::MetaMirrorXY ( NIBBLETYPE  a_Meta)
inlineoverridevirtual

Mirrors a given block meta around the XY plane.

Default: no change Returns block meta following rotation

Reimplemented from cBlockHandler.

Definition at line 591 of file BlockRail.h.

virtual NIBBLETYPE cBlockRailHandler::MetaMirrorYZ ( NIBBLETYPE  a_Meta)
inlineoverridevirtual

Mirros a given block meta around the YZ plane.

Default: no change Returns block meta following rotation

Reimplemented from cBlockHandler.

Definition at line 631 of file BlockRail.h.

virtual NIBBLETYPE cBlockRailHandler::MetaRotateCCW ( NIBBLETYPE  a_Meta)
inlineoverridevirtual

Rotates a given block meta counter-clockwise.

Default: no change Returns block meta following rotation

Reimplemented from cBlockHandler.

Definition at line 516 of file BlockRail.h.

virtual NIBBLETYPE cBlockRailHandler::MetaRotateCW ( NIBBLETYPE  a_Meta)
inlineoverridevirtual

Rotates a given block meta clockwise.

Default: no change Returns block meta following rotation

Reimplemented from cBlockHandler.

Definition at line 554 of file BlockRail.h.

virtual void cBlockRailHandler::OnBroken ( cChunkInterface a_ChunkInterface,
cWorldInterface a_WorldInterface,
Vector3i  a_BlockPos,
BLOCKTYPE  a_OldBlockType,
NIBBLETYPE  a_OldBlockMeta 
)
inlineoverridevirtual

Called after a block gets broken (replaced with air), either by player or by natural means.

If by player, it is called before the OnPlayerBrokeBlock() callback. The block is already dug up in the world, the original block type and meta is passed in a_OldBlockType and a_OldBlockMeta. By default notifies all direct neighbors via their OnNeighborChanged() callbacks.

Reimplemented from cBlockHandler.

Definition at line 77 of file BlockRail.h.

virtual void cBlockRailHandler::OnNeighborChanged ( cChunkInterface a_ChunkInterface,
Vector3i  a_BlockPos,
eBlockFace  a_WhichNeighbor 
)
inlineoverridevirtual

Called when a direct neighbor of this block has been changed.

The position is the block's own position, NOT the changed neighbor's position. a_WhichNeighbor indicates which neighbor has changed. For example, BLOCK_FACE_YP meant the neighbor above has changed. BLOCK_FACE_NONE means that it is a neighbor not directly adjacent (diagonal, etc.)

Reimplemented from cBlockHandler.

Definition at line 100 of file BlockRail.h.

virtual void cBlockRailHandler::OnPlaced ( cChunkInterface a_ChunkInterface,
cWorldInterface a_WorldInterface,
Vector3i  a_BlockPos,
BLOCKTYPE  a_BlockType,
NIBBLETYPE  a_BlockMeta 
)
inlineoverridevirtual

Called by cWorld::SetBlock() after the block has been set.

Reimplemented from cBlockHandler.

Definition at line 54 of file BlockRail.h.


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