ChunkDesc.h

Go to the documentation of this file.

// ChunkDesc.h

// Declares the cChunkDesc class representing the chunk description used while generating a chunk. This class is also exported to Lua for HOOK_CHUNK_GENERATING.





#pragma once

#include "../BlockArea.h"
#include "../Cuboid.h"





// fwd: ../BlockArea.h
class cBlockArea;





// tolua_begin
class cChunkDesc
{
public:
    // tolua_end

    typedef Byte Shape[256 * 16 * 16];

    typedef NIBBLETYPE BlockNibbleBytes[cChunkDef::NumBlocks];


    cChunkDesc(cChunkCoords a_Coords);
    ~cChunkDesc();

    void SetChunkCoords(cChunkCoords a_Coords);

    // tolua_begin

    int GetChunkX() const { return m_Coords.m_ChunkX; }  // Prefer GetChunkCoords() instead
    int GetChunkZ() const { return m_Coords.m_ChunkZ; }  // Prefer GetChunkCoords() instead

    // tolua_end

    cChunkCoords GetChunkCoords() const { return m_Coords; }

    // tolua_begin

    void       FillBlocks(BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta);
    void       SetBlockTypeMeta(int a_RelX, int a_RelY, int a_RelZ, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta);

    // tolua_end
    void GetBlockTypeMeta(int a_RelX, int a_RelY, int a_RelZ, BLOCKTYPE & a_BlockType, NIBBLETYPE & a_BlockMeta) const;
    // tolua_begin

    void       SetBlockType(int a_RelX, int a_RelY, int a_RelZ, BLOCKTYPE a_BlockType);
    BLOCKTYPE  GetBlockType(int a_RelX, int a_RelY, int a_RelZ) const;

    void       SetBlockMeta(int a_RelX, int a_RelY, int a_RelZ, NIBBLETYPE a_BlockMeta);
    NIBBLETYPE GetBlockMeta(int a_RelX, int a_RelY, int a_RelZ) const;

    void       SetBiome(int a_RelX, int a_RelZ, EMCSBiome a_BiomeID);
    EMCSBiome  GetBiome(int a_RelX, int a_RelZ) const;

    // These operate on the heightmap, so they could get out of sync with the data
    // Use UpdateHeightmap() to re-calculate heightmap from the block data
    void       SetHeight(int a_RelX, int a_RelZ, HEIGHTTYPE a_Height);
    HEIGHTTYPE GetHeight(int a_RelX, int a_RelZ) const;

    // tolua_end

    void SetHeightFromShape(const Shape & a_Shape);

    void GetShapeFromHeight(Shape & a_Shape) const;

    // tolua_begin

    // Default generation:
    void SetUseDefaultBiomes(bool a_bUseDefaultBiomes);
    bool IsUsingDefaultBiomes(void) const;
    void SetUseDefaultHeight(bool a_bUseDefaultHeight);
    bool IsUsingDefaultHeight(void) const;
    void SetUseDefaultComposition(bool a_bUseDefaultComposition);
    bool IsUsingDefaultComposition(void) const;
    void SetUseDefaultFinish(bool a_bUseDefaultFinish);
    bool IsUsingDefaultFinish(void) const;

    void WriteBlockArea(const cBlockArea & a_BlockArea, int a_RelX, int a_RelY, int a_RelZ, cBlockArea::eMergeStrategy a_MergeStrategy = cBlockArea::msOverwrite);

    void ReadBlockArea(cBlockArea & a_Dest, int a_MinRelX, int a_MaxRelX, int a_MinRelY, int a_MaxRelY, int a_MinRelZ, int a_MaxRelZ);

    HEIGHTTYPE GetMaxHeight(void) const;

    HEIGHTTYPE GetMinHeight(void) const;

    void FillRelCuboid(
        int a_MinX, int a_MaxX,
        int a_MinY, int a_MaxY,
        int a_MinZ, int a_MaxZ,
        BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta
    );

    void FillRelCuboid(const cCuboid & a_RelCuboid, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta)
    {
        FillRelCuboid(
            a_RelCuboid.p1.x, a_RelCuboid.p2.x,
            a_RelCuboid.p1.y, a_RelCuboid.p2.y,
            a_RelCuboid.p1.z, a_RelCuboid.p2.z,
            a_BlockType, a_BlockMeta
        );
    }

    void ReplaceRelCuboid(
        int a_MinX, int a_MaxX,
        int a_MinY, int a_MaxY,
        int a_MinZ, int a_MaxZ,
        BLOCKTYPE a_SrcType, NIBBLETYPE a_SrcMeta,
        BLOCKTYPE a_DstType, NIBBLETYPE a_DstMeta
    );

