ea386eaab1
* Lock hopper when powered by redstone * Add to manual bindings * Add hopper API documentation Co-authored-by: Mat <mail@mathias.is>
107 lines
3.3 KiB
C++
107 lines
3.3 KiB
C++
|
|
// HopperEntity.h
|
|
|
|
// Declares the cHopperEntity representing a hopper block entity
|
|
|
|
|
|
|
|
|
|
|
|
#pragma once
|
|
|
|
#include "BlockEntityWithItems.h"
|
|
|
|
|
|
|
|
|
|
|
|
// tolua_begin
|
|
class cHopperEntity :
|
|
public cBlockEntityWithItems
|
|
{
|
|
// tolua_end
|
|
|
|
using super = cBlockEntityWithItems;
|
|
|
|
// tolua_begin
|
|
|
|
public:
|
|
enum
|
|
{
|
|
ContentsHeight = 1,
|
|
ContentsWidth = 5,
|
|
TICKS_PER_TRANSFER = 8, ///< How many ticks at minimum between two item transfers to or from the hopper
|
|
} ;
|
|
|
|
|
|
|
|
// tolua_end
|
|
|
|
BLOCKENTITY_PROTODEF(cHopperEntity)
|
|
|
|
/** Constructor used for normal operation */
|
|
cHopperEntity(BLOCKTYPE a_BlockType, NIBBLETYPE a_BlockMeta, Vector3i a_Pos, cWorld * a_World);
|
|
|
|
/** Returns the block coords of the block receiving the output items, based on the meta
|
|
Returns <false, undefined> if unattached.
|
|
Exported in ManualBindings.cpp. */
|
|
std::pair<bool, Vector3i> GetOutputBlockPos(NIBBLETYPE a_BlockMeta);
|
|
|
|
void SetLocked(bool a_Value);
|
|
|
|
protected:
|
|
|
|
Int64 m_LastMoveItemsInTick;
|
|
Int64 m_LastMoveItemsOutTick;
|
|
|
|
// cBlockEntity overrides:
|
|
virtual void CopyFrom(const cBlockEntity & a_Src) override;
|
|
virtual bool Tick(std::chrono::milliseconds a_Dt, cChunk & a_Chunk) override;
|
|
virtual void SendTo(cClientHandle & a_Client) override;
|
|
virtual bool UsedBy(cPlayer * a_Player) override;
|
|
|
|
/** Opens a new chest window for this chest. Scans for neighbors to open a double chest window, if appropriate. */
|
|
void OpenNewWindow(void);
|
|
|
|
/** Moves items from the container above it into this hopper. Returns true if the contents have changed. */
|
|
bool MoveItemsIn(cChunk & a_Chunk, Int64 a_CurrentTick);
|
|
|
|
/** Moves pickups from above this hopper into it. Returns true if the contents have changed. */
|
|
bool MovePickupsIn(cChunk & a_Chunk, Int64 a_CurrentTick);
|
|
|
|
/** Moves items out from this hopper into the destination. Returns true if the contents have changed. */
|
|
bool MoveItemsOut(cChunk & a_Chunk, Int64 a_CurrentTick);
|
|
|
|
/** Moves items from a chest (dblchest) above the hopper into this hopper. Returns true if contents have changed. */
|
|
bool MoveItemsFromChest(cChunk & a_Chunk);
|
|
|
|
/** Moves items from a furnace above the hopper into this hopper. Returns true if contents have changed. */
|
|
bool MoveItemsFromFurnace(cChunk & a_Chunk);
|
|
|
|
/** Moves items from the specified a_Entity's Contents into this hopper. Returns true if contents have changed. */
|
|
bool MoveItemsFromGrid(cBlockEntityWithItems & a_Entity);
|
|
|
|
/** Moves one piece from the specified itemstack into this hopper. Returns true if contents have changed. Doesn't change the itemstack. */
|
|
bool MoveItemsFromSlot(cBlockEntityWithItems & a_Entity, int a_SrcSlotNum);
|
|
|
|
/** Moves items to the chest at the specified absolute coords. Returns true if contents have changed */
|
|
bool MoveItemsToChest(cChunk & a_Chunk, Vector3i a_Coords);
|
|
|
|
/** Moves items to the furnace at the specified absolute coords. Returns true if contents have changed */
|
|
bool MoveItemsToFurnace(cChunk & a_Chunk, Vector3i a_Coords, NIBBLETYPE a_HopperMeta);
|
|
|
|
/** Moves items to the specified ItemGrid. Returns true if contents have changed */
|
|
bool MoveItemsToGrid(cBlockEntityWithItems & a_Entity);
|
|
|
|
/** Moves one piece to the specified entity's contents' slot. Returns true if contents have changed. */
|
|
bool MoveItemsToSlot(cBlockEntityWithItems & a_Entity, int a_DstSlotNum);
|
|
|
|
private:
|
|
|
|
bool m_Locked;
|
|
} ; // tolua_export
|
|
|
|
|
|
|
|
|