BlockHandler.h

Go to the documentation of this file.

#pragma once

#include "../Defines.h"

#include "../BoundingBox.h"





// fwd:
class cPlayer;
class cChunk;
class cBlockPluginInterface;
class cChunkInterface;
class cWorldInterface;
class cItems;
class BlockTypeRegistry;





class cBlockHandler
{
public:
    cBlockHandler(BLOCKTYPE a_BlockType);

    virtual ~cBlockHandler() {}

    virtual void OnUpdate(cChunkInterface & cChunkInterface, cWorldInterface & a_WorldInterface, cBlockPluginInterface & a_BlockPluginInterface, cChunk & a_Chunk, int a_RelX, int a_RelY, int a_RelZ);

    virtual cBoundingBox GetPlacementCollisionBox(BLOCKTYPE a_XM, BLOCKTYPE a_XP, BLOCKTYPE a_YM, BLOCKTYPE a_YP, BLOCKTYPE a_ZM, BLOCKTYPE a_ZP);

    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
    );

    virtual void OnPlaced(cChunkInterface & a_ChunkInterface, cWorldInterface & a_WorldInterface, Vector3i a_BlockPos, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta);

    virtual void OnPlacedByPlayer(
        cChunkInterface & a_ChunkInterface, cWorldInterface & a_WorldInterface, cPlayer & a_Player, const sSetBlock & a_BlockChange
    );

    virtual void OnPlayerBreakingBlock(
        cChunkInterface & a_ChunkInterface, cWorldInterface & a_WorldInterface,
        cPlayer & a_Player,
        Vector3i a_BlockPos
    ) {}

    virtual void OnPlayerBrokeBlock(
        cChunkInterface & a_ChunkInterface, cWorldInterface & a_WorldInterface,
        cPlayer & a_Player,
        Vector3i a_BlockPos,
        BLOCKTYPE a_OldBlockType, NIBBLETYPE a_OldBlockMeta
    ) {}

    virtual void OnBreaking(
        cChunkInterface & a_ChunkInterface, cWorldInterface & a_WorldInterface,
        Vector3i a_BlockPos
    ) {}

    virtual void OnBroken(
        cChunkInterface & a_ChunkInterface, cWorldInterface & a_WorldInterface,
        Vector3i a_BlockPos,
        BLOCKTYPE a_OldBlockType, NIBBLETYPE a_OldBlockMeta
    );

    virtual void OnNeighborChanged(cChunkInterface & a_ChunkInterface, Vector3i a_BlockPos, eBlockFace a_WhichNeighbor) {}

    static void NeighborChanged(cChunkInterface & a_ChunkInterface, Vector3i a_NeighborPos, eBlockFace a_WhichNeighbor);

    virtual void OnDigging(cChunkInterface & cChunkInterface, cWorldInterface & a_WorldInterface, cPlayer & a_Player, int a_BlockX, int a_BlockY, int a_BlockZ) {}

    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) { return false; }

    virtual void OnCancelRightClick(cChunkInterface & a_ChunkInterface, cWorldInterface & a_WorldInterface, cPlayer & a_Player, int a_BlockX, int a_BlockY, int a_BlockZ, eBlockFace a_BlockFace) {}

    virtual cItems ConvertToPickups(
        NIBBLETYPE a_BlockMeta,
        cBlockEntity * a_BlockEntity,
        const cEntity * a_Digger = nullptr,
        const cItem * a_Tool = nullptr
    );

    virtual bool CanBeAt(cChunkInterface & a_ChunkInterface, int a_RelX, int a_RelY, int a_RelZ, const cChunk & a_Chunk);

    virtual bool CanSustainPlant(BLOCKTYPE a_Plant) { return false; }

    // virtual bool CanBePlacedAt(cWorld * a_World, int a_BlockX, int a_BlockY, int a_BlockZ, char a_Dir);

    virtual bool IsUseable(void);

    virtual bool IsClickedThrough(void);

    virtual bool DoesIgnoreBuildCollision(cChunkInterface & ChunkInterface, Vector3i a_Pos, cPlayer & a_Player, NIBBLETYPE a_Meta);

    virtual bool DoesDropOnUnsuitable(void);

    virtual bool IsInsideBlock(Vector3d a_Position, const BLOCKTYPE a_BlockType, const NIBBLETYPE a_BlockMeta);

    virtual void Check(
        cChunkInterface & ChunkInterface, cBlockPluginInterface & a_PluginInterface,
        Vector3i a_RelPos,
        cChunk & a_Chunk
    );

    virtual ColourID GetMapBaseColourID(NIBBLETYPE a_Meta);

    virtual NIBBLETYPE MetaRotateCCW(NIBBLETYPE a_Meta) { return a_Meta; }

    virtual NIBBLETYPE MetaRotateCW(NIBBLETYPE a_Meta) { return a_Meta; }

    virtual NIBBLETYPE MetaMirrorXY(NIBBLETYPE a_Meta) { return a_Meta; }

    virtual NIBBLETYPE MetaMirrorXZ(NIBBLETYPE a_Meta) { return a_Meta; }

    virtual NIBBLETYPE MetaMirrorYZ(NIBBLETYPE a_Meta) { return a_Meta; }

    virtual int Grow(cChunk & a_Chunk, Vector3i a_RelPos, int a_NumStages = 1) { return 0; }

    static bool ToolHasSilkTouch(const cItem * a_Tool);


protected:
    BLOCKTYPE m_BlockType;

    // Creates a new blockhandler for the given block type. For internal use only, use ::GetBlockHandler() instead.
    static cBlockHandler * CreateBlockHandler(BLOCKTYPE a_BlockType);

    friend class cBlockInfo;
};




namespace Temporary
{
    void RegisterAllBlockHandlers(BlockTypeRegistry & aRegistry);
};