ItemHandler.h

Go to the documentation of this file.

#pragma once

#include "../Defines.h"
#include "../Item.h"





// fwd:
class cWorld;
class cPlayer;
class cBlockPluginInterface;





class cItemHandler
{
public:

    enum eDurabilityLostAction
    {
        dlaAttackEntity,
        dlaBreakBlock,
        dlaBreakBlockInstant,
    };

    cItemHandler(int a_ItemType);

    virtual ~cItemHandler() {}


    virtual bool OnPlayerPlace(
        cWorld & a_World, cPlayer & a_Player, const cItem & a_EquippedItem,
        int a_BlockX, int a_BlockY, int a_BlockZ, eBlockFace a_BlockFace,
        int a_CursorX, int a_CursorY, int a_CursorZ
    );


    virtual bool GetBlocksToPlace(
        cWorld & a_World, cPlayer & a_Player, const cItem & a_EquippedItem,
        int a_BlockX, int a_BlockY, int a_BlockZ, eBlockFace a_BlockFace,
        int a_CursorX, int a_CursorY, int a_CursorZ,
        sSetBlockVector & a_BlocksToSet
    );


    virtual bool GetPlacementBlockTypeMeta(
        cWorld * a_World, 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 bool OnItemUse(
        cWorld * a_World, cPlayer * a_Player, cBlockPluginInterface & a_PluginInterface, const cItem & a_Item,
        int a_BlockX, int a_BlockY, int a_BlockZ, eBlockFace a_BlockFace
    );


    virtual void OnItemShoot(cPlayer *, int a_BlockX, int a_BlockY, int a_BlockZ, eBlockFace a_BlockFace)
    {
        UNUSED(a_BlockX);
        UNUSED(a_BlockY);
        UNUSED(a_BlockZ);
        UNUSED(a_BlockFace);
    }

    virtual void OnUpdate(cWorld * a_World, cPlayer * a_Player, const cItem & a_Item)
    {
        UNUSED(a_World);
        UNUSED(a_Player);
        UNUSED(a_Item);
    }

    virtual bool OnDiggingBlock(cWorld * a_World, cPlayer * a_Player, const cItem & a_HeldItem, int a_BlockX, int a_BlockY, int a_BlockZ, eBlockFace a_BlockFace);

    virtual void OnEntityAttack(cPlayer * a_Attacker, cEntity * a_AttackedEntity);

    virtual void OnFoodEaten(cWorld *a_World, cPlayer *a_Player, cItem *a_Item);

    virtual short GetDurabilityLossByAction(eDurabilityLostAction a_Action);

    virtual char GetMaxStackSize(void);

    struct FoodInfo
    {
        int    FoodLevel;
        double Saturation;

        FoodInfo(int a_FoodLevel, double a_Saturation) :
            FoodLevel(a_FoodLevel),
            Saturation(a_Saturation)
        {
        }
    } ;

    virtual FoodInfo GetFoodInfo(const cItem * a_Item);

    virtual bool EatItem(cPlayer * a_Player, cItem * a_Item);

    virtual bool IsTool(void);

    virtual bool IsFood(void);

    virtual bool IsDrinkable(short a_ItemDamage);

    virtual bool IsPlaceable(void);

    virtual bool CanRepairWithRawMaterial(short a_ItemType);

    virtual bool CanHarvestBlock(BLOCKTYPE a_BlockType);

    virtual float GetBlockBreakingStrength(BLOCKTYPE a_Block);

    static cItemHandler * GetItemHandler(int a_ItemType);
    static cItemHandler * GetItemHandler(const cItem & a_Item) { return GetItemHandler(a_Item.m_ItemType); }

    static void Deinit();

protected:
    int m_ItemType;
    static cItemHandler * CreateItemHandler(int m_ItemType);

    static cItemHandler * m_ItemHandler[E_ITEM_LAST + 1];
    static bool m_HandlerInitialized;  // used to detect if the itemhandlers are initialized
};

// Short function
inline cItemHandler *ItemHandler(int a_ItemType) { return cItemHandler::GetItemHandler(a_ItemType); }