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

#include <BlockRedstoneRepeater.h>

Inheritance diagram for cBlockRedstoneRepeaterHandler:
Inheritance graph
[legend]
Collaboration diagram for cBlockRedstoneRepeaterHandler:
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...
 
 cBlockRedstoneRepeaterHandler (BLOCKTYPE a_BlockType)
 
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...
 
virtual bool IsUseable (void) override
 Checks if the block can be placed at this point. 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) override
 Called when a right click to this block is cancelled. 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) override
 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...
 
- Public Member Functions inherited from cClearMetaOnDrop< cMetaRotator< cBlockHandler, 0x03, 0x00, 0x01, 0x02, 0x03, true > >
 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 cMetaRotator< cBlockHandler, 0x03, 0x00, 0x01, 0x02, 0x03, true >
 cMetaRotator (BLOCKTYPE a_BlockType)
 
virtual NIBBLETYPE MetaMirrorXY (NIBBLETYPE a_Meta) override
 
virtual NIBBLETYPE MetaMirrorYZ (NIBBLETYPE a_Meta) override
 
virtual NIBBLETYPE MetaRotateCCW (NIBBLETYPE a_Meta) override
 
virtual NIBBLETYPE MetaRotateCW (NIBBLETYPE a_Meta) 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 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 OnBroken (cChunkInterface &a_ChunkInterface, cWorldInterface &a_WorldInterface, Vector3i a_BlockPos, BLOCKTYPE a_OldBlockType, NIBBLETYPE a_OldBlockMeta)
 Called after a block gets broken (replaced with air), either by player or by natural means. 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 OnNeighborChanged (cChunkInterface &a_ChunkInterface, Vector3i a_BlockPos, eBlockFace a_WhichNeighbor)
 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)
 Called by cWorld::SetBlock() after the block has been set. 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 ~cBlockHandler ()
 

Static Public Member Functions

static Vector3i GetFrontCoordinateOffset (NIBBLETYPE a_Meta)
 
static Vector3i GetRearCoordinateOffset (NIBBLETYPE a_Meta)
 
static NIBBLETYPE RepeaterRotationToMetaData (double a_Rotation)
 
- 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...
 

Private Types

using super = cClearMetaOnDrop< cMetaRotator< cBlockHandler, 0x03, 0x00, 0x01, 0x02, 0x03, true >>
 

Additional Inherited Members

- 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 14 of file BlockRedstoneRepeater.h.

Member Typedef Documentation

using cBlockRedstoneRepeaterHandler::super = cClearMetaOnDrop<cMetaRotator<cBlockHandler, 0x03, 0x00, 0x01, 0x02, 0x03, true>>
private

Definition at line 17 of file BlockRedstoneRepeater.h.

Constructor & Destructor Documentation

cBlockRedstoneRepeaterHandler::cBlockRedstoneRepeaterHandler ( BLOCKTYPE  a_BlockType)
inline

Definition at line 21 of file BlockRedstoneRepeater.h.

Member Function Documentation

virtual bool cBlockRedstoneRepeaterHandler::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 55 of file BlockRedstoneRepeater.h.

static Vector3i cBlockRedstoneRepeaterHandler::GetFrontCoordinateOffset ( NIBBLETYPE  a_Meta)
inlinestatic

Definition at line 132 of file BlockRedstoneRepeater.h.

virtual ColourID cBlockRedstoneRepeaterHandler::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 107 of file BlockRedstoneRepeater.h.

virtual bool cBlockRedstoneRepeaterHandler::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 26 of file BlockRedstoneRepeater.h.

static Vector3i cBlockRedstoneRepeaterHandler::GetRearCoordinateOffset ( NIBBLETYPE  a_Meta)
inlinestatic

Definition at line 114 of file BlockRedstoneRepeater.h.

virtual bool cBlockRedstoneRepeaterHandler::IsUseable ( void  )
inlineoverridevirtual

Checks if the block can be placed at this point.

Default: CanBeAt(...) NOTE: This call doesn't actually place the block Called to check whether this block supports a rclk action. If it returns true, OnUse() is called

Reimplemented from cBlockHandler.

Definition at line 50 of file BlockRedstoneRepeater.h.

virtual void cBlockRedstoneRepeaterHandler::OnCancelRightClick ( cChunkInterface a_ChunkInterface,
cWorldInterface a_WorldInterface,
cPlayer a_Player,
int  a_BlockX,
int  a_BlockY,
int  a_BlockZ,
eBlockFace  a_BlockFace 
)
inlineoverridevirtual

Called when a right click to this block is cancelled.

It forces the server to send the real state of a block to the client to prevent client assuming the operation is successfull

Reimplemented from cBlockHandler.

Definition at line 44 of file BlockRedstoneRepeater.h.

virtual bool cBlockRedstoneRepeaterHandler::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 
)
inlineoverridevirtual

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.

Reimplemented from cBlockHandler.

Definition at line 38 of file BlockRedstoneRepeater.h.

static NIBBLETYPE cBlockRedstoneRepeaterHandler::RepeaterRotationToMetaData ( double  a_Rotation)
inlinestatic

Definition at line 81 of file BlockRedstoneRepeater.h.


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