cBeaconEntity


Index:
Articles
Classes
Hooks

Quick navigation:
cArrowEntity
cBeaconEntity
cBedEntity
cBlockArea
cBlockEntity
cBlockEntityWithItems
cBlockInfo
cBoat
cBoundingBox
cBrewingstandEntity
cChatColor
cChestEntity
cChunkDesc
cClientHandle
cColor
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
cLeashKnot
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
EffectID
HTTPFormData
HTTPRequest
HTTPTemplateRequest
ItemCategory
lxp
SmokeDirection
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

NameParametersReturn valueNotes
CalculatePyramidLevel
number
Calculate the amount of layers the pyramid below the beacon has.
GetBeaconLevel
number
Returns the beacon level. (0 - 4)
GetPrimaryEffect
EffectTypeeType
Returns the primary effect.
GetSecondaryEffect
EffectTypeeType
Returns the secondary effect.
GiveEffects Give the near-players the effects.
IsActive
boolean
Is the beacon active?
IsBeaconBlocked
boolean
Is the beacon blocked by non-transparent blocks that are higher than the beacon?
IsMineralBlock
BlockTypenumber
boolean
(STATIC) Returns true if the block is a diamond block, a golden block, an iron block or an emerald block.
IsValidEffect
EffectTypeeType
BeaconLevelnumber
boolean
(STATIC) Returns true if the effect can be used.
SetPrimaryEffect
EffectTypeeType
boolean
Select the primary effect. Returns false when the effect is invalid.
SetSecondaryEffect
EffectTypeeType
boolean
Select the secondary effect. Returns false when the effect is invalid.
UpdateBeacon Update the beacon.

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
Generated by APIDump on 2017-08-21 21:02:35, Build ID Unknown, Commit approx: e44a0adfcf623b37ee26f79e607f81dc16fac75e