CanPickup={Params="{{cPlayer|Player}}",Return="bool",Notes="Returns true if the specified player can pick the arrow when it's on the ground"},
GetDamageCoeff={Params="",Return="number",Notes="Returns the damage coefficient stored within the arrow. The damage dealt by this arrow is multiplied by this coeff"},
GetPickupState={Params="",Return="PickupState",Notes="Returns the pickup state (one of the psXXX constants, above)"},
IsCritical={Params="",Return="bool",Notes="Returns true if the arrow should deal critical damage. Based on the bow charge when the arrow was shot."},
SetDamageCoeff={Params="number",Return="",Notes="Sets the damage coefficient. The damage dealt by this arrow is multiplied by this coeff"},
SetIsCritical={Params="bool",Return="",Notes="Sets the IsCritical flag on the arrow. Critical arrow deal additional damage"},
SetPickupState={Params="PickupState",Return="",Notes="Sets the pickup state (one of the psXXX constants, above)"},
},
Constants=
{
psInCreative={Notes="The arrow can be picked up only by players in creative gamemode"},
psInSurvivalOrCreative={Notes="The arrow can be picked up by players in survival or creative gamemode"},
psNoPickup={Notes="The arrow cannot be picked up at all"},
Clear={Params="",Return="",Notes="Clears the object, resets it to zero size"},
CopyFrom={Params="BlockAreaSrc",Return="",Notes="Copies contents from BlockAreaSrc into self"},
CopyTo={Params="BlockAreaDst",Return="",Notes="Copies contents from self into BlockAreaDst."},
Create={Params="SizeX, SizeY, SizeZ, [DataTypes]",Return="",Notes="Initializes this BlockArea to an empty area of the specified size and origin of {0, 0, 0}. Any previous contents are lost."},
Crop={Params="AddMinX, SubMaxX, AddMinY, SubMaxY, AddMinZ, SubMaxZ",Return="",Notes="Crops the specified number of blocks from each border. Modifies the size of this blockarea object."},
DumpToRawFile={Params="FileName",Return="",Notes="Dumps the raw data into a file. For debugging purposes only."},
Expand={Params="SubMinX, AddMaxX, SubMinY, AddMaxY, SubMinZ, AddMaxZ",Return="",Notes="Expands the specified number of blocks from each border. Modifies the size of this blockarea object. New blocks created with this operation are filled with zeroes."},
Fill={Params="DataTypes, BlockType, [BlockMeta], [BlockLight], [BlockSkyLight]",Return="",Notes="Fills the entire block area with the same values, specified. Uses the DataTypes param to determine which content types are modified."},
FillRelCuboid={Params="MinRelX, MaxRelX, MinRelY, MaxRelY, MinRelZ, MaxRelZ, DataTypes, BlockType, [BlockMeta], [BlockLight], [BlockSkyLight]",Return="",Notes="Fills the specified cuboid with the same values (like Fill() )."},
GetBlockLight={Params="BlockX, BlockY, BlockZ",Return="NIBBLETYPE",Notes="Returns the blocklight at the specified absolute coords"},
GetBlockMeta={Params="BlockX, BlockY, BlockZ",Return="NIBBLETYPE",Notes="Returns the block meta at the specified absolute coords"},
GetBlockSkyLight={Params="BlockX, BlockY, BlockZ",Return="NIBBLETYPE",Notes="Returns the skylight at the specified absolute coords"},
GetBlockType={Params="BlockX, BlockY, BlockZ",Return="BLOCKTYPE",Notes="Returns the block type at the specified absolute coords"},
GetBlockTypeMeta={Params="BlockX, BlockY, BlockZ",Return="BLOCKTYPE, NIBBLETYPE",Notes="Returns the block type and meta at the specified absolute coords"},
GetDataTypes={Params="",Return="number",Notes="Returns the mask of datatypes that the objectis currently holding"},
GetOriginX={Params="",Return="number",Notes="Returns the origin x-coord"},
GetOriginY={Params="",Return="number",Notes="Returns the origin y-coord"},
GetOriginZ={Params="",Return="number",Notes="Returns the origin z-coord"},
GetRelBlockLight={Params="RelBlockX, RelBlockY, RelBlockZ",Return="NIBBLETYPE",Notes="Returns the blocklight at the specified relative coords"},
GetRelBlockMeta={Params="RelBlockX, RelBlockY, RelBlockZ",Return="NIBBLETYPE",Notes="Returns the block meta at the specified relative coords"},
GetRelBlockSkyLight={Params="RelBlockX, RelBlockY, RelBlockZ",Return="NIBBLETYPE",Notes="Returns the skylight at the specified relative coords"},
GetRelBlockType={Params="RelBlockX, RelBlockY, RelBlockZ",Return="BLOCKTYPE",Notes="Returns the block type at the specified relative coords"},
GetRelBlockTypeMeta={Params="RelBlockX, RelBlockY, RelBlockZ",Return="NIBBLETYPE",Notes="Returns the block type and meta at the specified relative coords"},
GetSizeX={Params="",Return="number",Notes="Returns the size of the held data in the x-axis"},
GetSizeY={Params="",Return="number",Notes="Returns the size of the held data in the y-axis"},
GetSizeZ={Params="",Return="number",Notes="Returns the size of the held data in the z-axis"},
HasBlockLights={Params="",Return="bool",Notes="Returns true if current datatypes include blocklight"},
HasBlockMetas={Params="",Return="bool",Notes="Returns true if current datatypes include block metas"},
HasBlockSkyLights={Params="",Return="bool",Notes="Returns true if current datatypes include skylight"},
HasBlockTypes={Params="",Return="bool",Notes="Returns true if current datatypes include block types"},
LoadFromSchematicFile={Params="FileName",Return="",Notes="Clears current content and loads new content from the specified schematic file. Returns true if successful. Returns false and logs error if unsuccessful, old content is preserved in such a case."},
Merge={Params="BlockAreaSrc, RelX, RelY, RelZ, Strategy",Return="",Notes="Merges BlockAreaSrc into this object at the specified relative coords, using the specified strategy"},
MirrorXY={Params="",Return="",Notes="Mirrors this block area around the XY plane. Modifies blocks' metas (if present) to match (i. e. furnaces facing the opposite direction)."},
MirrorXYNoMeta={Params="",Return="",Notes="Mirrors this block area around the XY plane. Doesn't modify blocks' metas."},
MirrorXZ={Params="",Return="",Notes="Mirrors this block area around the XZ plane. Modifies blocks' metas (if present)"},
MirrorXZNoMeta={Params="",Return="",Notes="Mirrors this block area around the XZ plane. Doesn't modify blocks' metas."},
MirrorYZ={Params="",Return="",Notes="Mirrors this block area around the YZ plane. Modifies blocks' metas (if present)"},
MirrorYZNoMeta={Params="",Return="",Notes="Mirrors this block area around the YZ plane. Doesn't modify blocks' metas."},
Read={Params="World, MinX, MaxX, MinY, MaxY, MinZ, MaxZ, DataTypes",Return="bool",Notes="Reads the area from World, returns true if successful"},
RelLine={Params="RelX1, RelY1, RelZ1, RelX2, RelY2, RelZ2, DataTypes, BlockType, [BlockMeta], [BlockLight], [BlockSkyLight]",Return="",Notes="Draws a line between the two specified points. Sets only datatypes specified by DataTypes."},
RotateCCW={Params="",Return="",Notes="Rotates the block area around the Y axis, counter-clockwise (east -> north). Modifies blocks' metas (if present) to match."},
RotateCCWNoMeta={Params="",Return="",Notes="Rotates the block area around the Y axis, counter-clockwise (east -> north). Doesn't modify blocks' metas."},
RotateCW={Params="",Return="",Notes="Rotates the block area around the Y axis, clockwise (north -> east). Modifies blocks' metas (if present) to match."},
RotateCWNoMeta={Params="",Return="",Notes="Rotates the block area around the Y axis, clockwise (north -> east). Doesn't modify blocks' metas."},
SaveToSchematicFile={Params="FileName",Return="",Notes="Saves the current contents to a schematic file. Returns true if successful."},
SetBlockLight={Params="BlockX, BlockY, BlockZ, BlockLight",Return="",Notes="Sets the blocklight at the specified absolute coords"},
SetBlockMeta={Params="BlockX, BlockY, BlockZ, BlockMeta",Return="",Notes="Sets the block meta at the specified absolute coords"},
SetBlockSkyLight={Params="BlockX, BlockY, BlockZ, SkyLight",Return="",Notes="Sets the skylight at the specified absolute coords"},
SetBlockType={Params="BlockX, BlockY, BlockZ, BlockType",Return="",Notes="Sets the block type at the specified absolute coords"},
SetBlockTypeMeta={Params="BlockX, BlockY, BlockZ, BlockType, BlockMeta",Return="",Notes="Sets the block type and meta at the specified absolute coords"},
SetOrigin={Params="OriginX, OriginY, OriginZ",Return="",Notes="Resets the origin for the absolute coords. Only affects how absolute coords are translated into relative coords."},
SetRelBlockTypeMeta={Params="RelBlockX, RelBlockY, RelBlockZ, BlockType, BlockMeta",Return="",Notes="Sets the block type and meta at the specified relative coords"},
Write={Params="World, MinX, MinY, MinZ, DataTypes",Return="bool",Notes="Writes the area into World at the specified coords, returns true if successful"},
GetBlockType={Params="",Return="BLOCKTYPE",Notes="Returns the blocktype which is represented by this blockentity. This is the primary means of type-identification"},
{Params="MinX, MaxX, MinY, MaxY, MinZ, MaxZ",Return="cBoundingBox",Notes="Creates a new bounding box with the specified edges"},
{Params="{{Vector3d|Min}}, {{Vector3d|Max}}",Return="cBoundingBox",Notes="Creates a new bounding box with the coords specified as two vectors"},
{Params="{{Vector3d|Pos}}, Radius, Height",Return="cBoundingBox",Notes="Creates a new bounding box from the position given and radius (X/Z) and height. Radius is added from X/Z to calculate the maximum coords and subtracted from X/Z to get the minimum; minimum Y is set to Pos.y and maxumim Y to Pos.y plus Height. This corresponds with how {{cEntity|entities}} are represented in Minecraft."},
{Params="OtherBoundingBox",Return="cBoundingBox",Notes="Creates a new copy of the given bounding box. Same result can be achieved by using a simple assignment."},
},
CalcLineIntersection={Params="{{Vector3d|LineStart}}, {{Vector3d|LinePt2}}",Return="DoesIntersect, LineCoeff, Face",Notes="Calculates the intersection of a ray (half-line), given by two of its points, with the bounding box. Returns false if the line doesn't intersect the bounding box, or true, together with coefficient of the intersection (how much of the difference between the two ray points is needed to reach the intersection), and the face of the box which is intersected.<br /><b>TODO</b>: Lua binding for this function is wrong atm."},
DoesIntersect={Params="OtherBoundingBox",Return="bool",Notes="Returns true if the two bounding boxes have an intersection of nonzero volume."},
Expand={Params="ExpandX, ExpandY, ExpandZ",Return="",Notes="Expands this bounding box by the specified amount in each direction (so the box becomes larger by 2 * Expand in each axis)."},
IsInside=
{
{Params="{{Vector3d|Point}}",Return="bool",Notes="Returns true if the specified point is inside (including on the edge) of the box."},
{Params="PointX, PointY, PointZ",Return="bool",Notes="Returns true if the specified point is inside (including on the edge) of the box."},
{Params="OtherBoundingBox",Return="bool",Notes="Returns true if OtherBoundingBox is inside of this box."},
{Params="{{Vector3d|OtherBoxMin}}, {{Vector3d|OtherBoxMax}}",Return="bool",Notes="Returns true if the other bounding box, specified by its 2 corners, is inside of this box."},
},
Move=
{
{Params="OffsetX, OffsetY, OffsetZ",Return="",Notes="Moves the bounding box by the specified offset in each axis"},
{Params="{{Vector3d|Offset}}",Return="",Notes="Moves the bounding box by the specified offset in each axis"},
},
Union={Params="OtherBoundingBox",Return="cBoundingBox",Notes="Returns the smallest bounding box that contains both OtherBoundingBox and this bounding box. Note that unlike the strict geometrical meaning of \"union\", this operation actually returns a cBoundingBox."},
constructor={Params="BlockX, BlockY, BlockZ",Return="cChestEntity",Notes="Creates a new cChestEntity object. To be used only in the chunk generating hooks {{OnChunkGenerating}} and {{OnChunkGenerated}}."},
{Params="{{cCuboid|RelCuboid}}, BlockType, BlockMeta",Return="",Notes="Fills the cuboid, specified in relative coords, by the specified block type and block meta. The cuboid may reach outside of the chunk, only the part intersecting with this chunk is filled."},
{Params="MinRelX, MaxRelX, MinRelY, MaxRelY, MinRelZ, MaxRelZ, BlockType, BlockMeta",Return="",Notes="Fills the cuboid, specified in relative coords, by the specified block type and block meta. The cuboid may reach outside of the chunk, only the part intersecting with this chunk is filled."},
},
FloorRelCuboid=
{
{Params="{{cCuboid|RelCuboid}}, BlockType, BlockMeta",Return="",Notes="Fills those blocks of the cuboid (specified in relative coords) that are considered non-floor (air, water) with the specified block type and meta. Cuboid may reach outside the chunk, only the part intersecting with this chunk is filled."},
{Params="MinRelX, MaxRelX, MinRelY, MaxRelY, MinRelZ, MaxRelZ, BlockType, BlockMeta",Return="",Notes="Fills those blocks of the cuboid (specified in relative coords) that are considered non-floor (air, water) with the specified block type and meta. Cuboid may reach outside the chunk, only the part intersecting with this chunk is filled."},
{Params="{{cCuboid|RelCuboid}}, BlockType, BlockMeta, RandomSeed, ChanceOutOf10k",Return="",Notes="Fills the specified relative cuboid with block type and meta in random locations. RandomSeed is used for the random number genertion (same seed produces same results); ChanceOutOf10k specifies the density (how many out of every 10000 blocks should be filled). Cuboid may reach outside the chunk, only the part intersecting with this chunk is filled."},
{Params="MinRelX, MaxRelX, MinRelY, MaxRelY, MinRelZ, MaxRelZ, BlockType, BlockMeta, RandomSeed, ChanceOutOf10k",Return="",Notes="Fills the specified relative cuboid with block type and meta in random locations. RandomSeed is used for the random number genertion (same seed produces same results); ChanceOutOf10k specifies the density (how many out of every 10000 blocks should be filled). Cuboid may reach outside the chunk, only the part intersecting with this chunk is filled."},
},
ReadBlockArea={Params="{{cBlockArea|BlockArea}}, MinRelX, MaxRelX, MinRelY, MaxRelY, MinRelZ, MaxRelZ",Return="",Notes="Reads data from the chunk into the block area object. Block types and metas are processed."},
ReplaceRelCuboid=
{
{Params="{{cCuboid|RelCuboid}}, SrcType, SrcMeta, DstType, DstMeta",Return="",Notes="Replaces all SrcType+SrcMeta blocks in the cuboid (specified in relative coords) with DstType+DstMeta blocks. Cuboid may reach outside the chunk, only the part intersecting with this chunk is filled."},
{Params="MinRelX, MaxRelX, MinRelY, MaxRelY, MinRelZ, MaxRelZ, SrcType, SrcMeta, DstType, DstMeta",Return="",Notes="Replaces all SrcType+SrcMeta blocks in the cuboid (specified in relative coords) with DstType+DstMeta blocks. Cuboid may reach outside the chunk, only the part intersecting with this chunk is filled."},
GetPlayer={Params="",Return="{{cPlayer|cPlayer}}",Notes="Returns the player object connected to this client. Note that this may be nil, for example if the player object is not yet spawned."},
SendBlockChange={Params="BlockX, BlockY, BlockZ, BlockType, BlockMeta",Return="",Notes="Sends a BlockChange packet to the client. This can be used to create fake blocks only for that player."},
constructor={Params="Width, Height",Return="cCraftingGrid",Notes="Creates a new CraftingGrid object. This new crafting grid is not related to any player, but may be needed for {{cCraftingRecipe}}'s ConsumeIngredients function."},
ConsumeGrid={Params="{{cCraftingGrid|CraftingGrid}}",Return="",Notes="Consumes items specified in CraftingGrid from the current contents. Used internally by {{cCraftingRecipe}}'s ConsumeIngredients() function, but available to plugins, too."},
{Params="OtheCuboid",Return="cCuboid",Notes="Creates a new Cuboid object as a copy of OtherCuboid"},
{Params="{{Vector3i|Point1}}, {{Vector3i|Point2}}",Return="cCuboid",Notes="Creates a new Cuboid object with the specified points as its corners."},
{Params="X, Y, Z",Return="cCuboid",Notes="Creates a new Cuboid object with the specified point as both its corners (the cuboid has a size of 1 in each direction)."},
{Params="X1, Y1, Z1, X2, Y2, Z2",Return="cCuboid",Notes="Creates a new Cuboid object with the specified points as its corners."},
},
Assign={Params="X1, Y1, Z1, X2, Y2, Z2",Return="",Notes="Assigns all the coords stored in the cuboid. Sort-state is ignored."},
DifX={Params="",Return="number",Notes="Returns the difference between the two X coords (X-size minus 1). Assumes sorted."},
DifY={Params="",Return="number",Notes="Returns the difference between the two Y coords (Y-size minus 1). Assumes sorted."},
DifZ={Params="",Return="number",Notes="Returns the difference between the two Z coords (Z-size minus 1). Assumes sorted."},
DoesIntersect={Params="OtherCuboid",Return="bool",Notes="Returns true if this cuboid has at least one voxel in common with OtherCuboid. Note that edges are considered inclusive. Assumes both sorted."},
IsCompletelyInside={Params="OuterCuboid",Return="bool",Notes="Returns true if this cuboid is completely inside (in all directions) in OuterCuboid. Assumes both sorted."},
IsInside=
{
{Params="X, Y, Z",Return="bool",Notes="Returns true if the specified point (integral coords) is inside this cuboid. Assumes sorted."},
{Params="{{Vector3i|Point}}",Return="bool",Notes="Returns true if the specified point (integral coords) is inside this cuboid. Assumes sorted."},
{Params="{{Vector3d|Point}}",Return="bool",Notes="Returns true if the specified point (floating-point coords) is inside this cuboid. Assumes sorted."},
},
IsSorted={Params="",Return="bool",Notes="Returns true if this cuboid is sorted"},
Move={Params="OffsetX, OffsetY, OffsetZ",Return="",Notes="Adds the specified offsets to each respective coord, effectively moving the Cuboid. Sort-state is ignored."},
Sort={Params="",Return="",Notes="Sorts the internal representation so that p1 contains the lesser coords and p2 contains the greater coords."},
Desc=[[Thisclassrepresentsadispenserblockentityintheworld.Mostofthisblockentity's functionality is implemented in the {{cDropSpenserEntity|cDropSpenserEntity}} class that represents the behavior common with a {{cDropperEntity|dropper}} entity.
Desc=[[Thisclassrepresentsadropperblockentityintheworld.Mostofthisblockentity's functionality is implemented in the {{cDropSpenserEntity|cDropSpenserEntity}} class that represents the behavior common with the {{cDispenserEntity|dispenser}} entity.
Activate={Params="",Return="",Notes="Sets the block entity to dropspense an item in the next tick"},
AddDropSpenserDir={Params="BlockX, BlockY, BlockZ, BlockMeta",Return="BlockX, BlockY, BlockZ",Notes="Adjusts the block coords to where the dropspenser items materialize"},
SetRedstonePower={Params="IsPowered",Return="",Notes="Sets the redstone status of the dropspenser. If the redstone power goes from off to on, the dropspenser will be activated"},
{Params="",Return="cEnchantments",Notes="Creates a new empty cEnchantments object"},
{Params="StringSpec",Return="cEnchantments",Notes="Creates a new cEnchantments object filled with enchantments based on the string description"},
},
operator_eq={Params="OtherEnchantments",Return="bool",Notes="Returns true if this enchantments object has the same enchantments as OtherEnchantments."},
AddFromString={Params="StringSpec",Return="",Notes="Adds the enchantments in the string description into the object. If a specified enchantment already existed, it is overwritten."},
Clear={Params="",Return="",Notes="Removes all enchantments"},
GetLevel={Params="EnchantmentNumID",Return="number",Notes="Returns the level of the specified enchantment stored in this object; 0 if not stored"},
IsEmpty={Params="",Return="bool",Notes="Returns true if the object stores no enchantments"},
SetLevel={Params="EnchantmentNumID, Level",Return="",Notes="Sets the level for the specified enchantment, adding it if not stored before or removing it if level < = 0"},
StringToEnchantmentID={Params="EnchantmentTextID",Return="number",Notes="(static) Returns the enchantment numerical ID, -1 if not understood. Case insensitive"},
ToString={Params="",Return="string",Notes="Returns the string description of all the enchantments stored in this object, in numerical-ID form"},
GetArmorCoverAgainst={Params="AttackerEntity, DamageType, RawDamage",Return="number",Notes="Returns the number of hitpoints out of RawDamage that the currently equipped armor would cover. See {{TakeDamageInfo}} for more information on attack damage."},
GetClassStatic={Params="",Return="string",Notes="Returns the entity classname that this class implements. Each descendant overrides this function. Is static"},
GetEntityType={Params="",Return="eEntityType",Notes="Returns the type of the entity, one of the etXXX constants. Note that to check specific entity type, you should use one of the IsXXX functions instead of comparing the value returned by this call."},
GetEquippedBoots={Params="",Return="{{cItem}}",Notes="Returns the boots that the entity has equipped. Returns an empty cItem if no boots equipped or not applicable."},
GetEquippedChestplate={Params="",Return="{{cItem}}",Notes="Returns the chestplate that the entity has equipped. Returns an empty cItem if no chestplate equipped or not applicable."},
GetEquippedHelmet={Params="",Return="{{cItem}}",Notes="Returns the helmet that the entity has equipped. Returns an empty cItem if no helmet equipped or not applicable."},
GetEquippedLeggings={Params="",Return="{{cItem}}",Notes="Returns the leggings that the entity has equipped. Returns an empty cItem if no leggings equipped or not applicable."},
GetEquippedWeapon={Params="",Return="{{cItem}}",Notes="Returns the weapon that the entity has equipped. Returns an empty cItem if no weapon equipped or not applicable."},
GetGravity={Params="",Return="number",Notes="Returns the number that is used as the gravity for physics simulation. 1G (9.78) by default."},
GetHeadYaw={Params="",Return="number",Notes="Returns the pitch of the entity's head (FIXME: Rename to GetHeadPitch() )."},
GetHealth={Params="",Return="number",Notes="Returns the current health of the entity."},
GetHeight={Params="",Return="number",Notes="Returns the height (Y size) of the entity"},
GetKnockbackAmountAgainst={Params="ReceiverEntity",Return="number",Notes="Returns the amount of knockback that the currently equipped items would cause when attacking the ReceiverEntity."},
GetRawDamageAgainst={Params="ReceiverEntity",Return="number",Notes="Returns the raw damage that this entity's equipment would cause when attacking the ReceiverEntity. This includes this entity's weapon {{cEnchantments|enchantments}}, but excludes the receiver's armor or potion effects. See {{TakeDamageInfo}} for more information on attack damage."},
GetRoll={Params="",Return="number",Notes="Returns the roll (sideways rotation) of the entity. Currently unused."},
GetRot={Params="",Return="{{Vector3f}}",Notes="Returns the entire rotation vector (Yaw, Pitch, Roll)"},
GetRotation={Params="",Return="number",Notes="Returns the yaw (direction) of the entity. FIXME: Rename to GetYaw()."},
GetUniqueID={Params="",Return="number",Notes="Returns the ID that uniquely identifies the entity within the running server. Note that this ID is not persisted to the data files."},
GetWidth={Params="",Return="number",Notes="Returns the width (X and Z size) of the entity."},
IsA={Params="ClassName",Return="bool",Notes="Returns true if the entity class is a descendant of the specified class name, or the specified class itself"},
IsRiding={Params="",Return="bool",Notes="Returns true if the entity is attached to (riding) another entity."},
IsSprinting={Params="",Return="bool",Notes="Returns true if the entity is sprinting. Entities that cannot sprint return always false"},
IsTNT={Params="",Return="bool",Notes="Returns true if the entity represents a {{cTNTEntity|TNT entity}}"},
KilledBy={Notes="FIXME: Remove this from API"},
SetGravity={Params="Gravity",Return="",Notes="Sets the number that is used as the gravity for physics simulation. 1G (9.78) by default."},
SetHeadYaw={Params="HeadPitch",Return="",Notes="Sets the head pitch (FIXME: Rename to SetHeadPitch() )."},
SetHealth={Params="Hitpoints",Return="",Notes="Sets the entity's health to the specified amount of hitpoints. Doesn't broadcast any hurt animation. Doesn't kill the entity if health drops below zero. Use the TakeDamage() function instead for taking damage."},
SetHeight={Params="",Return="",Notes="FIXME: Remove this from API"},
SetMass={Params="Mass",Return="",Notes="Sets the mass of the entity. Currently unused."},
SetMaxHealth={Params="MaxHitpoints",Return="",Notes="Sets the maximum hitpoints of the entity. If current health is above MaxHitpoints, it is capped to MaxHitpoints."},
SetRoll={Params="number",Return="",Notes="Sets the roll (sideways rotation) of the entity. Currently unused."},
SetRot={Params="{{Vector3f|Rotation}}",Return="",Notes="Sets the entire rotation vector (Yaw, Pitch, Roll)"},
SetRotation={Params="number",Return="",Notes="Sets the yaw (direction) of the entity. FIXME: Rename to SetYaw()."},
SetRotationFromSpeed={Params="",Return="",Notes="Sets the entity's yaw to match its current speed (entity looking forwards as it moves). (FIXME: Rename to SetYawFromSpeed)"},
SetSpeed=
{
{Params="SpeedX, SpeedY, SpeedZ",Return="",Notes="Sets the current speed of the entity"},
{Params="{{Vector3d|Speed}}",Return="",Notes="Sets the current speed of the entity"},
},
SetSpeedX={Params="SpeedX",Return="",Notes="Sets the X component of the entity speed"},
SetSpeedY={Params="SpeedY",Return="",Notes="Sets the Y component of the entity speed"},
SetSpeedZ={Params="SpeedZ",Return="",Notes="Sets the Z component of the entity speed"},
SetWidth={Params="",Return="",Notes="FIXME: Remove this from API"},
StartBurning={Params="NumTicks",Return="",Notes="Sets the entity on fire for the specified number of ticks. If entity is on fire already, makes it burn for either NumTicks or the number of ticks left from the previous fire, whichever is larger."},
SteerVehicle={Params="ForwardAmount, SidewaysAmount",Return="",Notes="Applies the specified steering to the vehicle this entity is attached to. Ignored if not attached to any entity."},
StopBurning={Params="",Return="",Notes="Extinguishes the entity fire, cancels all fire timers."},
TakeDamage=
{
{Params="AttackerEntity",Return="",Notes="Causes this entity to take damage that AttackerEntity would inflict. Includes their weapon and this entity's armor."},
{Params="DamageType, AttackerEntity, RawDamage, KnockbackAmount",Return="",Notes="Causes this entity to take damage of the specified type, from the specified attacker (may be nil). The final damage is calculated from RawDamage using the currently equipped armor."},
{Params="DamageType, ArrackerEntity, RawDamage, FinalDamage, KnockbackAmount",Return="",Notes="Causes this entity to take damage of the specified type, from the specified attacker (may be nil). The values are wrapped into a {{TakeDamageInfo}} structure and applied directly."},
},
TeleportToCoords={Params="PosX, PosY, PosZ",Return="",Notes="Teleports the entity to the specified coords."},
TeleportToEntity={Params="DestEntity",Return="",Notes="Teleports this entity to the specified destination entity."},
Copy={Params="SrcFileName, DstFileName",Return="bool",Notes="Copies a single file to a new destination. Returns true if successful. Fails if the destination already exists."},
CreateFolder={Params="FolderName",Return="bool",Notes="Creates a new folder. Returns true if successful."},
Delete={Params="FileName",Return="bool",Notes="Deletes the specified file. Returns true if successful."},
Exists={Params="FileName",Return="bool",Notes="Returns true if the specified file exists."},
GetSize={Params="FileName",Return="number",Notes="Returns the size of the file, or -1 on failure."},
IsFile={Params="Path",Return="bool",Notes="Returns true if the specified path points to an existing file."},
IsFolder={Params="Path",Return="bool",Notes="Returns true if the specified path points to an existing folder."},
Rename={Params="OrigPath, NewPath",Return="bool",Notes="Renames a file or a folder. Returns true if successful. Undefined result if NewPath already exists."},
constructor={Params="BlockX, BlockY, BlockZ, BlockType, BlockMeta",Return="cFurnaceEntity",Notes="Creates a new cFurnaceEntity at the specified coords and the specified block type / meta"},
GetCookTimeLeft={Params="",Return="number",Notes="Returns the time until the current item finishes cooking, in ticks"},
GetFuelBurnTimeLeft={Params="",Return="number",Notes="Returns the time until the current fuel is depleted, in ticks"},
GetFuelSlot={Params="",Return="{{cItem|cItem}}",Notes="Returns the item in the fuel slot"},
GetInputSlot={Params="",Return="{{cItem|cItem}}",Notes="Returns the item in the input slot"},
GetOutputSlot={Params="",Return="{{cItem|cItem}}",Notes="Returns the item in the output slot"},
GetTimeCooked={Params="",Return="number",Notes="Returns the time that the current item has been cooking, in ticks"},
HasFuelTimeLeft={Params="",Return="bool",Notes="Returns true if there's time before the current fuel is depleted"},
SetFuelSlot={Params="{{cItem|cItem}}",Return="",Notes="Sets the item in the fuel slot"},
SetInputSlot={Params="{{cItem|cItem}}",Return="",Notes="Sets the item in the input slot"},
SetOutputSlot={Params="{{cItem|cItem}}",Return="",Notes="Sets the item in the output slot"},
},
Constants=
{
fsInput={Notes="Index of the input slot, when using the GetSlot() / SetSlot() functions"},
fsFuel={Notes="Index of the fuel slot, when using the GetSlot() / SetSlot() functions"},
fsOutput={Notes="Index of the output slot, when using the GetSlot() / SetSlot() functions"},
ContentsWidth={Notes="Width (X) of the {{cItemGrid|cItemGrid}} representing the contents"},
ContentsHeight={Notes="Height (Y) of the {{cItemGrid|cItemGrid}} representing the contents"},
AddItem={Params="{{cItem|cItem}}, [AllowNewStacks]",Return="number",Notes="Adds an item to the storage; if AllowNewStacks is true (default), will also create new stacks in empty slots. Returns the number of items added"},
AddItems={Params="{{cItems|cItems}}, [AllowNewStacks]",Return="number",Notes="Same as AddItem, but for several items at once"},
ChangeSlotCount={Params="SlotNum, AddToCount",Return="number",Notes="Adds AddToCount to the count of items in the specified slot. If the slot was empty, ignores the call. Returns the new count in the slot, or -1 if invalid SlotNum"},
Clear={Params="",Return="",Notes="Empties all slots"},
CopyToItems={Params="{{cItems|cItems}}",Return="",Notes="Copies all non-empty slots into the cItems object provided; original cItems contents are preserved"},
DamageEquippedItem={Params="[DamageAmount]",Return="bool",Notes="Adds the specified damage (1 by default) to the currently equipped it"},
DamageItem={Params="SlotNum, [DamageAmount]",Return="bool",Notes="Adds the specified damage (1 by default) to the specified item, returns true if the item reached its max damage and should be destroyed"},
GetArmorGrid={Params="",Return="{{cItemGrid|cItemGrid}}",Notes="Returns the ItemGrid representing the armor grid (1 x 4 slots)"},
GetArmorSlot={Params="ArmorSlotNum",Return="{{cItem|cItem}}",Notes="Returns the specified armor slot contents. Note that the returned item is read-only"},
GetEquippedBoots={Params="",Return="{{cItem|cItem}}",Notes="Returns the item in the \"boots\" slot of the armor grid. Note that the returned item is read-only"},
GetEquippedChestplate={Params="",Return="{{cItem|cItem}}",Notes="Returns the item in the \"chestplate\" slot of the armor grid. Note that the returned item is read-only"},
GetEquippedHelmet={Params="",Return="{{cItem|cItem}}",Notes="Returns the item in the \"helmet\" slot of the armor grid. Note that the returned item is read-only"},
GetEquippedItem={Params="",Return="{{cItem|cItem}}",Notes="Returns the currently selected item from the hotbar. Note that the returned item is read-only"},
GetEquippedLeggings={Params="",Return="{{cItem|cItem}}",Notes="Returns the item in the \"leggings\" slot of the armor grid. Note that the returned item is read-only"},
GetEquippedSlotNum={Params="",Return="number",Notes="Returns the hotbar slot number for the currently selected item"},
GetHotbarGrid={Params="",Return="{{cItemGrid|cItemGrid}}",Notes="Returns the ItemGrid representing the hotbar grid (9 x 1 slots)"},
GetHotbarSlot={Params="HotBarSlotNum",Return="{{cItem|cItem}}",Notes="Returns the specified hotbar slot contents. Note that the returned item is read-only"},
GetInventoryGrid={Params="",Return="{{cItemGrid|cItemGrid}}",Notes="Returns the ItemGrid representing the main inventory (9 x 3 slots)"},
GetInventorySlot={Params="InventorySlotNum",Return="{{cItem|cItem}}",Notes="Returns the specified main inventory slot contents. Note that the returned item is read-only"},
GetOwner={Params="",Return="{{cPlayer|cPlayer}}",Notes="Returns the player whose inventory this object represents"},
GetSlot={Params="SlotNum",Return="{{cItem|cItem}}",Notes="Returns the contents of the specified slot. Note that the returned item is read-only"},
HasItems={Params="{{cItem|cItem}}",Return="bool",Notes="Returns true if there are at least as many items of the specified type as in the parameter"},
HowManyCanFit={Params="{{cItem|cItem}}",Return="number",Notes="Returns the number of the specified items that can fit in the storage, including empty slots"},
HowManyItems={Params="{{cItem|cItem}}",Return="number",Notes="Returns the number of the specified items that are currently stored"},
RemoveOneEquippedItem={Params="",Return="",Notes="Removes one item from the hotbar's currently selected slot"},
SetArmorSlot={Params="ArmorSlotNum, {{cItem|cItem}}",Return="",Notes="Sets the specified armor slot contents"},
SetEquippedSlotNum={Params="EquippedSlotNum",Return="",Notes="Sets the currently selected hotbar slot number"},
SetHotbarSlot={Params="HotbarSlotNum, {{cItem|cItem}}",Return="",Notes="Sets the specified hotbar slot contents"},
SetInventorySlot={Params="InventorySlotNum, {{cItem|cItem}}",Return="",Notes="Sets the specified main inventory slot contents"},
SetSlot={Params="SlotNum, {{cItem|cItem}}",Return="",Notes="Sets the specified slot contents"},
{Params="ItemType, Count, Damage, EnchantmentString",Return="cItem",Notes="Creates a new cItem object of the specified type, count (1 by default), damage (0 by default) and enchantments (non-enchanted by default)"},
{Params="cItem",Return="cItem",Notes="Creates an exact copy of the cItem object in the parameter"},
Clear={Params="",Return="",Notes="Resets the instance to an empty item"},
CopyOne={Params="",Return="cItem",Notes="Creates a copy of this object, with its count set to 1"},
DamageItem={Params="[Amount]",Return="bool",Notes="Adds the specified damage. Returns true when damage reaches max value and the item should be destroyed (but doesn't destroy the item)"},
Empty={Params="",Return="",Notes="Resets the instance to an empty item"},
GetMaxDamage={Params="",Return="number",Notes="Returns the maximum value for damage that this item can get before breaking; zero if damage is not accounted for for this item type"},
IsDamageable={Params="",Return="bool",Notes="Returns true if this item does account for its damage"},
IsEqual={Params="cItem",Return="bool",Notes="Returns true if the item in the parameter is the same as the one stored in the object (type, damage and enchantments)"},
AddItem={Params="{{cItem|cItem}}, [AllowNewStacks]",Return="number",Notes="Adds an item to the storage; if AllowNewStacks is true (default), will also create new stacks in empty slots. Returns the number of items added"},
AddItems={Params="{{cItems|cItems}}, [AllowNewStacks]",Return="number",Notes="Same as AddItem, but for several items at once"},
{Params="SlotNum, AddToCount",Return="number",Notes="Adds AddToCount to the count of items in the specified slot. If the slot was empty, ignores the call. Returns the new count in the slot, or -1 if invalid SlotNum"},
{Params="X, Y, AddToCount",Return="number",Notes="Adds AddToCount to the count of items in the specified slot. If the slot was empty, ignores the call. Returns the new count in the slot, or -1 if invalid slot coords"},
Clear={Params="",Return="",Notes="Empties all slots"},
CopyToItems={Params="{{cItems|cItems}}",Return="",Notes="Copies all non-empty slots into the cItems object provided; original cItems contents are preserved"},
{Params="SlotNum, [DamageAmount]",Return="bool",Notes="Adds the specified damage (1 by default) to the specified item, returns true if the item reached its max damage and should be destroyed"},
{Params="X, Y, [DamageAmount]",Return="bool",Notes="Adds the specified damage (1 by default) to the specified item, returns true if the item reached its max damage and should be destroyed"},
},
EmptySlot=
{
{Params="SlotNum",Return="",Notes="Destroys the item in the specified slot"},
{Params="X, Y",Return="",Notes="Destroys the item in the specified slot"},
GetFirstEmptySlot={Params="",Return="number",Notes="Returns the SlotNumber of the first empty slot, -1 if all slots are full"},
GetHeight={Params="",Return="number",Notes="Returns the Y dimension of the grid"},
GetLastEmptySlot={Params="",Return="number",Notes="Returns the SlotNumber of the last empty slot, -1 if all slots are full"},
GetNextEmptySlot={Params="StartFrom",Return="number",Notes="Returns the SlotNumber of the first empty slot following StartFrom, -1 if all the following slots are full"},
GetNumSlots={Params="",Return="number",Notes="Returns the total number of slots in the grid (Width * Height)"},
GetSlotCoords={Params="SlotNum",Return="number, number",Notes="Returns the X and Y coords for the specified SlotNumber. Returns \"-1, -1\" on invalid SlotNumber"},
GetSlotNum={Params="X, Y",Return="number",Notes="Returns the SlotNumber for the specified slot coords. Returns -1 on invalid coords"},
GetWidth={Params="",Return="number",Notes="Returns the X dimension of the grid"},
HasItems={Params="{{cItem|cItem}}",Return="bool",Notes="Returns true if there are at least as many items of the specified type as in the parameter"},
HowManyCanFit={Params="{{cItem|cItem}}",Return="number",Notes="Returns the number of the specified items that can fit in the storage, including empty slots"},
HowManyItems={Params="{{cItem|cItem}}",Return="number",Notes="Returns the number of the specified items that are currently stored"},
{Params="SlotNum",Return="bool",Notes="Returns true if the specified slot is empty, or an invalid slot is specified"},
{Params="X, Y",Return="bool",Notes="Returns true if the specified slot is empty, or an invalid slot is specified"},
},
RemoveOneItem=
{
{Params="SlotNum",Return="{{cItem|cItem}}",Notes="Removes one item from the stack in the specified slot and returns it as a single cItem. Empty slots are skipped and an empty item is returned"},
{Params="X, Y",Return="{{cItem|cItem}}",Notes="Removes one item from the stack in the specified slot and returns it as a single cItem. Empty slots are skipped and an empty item is returned"},
},
SetSlot=
{
{Params="SlotNum, {{cItem|cItem}}",Return="",Notes="Sets the specified slot to the specified item"},
{Params="X, Y, {{cItem|cItem}}",Return="",Notes="Sets the specified slot to the specified item"},
Trace={Params="{{cWorld}}, Callbacks, StartX, StartY, StartZ, EndX, EndY, EndZ",Return="bool",Notes="(STATIC) Performs the trace on the specified line. Returns true if the entire trace was processed (no callback returned true)"},
<p>Thisclassinheritsfromthe{{cWindow|cWindow}}class,soallcWindow's functions and constants can be used, in addition to the cLuaWindow-specific functions listed below.
<p>WhencreatinganewcLuaWindowobject,youneedtospecifyboththewindowtypeandthecontents' width and height. Note that MCServer accepts any combination of these, but opening a window for a player may crash their client if the contents'dimensionsdon't match the client'sexpectations.
Thiscallback,settableviatheSetOnSlotChanged()function,willbecalledwheneverthecontentsofanyslotinthewindow's contents (i. e. NOT in the player inventory!) changes.</p>
<p>Thea_WindowparameteristhecLuaWindowobjectrepresentingthewindow,a_SlotNumistheslotnumber.Thereisnoreferencetoa{{cPlayer}},becausetheslotchangeneedn't originate from the player action. To get or set the slot, you'llneedtoretrieveacPlayerobject,forexamplebycalling{{cWorld|cWorld}}:DoWithPlayer().
GetGameMode={Return="{{eGameMode|GameMode}}",Notes="Returns the player's gamemode. The player may have their gamemode unassigned, in which case they inherit the gamemode from the current {{cWorld|world}}.<br /> <b>NOTE:</b> Instead of comparing the value returned by this function to the gmXXX constants, use the IsGameModeXXX() functions. These functions handle the gamemode inheritance automatically."},
Call={Params="Function name, [All the parameters divided with commas]",Notes="This function allows you to call a function from another plugin. It can only use pass: integers, booleans, strings and usertypes (cPlayer, cEntity, cCuboid, etc.)."},
GetDirectory={Return="string",Notes="Returns the name of the folder where the plugin's files are. (APIDump)"},
GetLocalDirectory={Notes="OBSOLETE use GetLocalFolder instead."},
GetLocalFolder={Return="string",Notes="Returns the path where the plugin's files are. (Plugins/APIDump)"},
GetName={Return="string",Notes="Returns the name of the plugin."},
SetName={Params="string",Notes="Sets the name of the Plugin."},
GetVersion={Return="number",Notes="Returns the version of the plugin."},
SetVersion={Params="number",Notes="Sets the version of the plugin."},
{Params="HookType, [HookFunction]",Return="",Notes="(STATIC) Informs the plugin manager that it should call the specified function when the specified hook event occurs. If a function is not specified, a default function name is looked up, based on the hook type"},
{Params="{{cPlugin|Plugin}}, HookType, [HookFunction]",Return="",Notes="(STATIC, <b>DEPRECATED</b>) Informs the plugin manager that it should call the specified function when the specified hook event occurs. If a function is not specified, a default function name is looked up, based on the hook type. NOTE: This format is deprecated and the server outputs a warning if it is used!"},
},
BindCommand=
{
{Params="Command, Permission, Callback, HelpString",Return="",Notes="(STATIC) Binds an in-game command with the specified callback function, permission and help string. By common convention, providing an empty string for HelpString will hide the command from the /help display."},
{Params="Command, Permission, Callback, HelpString",Return="",Notes="Binds an in-game command with the specified callback function, permission and help string. By common convention, providing an empty string for HelpString will hide the command from the /help display."},
},
BindConsoleCommand=
{
{Params="Command, Callback, HelpString",Return="",Notes="(STATIC) Binds a console command with the specified callback function and help string. By common convention, providing an empty string for HelpString will hide the command from the \"help\" console command."},
{Params="Command, Callback, HelpString",Return="",Notes="Binds a console command with the specified callback function and help string. By common convention, providing an empty string for HelpString will hide the command from the \"help\" console command."},
},
DisablePlugin={Params="PluginName",Return="bool",Notes="Disables a plugin specified by its name. Returns true if the plugin was disabled, false if it wasn't found or wasn't active."},
ExecuteCommand={Params="{{cPlayer|Player}}, CommandStr",Return="bool",Notes="Executes the command as if given by the specified Player. Checks permissions. Returns true if executed."},
ExecuteConsoleCommand={Params="CommandStr",Return="bool",Notes="Executes the command as if given on the server console. Returns true if executed."},
FindPlugins={Params="",Return="",Notes="Refreshes the list of plugins to include all folders inside the Plugins folder (potentially new disabled plugins)"},
ForEachCommand={Params="CallbackFn",Return="bool",Notes="Calls the CallbackFn function for each command that has been bound using BindCommand(). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function(Command, Permission, HelpString)</pre>. If the callback returns true, the enumeration is aborted and this API function returns false; if it returns false or no value, the enumeration continues with the next command, and the API function returns true."},
ForEachConsoleCommand={Params="CallbackFn",Return="bool",Notes="Calls the CallbackFn function for each command that has been bound using BindConsoleCommand(). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function (Command, HelpString)</pre>. If the callback returns true, the enumeration is aborted and this API function returns false; if it returns false or no value, the enumeration continues with the next command, and the API function returns true."},
IsCommandBound={Params="Command",Return="bool",Notes="Returns true if in-game Command is already bound (by any plugin)"},
IsConsoleCommandBound={Params="Command",Return="bool",Notes="Returns true if console Command is already bound (by any plugin)"},
LoadPlugin={Params="PluginFolder",Return="",Notes="(<b>DEPRECATED</b>) Loads a plugin from the specified folder. NOTE: Loading plugins may be an unsafe operation and may result in a deadlock or a crash. This API is deprecated and might be removed."},
HOOK_BLOCK_TO_PICKUPS={Notes="Called when a block has been dug and is being converted to pickups. The server has provided the default pickups and the plugins may modify them."},
HOOK_CHAT={Notes="Called when a client sends a chat message that is not a command. The plugin may modify the chat message"},
HOOK_CHUNK_AVAILABLE={Notes="Called when a chunk is loaded or generated and becomes available in the {{cWorld|world}}."},
HOOK_CHUNK_GENERATED={Notes="Called after a chunk is generated. A plugin may do last modifications on the generated chunk before it is handed of to the {{cWorld|world}}."},
HOOK_CHUNK_GENERATING={Notes="Called before a chunk is generated. A plugin may override some parts of the generation algorithm."},
HOOK_CHUNK_UNLOADED={Notes="Called after a chunk has been unloaded from a {{cWorld|world}}."},
HOOK_CHUNK_UNLOADING={Notes="Called before a chunk is unloaded from a {{cWorld|world}}. The chunk has already been saved."},
HOOK_COLLECTING_PICKUP={Notes="Called when a player is about to collect a pickup."},
HOOK_CRAFTING_NO_RECIPE={Notes="Called when a player has items in the crafting slots and the server cannot locate any recipe. Plugin may provide a recipe."},
HOOK_DISCONNECT={Notes="Called after the player has disconnected."},
HOOK_EXECUTE_COMMAND={Notes="Called when a client sends a chat message that is recognized as a command, before handing that command to the regular command handler. A plugin may stop the command from being handled. This hook is called even when the player doesn't have permissions for the command."},
HOOK_EXPLODED={Notes="Called after an explosion has been processed in a {{cWorld|world}}."},
HOOK_EXPLODING={Notes="Called before an explosion is processed in a {{cWorld|world}}. A plugin may alter the explosion parameters or cancel the explosion altogether."},
HOOK_HANDSHAKE={Notes="Called when a Handshake packet is received from a client."},
HOOK_HOPPER_PULLING_ITEM={Notes="Called when a hopper is pulling an item from the container above it."},
HOOK_HOPPER_PUSHING_ITEM={Notes="Called when a hopper is pushing an item into the container it is aimed at."},
HOOK_KILLING={Notes="Called when an entity has just been killed. A plugin may resurrect the entity by setting its health to above zero."},
HOOK_LOGIN={Notes="Called when a Login packet is sent to the client, before the client is queued for authentication."},
HOOK_MAX={Notes="The maximum TypeID of a hook. Used internally by MCS to check hook type for validity."},
HOOK_NUM_HOOKS={Notes="Total number of hook types MCS supports. Used internally by MCS to check hook type for validity."},
HOOK_PLAYER_ANIMATION={Notes="Called when a client send the Animation packet."},
HOOK_PLAYER_BREAKING_BLOCK={Notes="Called when a player is about to break a block. A plugin may cancel the event."},
HOOK_PLAYER_BROKEN_BLOCK={Notes="Called after a player has broken a block."},
HOOK_PLAYER_EATING={Notes="Called when the player starts eating a held item. Plugins may abort the eating."},
HOOK_PLAYER_JOINED={Notes="Called when the player entity has been created. It has not yet been fully initialized."},
HOOK_PLAYER_LEFT_CLICK={Notes="Called when the client sends the LeftClick packet."},
HOOK_PLAYER_MOVING={Notes="Called when the player has moved and the movement is now being applied."},
HOOK_PLAYER_PLACED_BLOCK={Notes="Called when the player has just placed a block"},
HOOK_PLAYER_PLACING_BLOCK={Notes="Called when the player is about to place a block. A plugin may cancel the event."},
HOOK_PLAYER_RIGHT_CLICK={Notes="Called when the client sends the RightClick packet."},
HOOK_PLAYER_RIGHT_CLICKING_ENTITY={Notes="Called when the client sends the UseEntity packet."},
HOOK_PLAYER_SHOOTING={Notes="Called when the player releases the mouse button to fire their bow."},
HOOK_PLAYER_SPAWNED={Notes="Called after the player entity has been created. The entity is fully initialized and is spawning in the {{cWorld|world}}."},
HOOK_PLAYER_TOSSING_ITEM={Notes="Called when the player is tossing the held item (keypress Q)"},
HOOK_PLAYER_USED_BLOCK={Notes="Called after the player has right-clicked a block"},
HOOK_PLAYER_USED_ITEM={Notes="Called after the player has right-clicked with a usable item in their hand."},
HOOK_PLAYER_USING_BLOCK={Notes="Called when the player is about to use (right-click) a block"},
HOOK_PLAYER_USING_ITEM={Notes="Called when the player is about to right-click with a usable item in their hand."},
HOOK_POST_CRAFTING={Notes="Called after a valid recipe has been chosen for the current contents of the crafting grid. Plugins may modify the recipe."},
HOOK_PRE_CRAFTING={Notes="Called before a recipe is searched for the current contents of the crafting grid. Plugins may provide a recipe and cancel the built-in search."},
HOOK_SPAWNED_ENTITY={Notes="Called after an entity is spawned in a {{cWorld|world}}. The entity is already part of the world."},
HOOK_SPAWNED_MONSTER={Notes="Called after a mob is spawned in a {{cWorld|world}}. The mob is already part of the world."},
HOOK_SPAWNING_ENTITY={Notes="Called just before an entity is spawned in a {{cWorld|world}}."},
HOOK_SPAWNING_MONSTER={Notes="Called just before a mob is spawned in a {{cWorld|world}}."},
HOOK_TAKE_DAMAGE={Notes="Called when an entity is taking any kind of damage. Plugins may modify the damage value, effects, source or cancel the damage."},
HOOK_TICK={Notes="Called when the main server thread ticks - 20 times a second."},
HOOK_UPDATED_SIGN={Notes="Called after a {{cSignEntity|sign}} text has been updated, either by a player or by any external means."},
HOOK_UPDATING_SIGN={Notes="Called before a {{cSignEntity|sign}} text is updated, either by a player or by any external means."},
HOOK_WEATHER_CHANGED={Notes="Called after the weather has changed."},
HOOK_WEATHER_CHANGING={Notes="Called just before the weather changes"},
HOOK_WORLD_TICK={Notes="Called in each world's tick thread when the game logic is about to tick (20 times a second)."},
ForEachPlayer={Params="CallbackFunction",Return="",Notes="Calls the given callback function for each player. The callback function has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cPlayer|cPlayer}})</pre>"},
ForEachWorld={Params="CallbackFunction",Return="",Notes="Calls the given callback function for each world. The callback function has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cWorld|cWorld}})</pre>"},
GetDefaultWorld={Params="",Return="{{cWorld|cWorld}}",Notes="Returns the world object from the default world."},
GetFurnaceRecipe={Params="",Return="{{cFurnaceRecipe|cFurnaceRecipe}}",Notes="Returns the cFurnaceRecipes object."},
GetGroupManager={Params="",Return="{{cGroupManager|cGroupManager}}",Notes="Returns the cGroupManager object."},
GetPluginManager={Params="",Return="{{cPluginManager|cPluginManager}}",Notes="Returns the cPluginManager object."},
GetPrimaryServerVersion={Params="",Return="number",Notes="Returns the servers primary server version."},
GetProtocolVersionTextFromInt={Params="Protocol Version",Return="string",Notes="Returns the Minecraft version from the given Protocol. If there is no version found, it returns 'Unknown protocol(Parameter)'"},
GetServer={Params="",Return="{{cServer|cServer}}",Notes="Returns the cServer object."},
GetTotalChunkCount={Params="",Return="number",Notes="Returns the amount of loaded chunks."},
GetWebAdmin={Params="",Return="{{cWebAdmin|cWebAdmin}}",Notes="Returns the cWebAdmin object."},
GetWorld={Params="WorldName",Return="{{cWorld|cWorld}}",Notes="Returns the cWorld object of the given world. It returns nil if there is no world with the given name."},
QueueExecuteConsoleCommand={Params="Message",Return="",Notes="Queues a console command for execution through the cServer class. The command will be executed in the tick thread The command's output will be sent to console "..'"stop" and "restart" commands have special handling.'},
GetWindowID={Params="",Return="number",Notes="Returns the ID of the window, as used by the network protocol"},
GetWindowTitle={Params="",Return="string",Notes="Returns the window title that will be displayed to the player"},
GetWindowType={Params="",Return="number",Notes="Returns the type of the window, one of the constants in the table above"},
IsSlotInPlayerHotbar={Params="number",Return="bool",Notes="Returns true if the specified slot number is in the player hotbar"},
IsSlotInPlayerInventory={Params="number",Return="bool",Notes="Returns true if the specified slot number is in the player's main inventory or in the hotbar. Note that this returns false for armor slots!"},
IsSlotInPlayerMainInventory={Params="number",Return="bool",Notes="Returns true if the specified slot number is in the player's main inventory"},
SetSlot={Params="{{cItem|cItem}}",Return="",Notes="Sets the contents of the specified slot for the specified player. Ignored if the slot number is invalid"},
SetWindowTitle={Params="string",Return="",Notes="Sets the window title that will be displayed to the player"},
BroadcastChat={Params="Message, [{{cClientHandle|ExcludeClient}}]",Return="",Notes="Sends the Message to all players in this world, except the optional ExceptClient"},
BroadcastSoundEffect={Params="SoundName, X, Y, Z, Volume, Pitch, [{{cClientHandle|ExcludeClient}}]",Return="",Notes="Sends the specified sound effect to all players in this world, except the optional ExceptClient"},
BroadcastSoundParticleEffect={Params="EffectID, X, Y, Z, EffectData, [{{cClientHandle|ExcludeClient}}]",Return="",Notes="Sends the specified effect to all players in this world, except the optional ExceptClient"},
CastThunderbolt={Params="X, Y, Z",Return="",Notes="Creates a thunderbolt at the specified coords"},
ChangeWeather={Params="",Return="",Notes="Forces the weather to change in the next game tick. Weather is changed according to the normal rules: wSunny <-> wRain <-> wStorm"},
CreateProjectile={Params="X, Y, Z, {{cProjectile|ProjectileKind}}, {{cEntity|Creator}}, [{{Vector3d|Speed}}]",Return="",Notes="Creates a new projectile of the specified kind at the specified coords. The projectile's creator is set to Creator (may be nil). Optional speed indicates the initial speed for the projectile."},
DigBlock={Params="X, Y, Z",Return="",Notes="Replaces the specified block with air, without dropping the usual pickups for the block. Wakes up the simulators for the block and its neighbors."},
DoExplosionAt={Params="Force, X, Y, Z, CanCauseFire, Source, SourceData",Return="",Notes="Creates an explosion of the specified relative force in the specified position. If CanCauseFire is set, the explosion will set blocks on fire, too. The Source parameter specifies the source of the explosion, one of the esXXX constants. The SourceData parameter is specific to each source type, usually it provides more info about the source."},
DoWithChestAt={Params="X, Y, Z, CallbackFunction, [CallbackData]",Return="bool",Notes="If there is a chest at the specified coords, calls the CallbackFunction with the {{cChestEntity}} parameter representing the chest. The CallbackFunction has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cChestEntity|ChestEntity}}, [CallbackData])</pre> The function returns false if there is no chest, or if there is, it returns the bool value that the callback has returned."},
DoWithDispenserAt={Params="X, Y, Z, CallbackFunction, [CallbackData]",Return="bool",Notes="If there is a dispenser at the specified coords, calls the CallbackFunction with the {{cDispenserEntity}} parameter representing the dispenser. The CallbackFunction has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cDispenserEntity|DispenserEntity}}, [CallbackData])</pre> The function returns false if there is no dispenser, or if there is, it returns the bool value that the callback has returned."},
DoWithDropSpenserAt={Params="X, Y, Z, CallbackFunction, [CallbackData]",Return="bool",Notes="If there is a dropper or a dispenser at the specified coords, calls the CallbackFunction with the {{cDropSpenserEntity}} parameter representing the dropper or dispenser. The CallbackFunction has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cDropSpenserEntity|DropSpenserEntity}}, [CallbackData])</pre> Note that this can be used to access both dispensers and droppers in a similar way. The function returns false if there is neither dispenser nor dropper, or if there is, it returns the bool value that the callback has returned."},
DoWithDropperAt={Params="X, Y, Z, CallbackFunction, [CallbackData]",Return="bool",Notes="If there is a dropper at the specified coords, calls the CallbackFunction with the {{cDropperEntity}} parameter representing the dropper. The CallbackFunction has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cDropperEntity|DropperEntity}}, [CallbackData])</pre> The function returns false if there is no dropper, or if there is, it returns the bool value that the callback has returned."},
DoWithEntityByID={Params="EntityID, CallbackFunction, [CallbackData]",Return="bool",Notes="If an entity with the specified ID exists, calls the callback with the {{cEntity}} parameter representing the entity. The CallbackFunction has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cEntity|Entity}}, [CallbackData])</pre> The function returns false if the entity was not found, and it returns the same bool value that the callback has returned if the entity was found."},
DoWithFurnaceAt={Params="X, Y, Z, CallbackFunction, [CallbackData]",Return="bool",Notes="If there is a furnace at the specified coords, calls the CallbackFunction with the {{cFurnaceEntity}} parameter representing the furnace. The CallbackFunction has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cFurnaceEntity|FurnaceEntity}}, [CallbackData])</pre> The function returns false if there is no furnace, or if there is, it returns the bool value that the callback has returned."},
DoWithPlayer={Params="PlayerName, CallbackFunction, [CallbackData]",Return="bool",Notes="If there is a player of the specified name (exact match), calls the CallbackFunction with the {{cPlayer}} parameter representing the player. The CallbackFunction has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cPlayer|Player}}, [CallbackData])</pre> The function returns false if the player was not found, or whatever bool value the callback returned if the player was found."},
{Params="X, Y, Z, BlockType, BlockMeta",Return="",Notes="Sets the block at the specified coords, without waking up the simulators or replacing the block entities for the previous block type. Do not use if the block being replaced has a block entity tied to it!"},
{Params="{{Vector3i|BlockCoords}}, BlockType, BlockMeta",Return="",Notes="Sets the block at the specified coords, without waking up the simulators or replacing the block entities for the previous block type. Do not use if the block being replaced has a block entity tied to it!"},
FindAndDoWithPlayer={Params="PlayerNameHint, CallbackFunction, [CallbackData]",Return="bool",Notes="If there is a player of a name similar to the specified name (weighted-match), calls the CallbackFunction with the {{cPlayer}} parameter representing the player. The CallbackFunction has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cPlayer|Player}}, [CallbackData])</pre> The function returns false if the player was not found, or whatever bool value the callback returned if the player was found. Note that the name matching is very loose, so it is a good idea to check the player name in the callback function."},
ForEachChestInChunk={Params="ChunkX, ChunkZ, CallbackFunction, [CallbackData]",Return="bool",Notes="Calls the specified callback for each chest in the chunk. Returns true if all chests in the chunk have been processed (including when there are zero chests), or false if the callback has aborted the enumeration by returning true. The CallbackFunction has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cChestEntity|ChestEntity}}, [CallbackData])</pre> The callback should return false or no value to continue with the next chest, or true to abort the enumeration."},
ForEachEntity={Params="CallbackFunction, [CallbackData]",Return="bool",Notes="Calls the specified callback for each entity in the loaded world. Returns true if all the entities have been processed (including when there are zero entities), or false if the callback function has aborted the enumeration by returning true. The callback function has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cEntity|Entity}}, [CallbackData])</pre> The callback should return false or no value to continue with the next entity, or true to abort the enumeration."},
ForEachEntityInChunk={Params="ChunkX, ChunkZ, CallbackFunction, [CallbackData]",Return="bool",Notes="Calls the specified callback for each entity in the specified chunk. Returns true if all the entities have been processed (including when there are zero entities), or false if the chunk is not loaded or the callback function has aborted the enumeration by returning true. The callback function has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cEntity|Entity}}, [CallbackData])</pre> The callback should return false or no value to continue with the next entity, or true to abort the enumeration."},
ForEachFurnaceInChunk={Params="ChunkX, ChunkZ, CallbackFunction, [CallbackData]",Return="bool",Notes="Calls the specified callback for each furnace in the chunk. Returns true if all furnaces in the chunk have been processed (including when there are zero furnaces), or false if the callback has aborted the enumeration by returning true. The CallbackFunction has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cFurnaceEntity|FurnaceEntity}}, [CallbackData])</pre> The callback should return false or no value to continue with the next furnace, or true to abort the enumeration."},
ForEachPlayer={Params="CallbackFunction, [CallbackData]",Return="bool",Notes="Calls the specified callback for each player in the loaded world. Returns true if all the players have been processed (including when there are zero players), or false if the callback function has aborted the enumeration by returning true. The callback function has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cPlayer|Player}}, [CallbackData])</pre> The callback should return false or no value to continue with the next player, or true to abort the enumeration."},
GenerateChunk={Params="ChunkX, ChunkZ",Return="",Notes="Queues the specified chunk in the chunk generator. Ignored if the chunk is already generated (use RegenerateChunk() to force chunk re-generation)."},
GetBiomeAt={Params="BlockX, BlockZ",Return="eBiome",Notes="Returns the biome at the specified coords. Reads the biome from the chunk, if it is loaded, otherwise it uses the chunk generator to provide the biome value."},
{Params="BlockX, BlockY, BlockZ",Return="BLOCKTYPE",Notes="Returns the block type of the block at the specified coords, or 0 if the appropriate chunk is not loaded."},
{Params="{{Vector3i|BlockCoords}}",Return="BLOCKTYPE",Notes="Returns the block type of the block at the specified coords, or 0 if the appropriate chunk is not loaded."},
GetBlockBlockLight={Params="BlockX, BlockY, BlockZ",Return="number",Notes="Returns the amount of block light at the specified coords, or 0 if the appropriate chunk is not loaded."},
GetBlockInfo={Params="BlockX, BlockY, BlockZ",Return="BlockValid, BlockType, BlockMeta, BlockSkyLight, BlockBlockLight",Notes="Returns the complete block info for the block at the specified coords. The first value specifies if the block is in a valid loaded chunk, the other values are valid only if BlockValid is true."},
{Params="BlockX, BlockY, BlockZ",Return="number",Notes="Returns the block metadata of the block at the specified coords, or 0 if the appropriate chunk is not loaded."},
{Params="{{Vector3i|BlockCoords}}",Return="number",Notes="Returns the block metadata of the block at the specified coords, or 0 if the appropriate chunk is not loaded."},
GetBlockSkyLight={Params="BlockX, BlockY, BlockZ",Return="number",Notes="Returns the block skylight of the block at the specified coords, or 0 if the appropriate chunk is not loaded."},
GetBlockTypeMeta={Params="BlockX, BlockY, BlockZ",Return="BlockValid, BlockType, BlockMeta",Notes="Returns the block type and metadata for the block at the specified coords. The first value specifies if the block is in a valid loaded chunk, the other values are valid only if BlockValid is true."},
GetClassStatic={Params="",Return="string",Notes="Returns the name of the class, \"cWorld\"."},
GetDimension={Params="",Return="eDimension",Notes="Returns the dimension of the world - dimOverworld, dimNether or dimEnd."},
GetGameMode={Params="",Return="eGameMode",Notes="Returns the gamemode of the world - gmSurvival, gmCreative or gmAdventure."},
GetGeneratorQueueLength={Params="",Return="number",Notes="Returns the number of chunks that are queued in the chunk generator."},
GetHeight={Params="BlockX, BlockZ",Return="number",Notes="Returns the maximum height of the particula block column in the world. If the chunk is not loaded, it waits for it to load / generate. <b>WARNING</b>: Do not use, Use TryGetHeight() instead for a non-waiting version, otherwise you run the risk of a deadlock!"},
GetIniFileName={Params="",Return="string",Notes="Returns the name of the world.ini file that the world uses to store the information."},
GetLightingQueueLength={Params="",Return="number",Notes="Returns the number of chunks in the lighting thread's queue."},
GetMaxCactusHeight={Params="",Return="number",Notes="Returns the configured maximum height to which cacti will grow naturally."},
GetMaxSugarcaneHeight={Params="",Return="number",Notes="Returns the configured maximum height to which sugarcane will grow naturally."},
GetName={Params="",Return="string",Notes="Returns the name of the world, as specified in the settings.ini file."},
GetNumChunks={Params="",Return="number",Notes="Returns the number of chunks currently loaded."},
GetSignLines={Params="BlockX, BlockY, BlockZ",Return="IsValid, [Line1, Line2, Line3, Line4]",Notes="Returns true and the lines of a sign at the specified coords, or false if there is no sign at the coords."},
GetSpawnX={Params="",Return="number",Notes="Returns the X coord of the default spawn"},
GetSpawnY={Params="",Return="number",Notes="Returns the Y coord of the default spawn"},
GetSpawnZ={Params="",Return="number",Notes="Returns the Z coord of the default spawn"},
GetStorageLoadQueueLength={Params="",Return="number",Notes="Returns the number of chunks queued up for loading"},
GetStorageSaveQueueLength={Params="",Return="number",Notes="Returns the number of chunks queued up for saving"},
GetTicksUntilWeatherChange={Params="",Return="number",Notes="Returns the number of ticks that will pass before the weather is changed"},
GetTimeOfDay={Params="",Return="number",Notes="Returns the number of ticks that have passed from the sunrise, 0 .. 24000."},
GetWeather={Params="",Return="eWeather",Notes="Returns the current weather in the world (wSunny, wRain, wStorm). To check for weather, use IsWeatherXXX() functions instead."},
GetWorldAge={Params="",Return="number",Notes="Returns the total age of the world, in ticks. The age always grows, cannot be set by plugins and is unrelated to TimeOfDay."},
GrowCactus={Params="BlockX, BlockY, BlockZ, NumBlocksToGrow",Return="",Notes="Grows a cactus block at the specified coords, by up to the specified number of blocks. Adheres to the world's maximum cactus growth (GetMaxCactusHeight())."},
GrowMelonPumpkin={Params="BlockX, BlockY, BlockZ, StemType",Return="",Notes="Grows a melon or pumpkin, based on the stem type specified (assumed to be in the coords provided). Checks for normal melon / pumpkin growth conditions - stem not having another produce next to it and suitable ground below."},
GrowRipePlant={Params="BlockX, BlockY, BlockZ, IsByBonemeal",Return="bool",Notes="Grows the plant at the specified coords. If IsByBonemeal is true, checks first if the specified plant type is bonemealable in the settings. Returns true if the plant was grown, false if not."},
GrowSugarcane={Params="BlockX, BlockY, BlockZ, NumBlocksToGrow",Return="",Notes="Grows a sugarcane block at the specified coords, by up to the specified number of blocks. Adheres to the world's maximum sugarcane growth (GetMaxSugarcaneHeight())."},
GrowTree={Params="BlockX, BlockY, BlockZ",Return="",Notes="Grows a tree based at the specified coords. If there is a sapling there, grows the tree based on that sapling, otherwise chooses a tree image based on the biome."},
GrowTreeByBiome={Params="BlockX, BlockY, BlockZ",Return="",Notes="Grows a tree based at the specified coords. The tree type is picked from types available for the biome at those coords."},
GrowTreeFromSapling={Params="BlockX, BlockY, BlockZ, SaplingMeta",Return="",Notes="Grows a tree based at the specified coords. The tree type is determined from the sapling meta (the sapling itself needn't be present)."},
IsBlockDirectlyWatered={Params="BlockX, BlockY, BlockZ",Return="bool",Notes="Returns true if the specified block has a water block right next to it (on the X/Z axes)"},
IsDeepSnowEnabled={Params="",Return="bool",Notes="Returns whether the configuration has DeepSnow enabled."},
IsGameModeAdventure={Params="",Return="bool",Notes="Returns true if the current gamemode is gmAdventure."},
IsGameModeCreative={Params="",Return="bool",Notes="Returns true if the current gamemode is gmCreative."},
IsGameModeSurvival={Params="",Return="bool",Notes="Returns true if the current gamemode is gmSurvival."},
IsPVPEnabled={Params="",Return="bool",Notes="Returns whether PVP is enabled in the world settings."},
QueueBlockForTick={Params="BlockX, BlockY, BlockZ, TicksToWait",Return="",Notes="Queues the specified block to be ticked after the specified number of gameticks."},
QueueSaveAllChunks={Params="",Return="",Notes="Queues all chunks to be saved in the world storage thread"},
QueueSetBlock={Params="BlockX, BlockY, BlockZ, BlockType, BlockMeta, TickDelay",Return="",Notes="Queues the block to be set to the specified blocktype and meta after the specified amount of game ticks. Uses SetBlock() for the actual setting, so simulators are woken up and block entities are handled correctly."},
RegenerateChunk={Params="ChunkX, ChunkZ",Return="",Notes="Queues the specified chunk to be re-generated, overwriting the current data. To queue a chunk for generating only if it doesn't exist, use the GenerateChunk() instead."},
SendBlockTo={Params="BlockX, BlockY, BlockZ, {{cPlayer|Player}}",Return="",Notes="Sends the block at the specified coords to the specified player's client, as an UpdateBlock packet."},
SetBlock={Params="BlockX, BlockY, BlockZ, BlockType, BlockMeta",Return="",Notes="Sets the block at the specified coords, replaces the block entities for the previous block type, creates a new block entity for the new block, if appropriate, and wakes up the simulators. This is the preferred way to set blocks, as opposed to FastSetBlock(), which is only to be used under special circumstances."},
SetBlockMeta=
{
{Params="BlockX, BlockY, BlockZ, BlockMeta",Return="",Notes="Sets the meta for the block at the specified coords."},
{Params="{{Vector3i|BlockCoords}}, BlockMeta",Return="",Notes="Sets the meta for the block at the specified coords."},
},
SetNextBlockTick={Params="BlockX, BlockY, BlockZ",Return="",Notes="Sets the blockticking to start at the specified block in the next tick."},
SetSignLines={Params="X, Y, Z, Line1, Line2, Line3, Line4, [{{cPlayer|Player}}]",Return="",Notes="Sets the sign text at the specified coords. The sign-updating hooks are called for the change. The Player parameter is used to indicate the player from whom the change has come, it may be nil. Same as UpdateSign()."},
SetTicksUntilWeatherChange={Params="NumTicks",Return="",Notes="Sets the number of ticks after which the weather will be changed."},
SetTimeOfDay={Params="TimeOfDayTicks",Return="",Notes="Sets the time of day, expressed as number of ticks past sunrise, in the range 0 .. 24000."},
SetWeather={Params="Weather",Return="",Notes="Sets the current weather (wSunny, wRain, wStorm) and resets the TicksUntilWeatherChange to the default value for the new weather. The normal weather-changing hooks are called for the change."},
SpawnItemPickups=
{
{Params="{{cItems|Pickups}}, X, Y, Z, FlyAwaySpeed",Return="",Notes="Spawns the specified pickups at the position specified. The FlyAway speed is used to initialize the random speed in which the pickups fly away from the spawn position."},
{Params="{{cItems|Pickups}}, X, Y, Z, SpeedX, SpeedY, SpeedZ",Return="",Notes="Spawns the specified pickups at the position specified. All the pickups fly away from the spawn position using the specified speed."},
},
SpawnMob={Params="X, Y, Z, {{cMonster|MonsterType}}",Return="EntityID",Notes="Spawns the specified type of mob at the specified coords. Returns the EntityID of the creates entity, or -1 on failure. "},
SpawnPrimedTNT={Params="X, Y, Z, FuseTimeSecs, InitialVelocityCoeff",Return="",Notes="Spawns a {{cTNTEntity|primed TNT entity}} at the specified coords, with the given fuse time. The entity gets a random speed multiplied by the InitialVelocityCoeff, 1 being the default value."},
TryGetHeight={Params="BlockX, BlockZ",Return="IsValid, Height",Notes="Returns true and height of the highest non-air block if the chunk is loaded, or false otherwise."},
UnloadUnusedChunks={Params="",Return="",Notes="Unloads chunks that are no longer needed, and are saved. NOTE: This API is deprecated and will be removed soon."},
UpdateSign={Params="X, Y, Z, Line1, Line2, Line3, Line4, [{{cPlayer|Player}}]",Return="",Notes="Sets the sign text at the specified coords. The sign-updating hooks are called for the change. The Player parameter is used to indicate the player from whom the change has come, it may be nil. Same as SetSignLiens()"},
UseBlockEntity={Params="{{cPlayer|Player}}, BlockX, BlockY, BlockZ",Return="",Notes="Makes the specified Player use the block entity at the specified coords (open chest UI, etc.) If the cords are in an unloaded chunk or there's no block entity, ignores the call."},
WakeUpSimulators={Params="BlockX, BlockY, BlockZ",Return="",Notes="Wakes up the simulators for the specified block."},
WakeUpSimulatorsInArea={Params="MinBlockX, MaxBlockX, MinBlockY, MaxBlockY, MinBlockZ, MaxBlockZ",Return="",Notes="Wakes up the simulators for all the blocks in the specified area (edges inclusive)."},
Desc=[[These functions are available directly, without a class instance. Any plugin cal call them at any time.]],
Functions=
{
AddFaceDirection={Params="BlockX, BlockY, BlockZ, BlockFace, Inverse",Return="BlockX, BlockY, BlockZ",Notes="Returns the coords of a block adjacent to the specified block through the specified face"},
BlockStringToType={Params="BlockTypeString",Return="BLOCKTYPE",Notes="Returns the block type parsed from the given string"},
ClickActionToString={Params="ClickAction",Return="string",Notes="Returns a string description of the ClickAction enumerated value"},
DamageTypeToString={Params="{{TakeDamageInfo|eDamageType}}",Return="string",Notes="Converts a damage type enumerated value to a string representation "},
EscapeString={Params="string",Return="string",Notes="Returns a copy of the string with all quotes and backslashes escaped by a backslash"},
GetChar={Params="String, Pos",Return="string",Notes="Returns one character from the string, specified by position "},
GetTime={Return="number",Notes="Returns the current OS time, as a unix time stamp (number of seconds since Jan 1, 1970)"},
IsValidBlock={Params="BlockType",Return="bool",Notes="Returns true if BlockType is a known block type"},
IsValidItem={Params="ItemType",Return="bool",Notes="Returns true if ItemType is a known item type"},
ItemToFullString={Params="{{cItem|cItem}}",Return="string",Notes="Returns the string representation of the item, in the format <20>ItemTypeText:ItemDamage * Count<6E>"},
ItemToString={Params="{{cItem|cItem}}",Return="string",Notes="Returns the string representation of the item type"},
ItemTypeToString={Params="ItemType",Return="string",Notes="Returns the string representation of ItemType "},
LOG={Params="string",Notes="Logs a text into the server console using <20>normal<61> severity (gray text) "},
LOGERROR={Params="string",Notes="Logs a text into the server console using <20>error<6F> severity (black text on red background)"},
LOGINFO={Params="string",Notes="Logs a text into the server console using <20>info<66> severity (yellow text)"},
LOGWARN={Params="string",Notes="Logs a text into the server console using <20>warning<6E> severity (red text); OBSOLETE"},
LOGWARNING={Params="string",Notes="Logs a text into the server console using <20>warning<6E> severity (red text)"},
NoCaseCompare={Params="string, string",Return="number",Notes="Case-insensitive string comparison; returns 0 if the strings are the same"},
ReplaceString={Params="full-string, to-be-replaced-string, to-replace-string",Notes="Replaces *each* occurence of to-be-replaced-string in full-string with to-replace-string"},
StringSplit={Params="string, Seperator",Return="list",Notes="Seperates string into multiple by splitting every time Seperator is encountered."},
StringToBiome={Params="string",Return="EMCSBiome",Notes="Converts a string representation to a biome enumerated value"},
StringToDamageType={Params="string",Return="{{TakeDamageInfo|eDamageType}}",Notes="Converts a string representation to an {{TakeDamageInfo|eDamageType}} enumerated value "},
StringToDimension={Params="string",Return="eDimension",Notes="Converts a string representation to an eDimension enumerated value"},
StringToItem={Params="string, {{cItem|cItem}}",Return="bool",Notes="Parses the given string and sets the item; returns true if successful"},
StringToMobType={Params="string",Return="number",Notes="Converts a string representation to a mob enumerated value"},
StripColorCodes={Params="string",Return="string",Notes="Removes all control codes used by MC for colors and styles"},
CalledWhen="A block is about to be dug ({{cPlayer|player}}, {{cEntity|entity}} or natural reason), plugins may override what pickups that will produce.",
DefaultFnName="OnBlockToPickups",-- also used as pagename
{Name="World",Type="{{cWorld}}",Notes="The world in which the block resides"},
{Name="Digger",Type="{{cEntity}} descendant",Notes="The entitycausing the digging. May be a {{cPlayer}}, {{cTNTEntity}} or even nil (natural causes)"},
{Name="BlockX",Type="number",Notes="X-coord of the block"},
{Name="BlockY",Type="number",Notes="Y-coord of the block"},
{Name="BlockZ",Type="number",Notes="Z-coord of the block"},
{Name="BlockType",Type="BLOCKTYPE",Notes="Block type of the block"},
{Name="BlockMeta",Type="NIBBLETYPE",Notes="Block meta of the block"},
{Name="Pickups",Type="{{cItems}}",Notes="Items that will be spawned as pickups"},
Desc="This example callback function generates one block of emerald ore in each chunk, under the condition that the randomly chosen location is in an ExtremeHills biome.",
