cChestEntity


Index:
Articles
Classes
Hooks

Quick navigation:
cArrowEntity
cBeaconEntity
cBlockArea
cBlockEntity
cBlockEntityWithItems
cBlockInfo
cBoat
cBoundingBox
cBrewingstandEntity
cChatColor
cChestEntity
cChunkDesc
cClientHandle
cCommandBlockEntity
cCompositeChat
cCraftingGrid
cCraftingRecipe
cCryptoHash
cCuboid
cDispenserEntity
cDropperEntity
cDropSpenserEntity
cEnchantments
cEntity
cEntityEffect
cExpBottleEntity
cExpOrb
cFallingBlock
cFile
cFireChargeEntity
cFireworkEntity
cFloater
cFlowerPotEntity
cFurnaceEntity
cGhastFireballEntity
cHangingEntity
cHopperEntity
cIniFile
cInventory
cItem
cItemFrame
cItemGrid
cItems
cJson
cJukeboxEntity
cLineBlockTracer
cLuaWindow
cMap
cMapManager
cMobHeadEntity
cMobSpawnerEntity
cMojangAPI
cMonster
cNetwork
cNoteEntity
cObjective
cPainting
cPawn
cPickup
cPlayer
cPlugin
cPluginLua
cPluginManager
cProjectileEntity
cRankManager
cRoot
cScoreboard
cServer
cServerHandle
cSignEntity
cSplashPotionEntity
cStatManager
cStringCompression
cTCPLink
cTeam
cThrownEggEntity
cThrownEnderPearlEntity
cThrownSnowballEntity
cTNTEntity
cTracer
cUDPEndpoint
cUrlClient
cUrlParser
cWebAdmin
cWindow
cWitherSkullEntity
cWorld
HTTPFormData
HTTPRequest
HTTPTemplateRequest
ItemCategory
lxp
sqlite3
TakeDamageInfo
tolua
Vector3d
Vector3f
Vector3i
Globals

Contents


cChestEntity class

A chest entity is a cBlockEntityWithItems descendant that represents a chest in the world. Note that doublechests consist of two separate cChestEntity objects, they do not collaborate in any way.

To manipulate a chest already in the game, you need to use cWorld's callback mechanism with either DoWithChestAt() or ForEachChestInChunk() function. See the code example below


Inheritance

This class inherits from the following parent classes:


Constants

NameValueNotes
ContentsHeight 3 Height of the contents' ItemGrid, as required by the parent class, cBlockEntityWithItems
ContentsWidth 9 Width of the contents' ItemGrid, as required by the parent class, cBlockEntityWithItems

Functions

Functions inherited from cBlockEntityWithItems

NameParametersReturn valueNotes
GetContents
cItemGrid
Returns the cItemGrid object representing the items stored within this block entity
GetSlot
Xnumber
Ynumber
cItem
Returns the cItem for the specified slot coords. Returns nil for invalid slot coords
GetSlot
SlotNumnumber
cItem
Returns the cItem for the specified slot number. Returns nil for invalid slot numbers
SetSlot
SlotNumnumber
cItemcItem
Sets the cItem for the specified slot number. Ignored if invalid slot number
SetSlot
Xnumber
Ynumber
cItemcItem
Sets the cItem for the specified slot coords. Ignored if invalid slot coords

Functions inherited from cBlockEntity

NameParametersReturn valueNotes
GetBlockType
BLOCKTYPEnumber
Returns the blocktype which is represented by this blockentity. This is the primary means of type-identification
GetChunkX
number
Returns the chunk X-coord of the block entity's chunk
GetChunkZ
number
Returns the chunk Z-coord of the block entity's chunk
GetPos
Vector3i
Returns the name of the parent class, or empty string if no parent class.
GetPosX
number
Returns the block X-coord of the block entity's block
GetPosY
number
Returns the block Y-coord of the block entity's block
GetPosZ
number
Returns the block Z-coord of the block entity's block
GetRelX
number
Returns the relative X coord of the block entity's block within the chunk
GetRelZ
number
Returns the relative Z coord of the block entity's block within the chunk
GetWorld
cWorld
Returns the world to which the block entity belongs

Code example

The following example code sets the top-left item of each chest in the same chunk as Player to 64 * diamond:
-- Player is a cPlayer object instance
local World = Player:GetWorld();
World:ForEachChestInChunk(Player:GetChunkX(), Player:GetChunkZ(),
	function (ChestEntity)
		ChestEntity:SetSlot(0, 0, cItem(E_ITEM_DIAMOND, 64));
	end
);
Generated on 2017-05-27 01:00:05, Build ID Unknown, Commit approx: 73a3c4e3be1916bdd4830e7ce7454035a1f572f6