Index:
Articles
Classes
Hooks
Quick navigation:
cArrowEntity
cBeaconEntity
cBlockArea
cBlockEntity
cBlockEntityWithItems
cBlockInfo
cBoundingBox
cBrewingstandEntity
cChatColor
cChestEntity
cChunkDesc
cClientHandle
cCommandBlockEntity
cCompositeChat
cCraftingGrid
cCraftingRecipe
cCryptoHash
cCuboid
cDispenserEntity
cDropperEntity
cDropSpenserEntity
cEnchantments
cEntity
cEntityEffect
cExpBottleEntity
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
cBeaconEntity class
A beacon entity is a cBlockEntityWithItems descendant that represents a beacon
in the world.
Inheritance
This class inherits from the following parent classes:
Functions
| Name | Parameters | Return value | Notes |
|---|
| CalculatePyramidLevel |
|
number |
Calculate the amount of layers the pyramid below the beacon has. |
| GetBeaconLevel |
|
number |
Returns the beacon level. (0 - 4) |
| GetPrimaryEffect |
|
EffectType |
Returns the primary effect. |
| GetSecondaryEffect |
|
EffectType |
Returns the secondary effect. |
| GiveEffects |
|
|
Give the near-players the effects. |
| IsActive |
|
bool |
Is the beacon active? |
| IsBeaconBlocked |
|
bool |
Is the beacon blocked by non-transparent blocks that are higher than the beacon? |
| IsMineralBlock |
BLOCKTYPE |
bool |
(STATIC) Returns true if the block is a diamond block, a golden block, an iron block or an emerald block. |
| IsValidEffect |
EffectType, BeaconLevel |
boolean |
(STATIC) Returns true if the effect can be used. |
| SetPrimaryEffect |
EffectType |
bool |
Select the primary effect. Returns false when the effect is invalid. |
| SetSecondaryEffect |
EffectType |
bool |
Select the secondary effect. Returns false when the effect is invalid. |
| UpdateBeacon |
|
|
Update the beacon. |
Functions inherited from cBlockEntityWithItems
| Name | Parameters | Return value | Notes |
|---|
| GetContents |
|
cItemGrid |
Returns the cItemGrid object representing the items stored within this block entity |
| GetSlot |
SlotNum |
cItem |
Returns the cItem for the specified slot number. Returns nil for invalid slot numbers |
| GetSlot |
X, Y |
cItem |
Returns the cItem for the specified slot coords. Returns nil for invalid slot coords |
| SetSlot |
SlotNum, cItem |
|
Sets the cItem for the specified slot number. Ignored if invalid slot number |
| SetSlot |
X, Y, cItem |
|
Sets the cItem for the specified slot coords. Ignored if invalid slot coords |
Functions inherited from cBlockEntity
| Name | Parameters | Return value | Notes |
|---|
| GetBlockType |
|
BLOCKTYPE |
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 |
|