    void ReplaceRelCuboid(
        const cCuboid & a_RelCuboid,
        BLOCKTYPE a_SrcType, NIBBLETYPE a_SrcMeta,
        BLOCKTYPE a_DstType, NIBBLETYPE a_DstMeta
    )
    {
        ReplaceRelCuboid(
            a_RelCuboid.p1.x, a_RelCuboid.p2.x,
            a_RelCuboid.p1.y, a_RelCuboid.p2.y,
            a_RelCuboid.p1.z, a_RelCuboid.p2.z,
            a_SrcType, a_SrcMeta,
            a_DstType, a_DstMeta
        );
    }

    void FloorRelCuboid(
        int a_MinX, int a_MaxX,
        int a_MinY, int a_MaxY,
        int a_MinZ, int a_MaxZ,
        BLOCKTYPE a_DstType, NIBBLETYPE a_DstMeta
    );

    void FloorRelCuboid(
        const cCuboid & a_RelCuboid,
        BLOCKTYPE a_DstType, NIBBLETYPE a_DstMeta
    )
    {
        FloorRelCuboid(
            a_RelCuboid.p1.x, a_RelCuboid.p2.x,
            a_RelCuboid.p1.y, a_RelCuboid.p2.y,
            a_RelCuboid.p1.z, a_RelCuboid.p2.z,
            a_DstType, a_DstMeta
        );
    }

    void RandomFillRelCuboid(
        int a_MinX, int a_MaxX,
        int a_MinY, int a_MaxY,
        int a_MinZ, int a_MaxZ,
        BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta,
        int a_RandomSeed, int a_ChanceOutOf10k
    );

    void RandomFillRelCuboid(
        const cCuboid & a_RelCuboid, BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta,
        int a_RandomSeed, int a_ChanceOutOf10k
    )
    {
        RandomFillRelCuboid(
            a_RelCuboid.p1.x, a_RelCuboid.p2.x,
            a_RelCuboid.p1.y, a_RelCuboid.p2.y,
            a_RelCuboid.p1.z, a_RelCuboid.p2.z,
            a_BlockType, a_BlockMeta,
            a_RandomSeed, a_ChanceOutOf10k
        );
    }

    cBlockEntity * GetBlockEntity(int a_RelX, int a_RelY, int a_RelZ);

    void UpdateHeightmap(void);

    // tolua_end

    // Accessors used by cChunkGenerator::Generator descendants:
    inline cChunkDef::BiomeMap &     GetBiomeMap              (void) { return m_BiomeMap; }
    inline cChunkDef::BlockTypes &   GetBlockTypes            (void) { return *(reinterpret_cast<cChunkDef::BlockTypes *>(m_BlockArea.GetBlockTypes())); }
    // CANNOT, different compression!
    // inline cChunkDef::BlockNibbles & GetBlockMetas            (void) { return *((cChunkDef::BlockNibbles *)m_BlockArea.GetBlockMetas()); }
    inline BlockNibbleBytes &        GetBlockMetasUncompressed(void) { return *(reinterpret_cast<BlockNibbleBytes *>(m_BlockArea.GetBlockMetas())); }
    inline cChunkDef::HeightMap &    GetHeightMap             (void) { return m_HeightMap; }
    inline cEntityList &             GetEntities              (void) { return m_Entities; }
    inline cBlockEntities &          GetBlockEntities         (void) { return m_BlockEntities; }

    inline const cChunkDef::BiomeMap &     GetBiomeMap()   const { return m_BiomeMap; }
    inline const cChunkDef::BlockTypes &   GetBlockTypes() const { return *(reinterpret_cast<cChunkDef::BlockTypes *>(m_BlockArea.GetBlockTypes())); }
    inline const cChunkDef::HeightMap &    GetHeightMap()  const { return m_HeightMap; }

    void CompressBlockMetas(cChunkDef::BlockNibbles & a_DestMetas);

    #ifdef _DEBUG

    void VerifyHeightmap(void);
    #endif  // _DEBUG

private:
    cChunkCoords m_Coords;

    cChunkDef::BiomeMap     m_BiomeMap;
    cBlockArea              m_BlockArea;
    cChunkDef::HeightMap    m_HeightMap;
    cEntityList             m_Entities;
    cBlockEntities          m_BlockEntities;  // Individual block entities are NOT owned by this object!

    bool m_bUseDefaultBiomes;
    bool m_bUseDefaultHeight;
    bool m_bUseDefaultComposition;
    bool m_bUseDefaultFinish;
} ;  // tolua_export