The following code is taken from the Debuggers plugin, it creates a sign at each chunk's [0, 0] coords, with the text being the chunk coords:
function OnChunkGenerated(a_World, a_ChunkX, a_ChunkZ, a_ChunkDesc)
-- Get the topmost block coord:
local Height = a_ChunkDesc:GetHeight(0, 0);
-- Create a sign there:
a_ChunkDesc:SetBlockTypeMeta(0, Height + 1, 0, E_BLOCK_SIGN_POST, 0);
local BlockEntity = a_ChunkDesc:GetBlockEntity(0, Height + 1, 0);
if (BlockEntity ~= nil) then
LOG("Setting sign lines...");
local SignEntity = tolua.cast(BlockEntity, "cSignEntity");
SignEntity:SetLines("Chunk:", tonumber(a_ChunkX) .. ", " .. tonumber(a_ChunkZ), "", "(Debuggers)");
end
-- Update the heightmap:
a_ChunkDesc:SetHeight(0, 0, Height + 1);
end
]],
},
},
},
cClientHandle =
{
Desc = [[
A cClientHandle represents the technical aspect of a connected player - their game client
connection. Internally, it handles all the incoming and outgoing packets, the chunks that are to be
sent to the client, ping times etc.
]],
Functions =
{
GenerateOfflineUUID =
{
IsStatic = true,
Params =
{
{
Name = "Username",
Type = "string",
},
},
Returns =
{
{
Type = "string",
},
},
Notes = "Generates an UUID based on the player name provided. This is used for the offline (non-auth) mode, when there's no UUID source. Each username generates a unique and constant UUID, so that when the player reconnects with the same name, their UUID is the same. Returns a 32-char UUID (no dashes).",
},
GetClientBrand =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the brand that the client has sent in their MC|Brand plugin message.",
},
GetForgeMods =
{
Returns =
{
{
Type = "table",
},
},
Notes = "Returns the Forge mods installed on the client.",
},
GetIPString =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the IP address of the connection, as a string. Only the address part is returned, without the port number.",
},
GetLocale =
{
Returns =
{
{
Name = "Locale",
Type = "string",
},
},
Notes = "Returns the locale string that the client sends as part of the protocol handshake. Can be used to provide localized strings.",
},
GetPing =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the ping time, in ms",
},
GetPlayer =
{
Returns =
{
{
Type = "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.",
},
GetProtocolVersion =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the protocol version number of the protocol that the client is talking. Returns zero if the protocol version is not (yet) known.",
},
GetRequestedViewDistance =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the view distance that the player request, not the used view distance.",
},
GetUniqueID =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the UniqueID of the client used to identify the client in the server",
},
GetUsername =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the username that the client has provided",
},
GetUUID =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the authentication-based UUID of the client. This UUID should be used to identify the player when persisting any player-related data. Returns a 32-char UUID (no dashes)",
},
GetViewDistance =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the viewdistance (number of chunks loaded for the player in each direction)",
},
HasPluginChannel =
{
Params =
{
{
Name = "ChannelName",
Type = "string",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the client has registered to receive messages on the specified plugin channel.",
},
IsForgeClient =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the client is modded with Forge.",
},
IsUUIDOnline =
{
IsStatic = true,
Params =
{
{
Name = "UUID",
Type = "cUUID",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the UUID is generated by online auth, false if it is an offline-generated UUID. We use Version-3 UUIDs for offline UUIDs, online UUIDs are Version-4, thus we can tell them apart. Accepts both 32-char and 36-char UUIDs (with and without dashes).",
},
Kick =
{
Params =
{
{
Name = "Reason",
Type = "string",
},
},
Notes = "Kicks the user with the specified reason",
},
SendBlockChange =
{
Params =
{
{
Name = "BlockX",
Type = "number",
},
{
Name = "BlockY",
Type = "number",
},
{
Name = "BlockZ",
Type = "number",
},
{
Name = "BlockType",
Type = "number",
},
{
Name = "BlockMeta",
Type = "number",
},
},
Notes = "Sends a BlockChange packet to the client. This can be used to create fake blocks only for that player.",
},
SendBossBarAdd =
{
Params =
{
{
Name = "UniqueID",
Type = "number",
},
{
Name = "Title",
Type = "cCompositeChat",
},
{
Name = "FractionFilled",
Type = "number",
},
{
Name = "Colour",
Type = "BossBarColor",
},
{
Name = "DivisionType",
Type = "BossBarDivisionType",
},
{
Name = "DarkenSky",
Type = "boolean",
},
{
Name = "PlayEndMusic",
Type = "boolean",
},
{
Name = "CreateFog",
Type = "boolean",
},
},
Notes = "Creates a boss bar on the client's UI. The boss bar is independent of any entity and has a lifetime and properties fully controlled by the plugin. Plugins are responsible for assigning a unique ID and removal.",
},
SendBossBarUpdateFlags =
{
Params =
{
{
Name = "UniqueID",
Type = "number",
},
{
Name = "DarkenSky",
Type = "boolean",
},
{
Name = "PlayEndMusic",
Type = "boolean",
},
{
Name = "CreateFog",
Type = "boolean",
},
},
Notes = "Updates a boss bar on the client's UI. Only updates some meta flags for additional effects.",
},
SendBossBarUpdateStyle =
{
Params =
{
{
Name = "UniqueID",
Type = "number",
},
{
Name = "Color",
Type = "BossBarColor",
},
{
Name = "DivisionType",
Type = "BossBarDivisionType",
},
},
Notes = "Updates a boss bar on the client's UI. Only updates the visuals of the Boss Bar.",
},
SendBossBarUpdateTitle =
{
Params =
{
{
Name = "UniqueID",
Type = "number",
},
{
Name = "Title",
Type = "cCompositeChat",
},
},
Notes = "Updates a boss bar on the client's UI. Only Updates the text at the top.",
},
SendBossBarRemove =
{
Params =
{
{
Name = "UniqueID",
Type = "number",
},
},
Notes = "Removes the boss bar with the given ID from the client's UI.",
},
SendBossBarUpdateHealth =
{
Params =
{
{
Name = "UniqueID",
Type = "number",
},
{
Name = "FractionFilled",
Type = "number",
},
},
Notes = "Updates the health displayed by the boss bar with the given ID.",
},
SendEntityAnimation =
{
Params =
{
{
Name = "Entity",
Type = "cEntity",
},
{
Name = "AnimationNumber",
Type = "number",
},
},
Notes = "Sends the specified animation of the specified entity to the client. The AnimationNumber is protocol-specific.",
},
SendPlayerListHeaderFooter =
{
Params =
{
{
Type = "cCompositeChat",
Name = "Header",
},
{
Type = "cCompositeChat",
Name = "Footer",
},
},
Desc = "Sends the header and footer of the player list to the client.",
},
SendHideTitle =
{
Notes = "Hides the title. This makes the title and subtitle disappear, but if you call SendTitleTimes() the same title and subtitle will appear again."
},
SendPluginMessage =
{
Params =
{
{
Name = "Channel",
Type = "string",
},
{
Name = "Message",
Type = "string",
},
},
Notes = "Sends the plugin message on the specified channel.",
},
SendResetTitle =
{
Notes = "Resets and hides the title but not the subtitle."
},
SendSetSubTitle =
{
Params =
{
{
Name = "SubTitle",
Type = "cCompositeChat",
},
},
Notes = "Sends the subtitle to the client. Doesn't make the client display it yet, use SendTitleTimes() to show both the title and the subtitle."
},
SendSetRawSubTitle =
{
Params =
{
{
Name = "SubTitle",
Type = "string",
},
},
Notes = "Sends the raw subtitle to the client. Doesn't make the client display it yet, use SendTitleTimes() to show both the title and the subtitle."
},
SendSetTitle =
{
Params =
{
{
Name = "Title",
Type = "cCompositeChat",
},
},
Notes = "Sends the title to the client. Doesn't make the client display it yet, use SendTitleTimes() to show both the title and the subtitle."
},
SendSetRawTitle =
{
Params =
{
{
Name = "Title",
Type = "string",
},
},
Notes = "Sends the raw title to the client. Doesn't make the client display it yet, use SendTitleTimes() to show both the title and the subtitle."
},
SendSoundEffect =
{
Params =
{
{
Name = "SoundName",
Type = "string",
},
{
Name = "Position",
Type = "Vector3d",
},
{
Name = "Volume",
Type = "number",
},
{
Name = "Pitch",
Type = "number",
},
},
Notes = "Sends a sound effect request to the client. The sound is played at the specified coords, with the specified volume (a float, 1.0 is full volume, can be more) and pitch (0-255, 63 is 100%)",
},
SendSoundEffect =
{
Params =
{
{
Name = "SoundName",
Type = "string",
},
{
Name = "X",
Type = "number",
},
{
Name = "Y",
Type = "number",
},
{
Name = "Z",
Type = "number",
},
{
Name = "Volume",
Type = "number",
},
{
Name = "Pitch",
Type = "number",
},
},
Notes = "Sends a sound effect request to the client. The sound is played at the specified coords, with the specified volume (a float, 1.0 is full volume, can be more) and pitch (0-255, 63 is 100%) (DEPRECATED, use vector-parametered version instead)",
},
SendTitleTimes =
{
Params =
{
{
Name = "FadeInTicks",
Type = "number",
},
{
Name = "DisplayTicks",
Type = "number",
},
{
Name = "FadeOutTicks",
Type = "number",
},
},
Notes = "Sends the request to display the title and subtitle, previously set with SendSetTitle, SendSetRawTitle, SendSetSubTitle and SendSetRawSubTitle, to the client."
},
SendTimeUpdate =
{
Params =
{
{
Name = "WorldAge",
Type = "number",
},
{
Name = "WorldDate",
Type = "number",
},
{
Name = "DoDaylightCycle",
Type = "boolean",
},
},
Notes = "Sends the specified time update to the client. WorldAge is the total age of the world, in ticks. WorldDate is the current date, in ticks, and is used by the client to calculate the days elapsed (F3 debug overlay's day count) and the time of day (rendered sun position). DoDaylightCycle is a bool that specifies whether the client should automatically move the sun (true) or keep it in the same place (false).",
},
SetClientBrand =
{
Params =
{
{
Name = "ClientBrand",
Type = "string",
},
},
Notes = "Sets the value of the client's brand. Normally this value is received from the client by a MC|Brand plugin message, this function lets plugins overwrite the value.",
},
SetLocale =
{
Params =
{
{
Name = "Locale",
Type = "string",
},
},
Notes = "Sets the locale that Cuberite keeps on record. Initially the locale is initialized in protocol handshake, this function allows plugins to override the stored value (but only server-side and only until the user disconnects).",
},
SetViewDistance =
{
Params =
{
{
Name = "ViewDistance",
Type = "number",
},
},
Notes = "Sets the viewdistance (number of chunks loaded for the player in each direction)",
},
},
Constants =
{
MAX_VIEW_DISTANCE =
{
Notes = "The maximum value of the view distance",
},
MIN_VIEW_DISTANCE =
{
Notes = "The minimum value of the view distance",
},
},
},
cColor =
{
Desc = [[
Encapsulates a RGB color, e.g. for armor.
]],
Functions =
{
Clear =
{
Notes = "Resets the color to uninitialized."
},
constructor =
{
{
Returns = { {Type="cColor"} },
Notes = "Creates an uninitialized cColor. Each component must be between 0 and 255, inclusive.",
},
{
Params =
{
{
Name = "Red",
Type = "number",
},
{
Name = "Green",
Type = "number",
},
{
Name = "Blue",
Type = "number",
},
},
Returns = { {Type="cColor"} },
Notes = "Creates the specified cColor. All components must be between 0 and 255, inclusive.",
},
},
GetColor =
{
Returns =
{
{
Name = "Red",
Type = "number",
},
{
Name = "Green",
Type = "number",
},
{
Name = "Blue",
Type = "number",
},
},
Notes = "Returns the color's red, green, and blue components, respectively."
},
GetRed =
{
Returns =
{
{
Name = "Red",
Type = "number",
},
},
Notes = "Returns the color's red component."
},
GetGreen =
{
Returns =
{
{
Name = "Green",
Type = "number",
},
},
Notes = "Returns the color's green component."
},
GetBlue =
{
Returns =
{
{
Name = "Blue",
Type = "number",
},
},
Notes = "Returns the color's blue component."
},
IsValid =
{
Returns =
{
{
Type = "boolean"
},
},
Notes = "True if the color is valid, false if the color has not been set yet."
},
SetColor =
{
Params =
{
{
Name = "Red",
Type = "number"
},
{
Name = "Green",
Type = "number"
},
{
Name = "Blue",
Type = "number"
},
},
Notes = "Sets the color's red, green, and blue components. Values range from 0 to 255."
},
SetRed =
{
Params =
{
{
Name = "Red",
Type = "number",
},
},
Notes = "Sets the color's red component. Must be between 0 and 255, inclusive."
},
SetGreen =
{
Params =
{
{
Name = "Green",
Type = "number",
},
},
Notes = "Sets the color's green component. Must be between 0 and 255, inclusive."
},
SetBlue =
{
Params =
{
{
Name = "Blue",
Type = "number",
},
},
Notes = "Sets the color's blue component. Must be between 0 and 255, inclusive."
},
},
Constants =
{
COLOR_LIMIT =
{
Notes = "The upper bound (exclusive) for a color component",
},
COLOR_MAX =
{
Notes = "The maximum value for a color component",
},
COLOR_MIN =
{
Notes = "The minimum value for a color component",
},
COLOR_NONE =
{
Notes = "A constant denoting the color is invalid (note: use IsValid)",
},
},
},
cCompositeChat =
{
Desc = [[
Encapsulates a chat message that can contain various formatting, URLs, commands executed on click
and commands suggested on click. The chat message can be sent by the regular chat-sending functions,
{{cPlayer}}:SendMessage(), {{cWorld}}:BroadcastChat() and {{cRoot}}:BroadcastChat().
Note that most of the functions in this class are so-called chaining modifiers - they modify the object and then return the object itself, so that they can be chained one after another. See the Chaining example below for details.
Each part of the composite chat message takes a "Style" parameter, this is a string that describes the formatting. It uses the following strings, concatenated together:
| String | Style |
|---|---|
| b | Bold text |
| i | Italic text |
| u | Underlined text |
| s | Strikethrough text |
| o | Obfuscated text |
| @X | color [0–9a–f], same as dye meta |
]],
Functions =
{
AddRunCommandPart =
{
Params =
{
{
Name = "Text",
Type = "string",
},
{
Name = "Command",
Type = "string",
},
{
Name = "Style",
Type = "string",
IsOptional = true,
},
},
Returns =
{
{
Type = "self",
},
},
Notes = "Adds a text which, when clicked, runs the specified command. Chaining.",
},
AddShowAchievementPart =
{
Params =
{
{
Name = "PlayerName",
Type = "string",
},
{
Name = "AchievementName",
Type = "string",
},
{
Name = "Style",
Type = "string",
IsOptional = true,
},
},
Notes = "Adds a text that represents the 'Achievement get' message.",
},
AddSuggestCommandPart =
{
Params =
{
{
Name = "Text",
Type = "string",
},
{
Name = "Command",
Type = "string",
},
{
Name = "Style",
Type = "string",
IsOptional = true,
},
},
Returns =
{
{
Type = "self",
},
},
Notes = "Adds a text which, when clicked, puts the specified command into the player's chat input area. Chaining.",
},
AddTextPart =
{
Params =
{
{
Name = "Text",
Type = "string",
},
{
Name = "Style",
Type = "string",
IsOptional = true,
},
},
Returns =
{
{
Type = "self",
},
},
Notes = "Adds a regular text. Chaining.",
},
AddUrlPart =
{
Params =
{
{
Name = "Text",
Type = "string",
},
{
Name = "Url",
Type = "string",
},
{
Name = "Style",
Type = "string",
IsOptional = true,
},
},
Returns =
{
{
Type = "self",
},
},
Notes = "Adds a text which, when clicked, opens up a browser at the specified URL. Chaining.",
},
Clear =
{
Returns =
{
{
Type = "self",
},
},
Notes = "Removes all parts from this object",
},
constructor =
{
{
Returns = { {Type = "cCompositeChat"} },
Notes = "Creates an empty chat message",
},
{
Params =
{
{
Name = "Text",
Type = "string",
},
{
Name = "MessageType",
Type = "eMessageType",
IsOptional = true,
},
},
Returns = { {Type = "cCompositeChat"} },
Notes = "Creates a chat message containing the specified text, parsed by the ParseText() function. This allows easy migration from old chat messages.",
},
},
CreateJsonString =
{
Params =
{
{
Name = "AddPrefixes",
Type = "boolean",
IsOptional = true,
},
},
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the entire object serialized into JSON, as it would be sent to a client. AddPrefixes specifies whether the chat prefixes should be prepended to the message, true by default.",
},
ExtractText =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the text from the parts that comprises the human-readable data. Used for older protocols that don't support composite chat, and for console-logging.",
},
GetAdditionalMessageTypeData =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the AdditionalData associated with the message, such as the sender's name for mtPrivateMessage",
},
GetMessageType =
{
Returns =
{
{
Type = "eMessageType",
},
},
Notes = "Returns the MessageType (mtXXX constant) that is associated with this message. When sent to a player, the message will be formatted according to this message type and the player's settings (adding \"[INFO]\" prefix etc.)",
},
ParseText =
{
Params =
{
{
Name = "Text",
Type = "string",
},
},
Returns =
{
{
Type = "self",
},
},
Notes = "Adds text, while recognizing http and https URLs and old-style formatting codes (\"@2\"). Chaining.",
},
SetMessageType =
{
Params =
{
{
Name = "MessageType",
Type = "eMessageType",
},
{
Name = "AdditionalData",
Type = "string",
IsOptional = true,
},
},
Returns =
{
{
Type = "self",
},
},
Notes = "Sets the MessageType (mtXXX constant) that is associated with this message. Also sets the additional data (string) associated with the message, which is specific for the message type - such as the sender's name for mtPrivateMessage. When sent to a player, the message will be formatted according to this message type and the player's settings (adding \"[INFO]\" prefix etc.). Chaining.",
},
UnderlineUrls =
{
Returns =
{
{
Type = "self",
},
},
Notes = "Makes all URL parts contained in the message underlined. Doesn't affect parts added in the future. Chaining.",
},
},
AdditionalInfo =
{
{
Header = "Chaining example",
Contents = [[
Sending a chat message that is composed of multiple different parts has been made easy thanks to
chaining. Consider the following example that shows how a message containing all kinds of parts
is sent (adapted from the Debuggers plugin):
function OnPlayerJoined(a_Player)
-- Send an example composite chat message to the player:
a_Player:SendMessage(cCompositeChat()
:AddTextPart("Hello, ")
:AddUrlPart(a_Player:GetName(), "https://cuberite.org", "u@2") -- Colored underlined link
:AddSuggestCommandPart(", and welcome.", "/help", "u") -- Underlined suggest-command
:AddRunCommandPart(" SetDay", "/time set 0") -- Regular text that will execute command when clicked
:SetMessageType(mtJoin) -- It is a join-message
)
end
]],
},
},
},
cCraftingGrid =
{
Desc = [[
cCraftingGrid represents the player's crafting grid. It is used in
{{OnCraftingNoRecipe|OnCraftingNoRecipe}}, {{OnPostCrafting|OnPostCrafting}} and
{{OnPreCrafting|OnPreCrafting}} hooks. Plugins may use it to inspect the items the player placed
on their crafting grid.
Also, an object of this type is used in {{cCraftingRecipe}}'s ConsumeIngredients() function for specifying the exact number of ingredients to consume in that recipe; plugins may use this to apply the crafting recipe.
]], Functions = { Clear = { Notes = "Clears the entire grid", }, constructor = { Params = { { Name = "Width", Type = "number", }, { Name = "Height", Type = "number", }, }, Returns = { { Type = "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 = { { Name = "CraftingGrid", Type = "cCraftingGrid", }, }, Notes = "Consumes items specified in CraftingGrid from the current contents. Used internally by {{cCraftingRecipe}}'s ConsumeIngredients() function, but available to plugins, too.", }, Dump = { Notes = "DEBUG build: Dumps the contents of the grid to the log. RELEASE build: no action", }, GetHeight = { Returns = { { Type = "number", }, }, Notes = "Returns the height of the grid", }, GetItem = { Params = { { Name = "x", Type = "number", }, { Name = "y", Type = "number", }, }, Returns = { { Type = "cItem", }, }, Notes = "Returns the item at the specified coords", }, GetWidth = { Returns = { { Type = "number", }, }, Notes = "Returns the width of the grid", }, SetItem = { { Params = { { Name = "x", Type = "number", }, { Name = "y", Type = "number", }, { Name = "cItem", Type = "cItem", }, }, Notes = "Sets the item at the specified coords", }, { Params = { { Name = "x", Type = "number", }, { Name = "y", Type = "number", }, { Name = "ItemType", Type = "number", }, { Name = "ItemCount", Type = "number", }, { Name = "ItemDamage", Type = "number", }, }, Notes = "Sets the item at the specified coords", }, }, }, }, cCraftingRecipe = { Desc = [[ This class is used to represent a crafting recipe, either a built-in one, or one created dynamically in a plugin. It is used only as a parameter for {{OnCraftingNoRecipe|OnCraftingNoRecipe}}, {{OnPostCrafting|OnPostCrafting}} and {{OnPreCrafting|OnPreCrafting}} hooks. Plugins may use it to inspect or modify a crafting recipe that a player views in their crafting window, either at a crafting table or the survival inventory screen.Internally, the class contains a {{cCraftingGrid}} for the ingredients and a {{cItem}} for the result. ]], Functions = { Clear = { Notes = "Clears the entire recipe, both ingredients and results", }, ConsumeIngredients = { Params = { { Name = "CraftingGrid", Type = "cCraftingGrid", }, }, Notes = "Consumes ingredients specified in the given {{cCraftingGrid|cCraftingGrid}} class", }, Dump = { Notes = "DEBUG build: dumps ingredients and result into server log. RELEASE build: no action", }, GetIngredient = { Params = { { Name = "x", Type = "number", }, { Name = "y", Type = "number", }, }, Returns = { { Type = "cItem", }, }, Notes = "Returns the ingredient stored in the recipe at the specified coords", }, GetIngredientsHeight = { Returns = { { Type = "number", }, }, Notes = "Returns the height of the ingredients' grid", }, GetIngredientsWidth = { Returns = { { Type = "number", }, }, Notes = "Returns the width of the ingredients' grid", }, GetResult = { Returns = { { Type = "cItem", }, }, Notes = "Returns the result of the recipe", }, SetIngredient = { { Params = { { Name = "x", Type = "number", }, { Name = "y", Type = "number", }, { Name = "cItem", Type = "cItem", }, }, Notes = "Sets the ingredient at the specified coords", }, { Params = { { Name = "x", Type = "number", }, { Name = "y", Type = "number", }, { Name = "ItemType", Type = "number", }, { Name = "ItemCount", Type = "number", }, { Name = "ItemDamage", Type = "number", }, }, Notes = "Sets the ingredient at the specified coords", }, }, SetResult = { { Params = { { Name = "cItem", Type = "cItem", }, }, Notes = "Sets the result item", }, { Params = { { Name = "ItemType", Type = "number", }, { Name = "ItemCount", Type = "number", }, { Name = "ItemDamage", Type = "number", }, }, Notes = "Sets the result item", }, }, }, }, cCryptoHash = { Desc = [[ Provides functions for generating cryptographic hashes.
Note that all functions in this class are super-static, so they are to be called in the dot convention:
local Hash = cCryptoHash.sha1HexString("DataToHash")
Each cryptographic hash has two variants, one returns the hash as a raw binary string, the other returns the hash as a hex-encoded string twice as long as the binary string. ]], Functions = { md5 = { IsStatic = true, IsGlobal = true, Params = { { Name = "Data", Type = "string", }, }, Returns = { { Type = "string", }, }, Notes = "Calculates the md5 hash of the data, returns it as a raw (binary) string of 16 characters.", }, md5HexString = { IsStatic = true, IsGlobal = true, Params = { { Name = "Data", Type = "string", }, }, Returns = { { Type = "string", }, }, Notes = "Calculates the md5 hash of the data, returns it as a hex-encoded string of 32 characters.", }, sha1 = { IsStatic = true, IsGlobal = true, Params = { { Name = "Data", Type = "string", }, }, Returns = { { Type = "string", }, }, Notes = "Calculates the sha1 hash of the data, returns it as a raw (binary) string of 20 characters.", }, sha1HexString = { IsStatic = true, IsGlobal = true, Params = { { Name = "Data", Type = "string", }, }, Returns = { { Type = "string", }, }, Notes = "Calculates the sha1 hash of the data, returns it as a hex-encoded string of 40 characters.", }, }, }, cEnchantments = { Desc = [[ This class is the storage for enchantments for a single {{cItem|cItem}} object, through its m_Enchantments member variable. Although it is possible to create a standalone object of this class, it is not yet used in any API directly.
Enchantments can be initialized either programmatically by calling the individual functions (SetLevel()), or by using a string description of the enchantment combination. This string description is in the form "id=lvl;id=lvl;...;id=lvl;", where id is either a numerical ID of the enchantment, or its textual representation from the table below, and lvl is the desired enchantment level. The class can also create its string description from its current contents; however that string description will only have the numerical IDs.
See the {{cItem}} class for usage examples. ]], Functions = { Add = { Params = { { Name = "Other", Type = "cEnchantments", }, }, Notes = "Adds the enchantments contained in Other into this object. Existing enchantments are preserved, unless Other specifies a different level, in which case the level is changed to the Other's one.", }, AddFromString = { Params = { { Name = "StringSpec", Type = "string", }, }, Notes = "Adds the enchantments in the string description into the object. If a specified enchantment already existed, it is overwritten.", }, Clear = { Notes = "Removes all enchantments", }, constructor = { { Returns = { { Type = "cEnchantments", }, }, Notes = "Creates a new empty cEnchantments object", }, { Params = { { Name = "StringSpec", Type = "string", }, }, Returns = { { Type = "cEnchantments", }, }, Notes = "Creates a new cEnchantments object filled with enchantments based on the string description", }, }, Count = { Returns = { { Type = "number", }, }, Notes = "Get the count of enchantments contained within the class", }, GetLevel = { Params = { { Name = "EnchantmentNumID", Type = "number", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the level of the specified enchantment stored in this object; 0 if not stored", }, CanAddEnchantment = { Params = { { Name = "EnchantmentNumID", Type = "number", }, }, Returns = { { Type = "boolean" }, }, Notes = "Returns true if the specified enchantment is not mutually exclusive with any of the enchantments stored by the object.", }, IsEmpty = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the object stores no enchantments", }, operator_eq = { Params = { { Name = "OtherEnchantments", Type = "cEnchantments", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if this enchantments object has the same enchantments as OtherEnchantments.", }, SetLevel = { Params = { { Name = "EnchantmentNumID", Type = "number", }, { Name = "Level", Type = "number", }, }, Notes = "Sets the level for the specified enchantment, adding it if not stored before, or removing it if Level < = 0", }, StringToEnchantmentID = { IsStatic = true, Params = { { Name = "EnchantmentName", Type = "string", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the enchantment numerical ID, -1 if not understood. Case insensitive. Also understands plain numbers.", }, ToString = { Returns = { { Type = "string", }, }, Notes = "Returns the string description of all the enchantments stored in this object, in numerical-ID form", }, }, Constants = { enchAquaAffinity = { Notes = "", }, enchBaneOfArthropods = { Notes = "", }, enchBlastProtection = { Notes = "", }, enchEfficiency = { Notes = "", }, enchFeatherFalling = { Notes = "", }, enchFireAspect = { Notes = "", }, enchFireProtection = { Notes = "", }, enchFlame = { Notes = "", }, enchFortune = { Notes = "", }, enchInfinity = { Notes = "", }, enchKnockback = { Notes = "", }, enchLooting = { Notes = "", }, enchLuckOfTheSea = { Notes = "", }, enchLure = { Notes = "", }, enchPower = { Notes = "", }, enchProjectileProtection = { Notes = "", }, enchProtection = { Notes = "", }, enchPunch = { Notes = "", }, enchRespiration = { Notes = "", }, enchSharpness = { Notes = "", }, enchSilkTouch = { Notes = "", }, enchSmite = { Notes = "", }, enchThorns = { Notes = "", }, enchUnbreaking = { Notes = "", }, }, }, cEntity = { Desc = [[ A cEntity object represents an object in the world, it has a position and orientation. cEntity is an abstract class, and can not be instantiated directly, instead, all entities are implemented as subclasses. The cEntity class works as the common interface for the operations that all (most) entities support.
All cEntity objects have an Entity Type so it can be determined what kind of entity it is efficiently. Entities also have a class inheritance awareness, they know their class name, their parent class' name and can decide if there is a class within their inheritance chain. Since these functions operate on strings, they are slightly slower than checking the entity type directly, on the other hand, they are more specific directly. To check if the entity is a spider, you need to call IsMob(), then cast the object to {{cMonster}} and finally compare {{cMonster}}:GetMonsterType() to mtSpider. GetClass(), on the other hand, returns "cSpider" directly.
Note that you should not store a cEntity object between two hooks' calls, because Cuberite may despawn / remove that entity in between the calls. If you need to refer to an entity later, use its UniqueID and {{cWorld|cWorld}}'s entity manipulation functions DoWithEntityByID(), ForEachEntity() or ForEachEntityInChunk() to access the entity again.
]], Functions = { AddPosition = { { Params = { { Name = "OffsetX", Type = "number", }, { Name = "OffsetY", Type = "number", }, { Name = "OffsetZ", Type = "number", }, }, Notes = "Moves the entity by the specified amount in each axis direction", }, { Params = { { Name = "Offset", Type = "Vector3d", }, }, Notes = "Moves the entity by the specified amount in each direction", }, }, AddPosX = { Params = { { Name = "OffsetX", Type = "number", }, }, Notes = "Moves the entity by the specified amount in the X axis direction", }, AddPosY = { Params = { { Name = "OffsetY", Type = "number", }, }, Notes = "Moves the entity by the specified amount in the Y axis direction", }, AddPosZ = { Params = { { Name = "OffsetZ", Type = "number", }, }, Notes = "Moves the entity by the specified amount in the Z axis direction", }, AddSpeed = { { Params = { { Name = "AddX", Type = "number", }, { Name = "AddY", Type = "number", }, { Name = "AddZ", Type = "number", }, }, Notes = "Adds the specified amount of speed in each axis direction.", }, { Params = { { Name = "Add", Type = "Vector3d", }, }, Notes = "Adds the specified amount of speed in each axis direction.", }, }, AddSpeedX = { Params = { { Name = "AddX", Type = "number", }, }, Notes = "Adds the specified amount of speed in the X axis direction.", }, AddSpeedY = { Params = { { Name = "AddY", Type = "number", }, }, Notes = "Adds the specified amount of speed in the Y axis direction.", }, AddSpeedZ = { Params = { { Name = "AddZ", Type = "number", }, }, Notes = "Adds the specified amount of speed in the Z axis direction.", }, ApplyArmorDamage = { Params = { { Name = "DamageBlocked", Type = "number", }, }, Notes = "Lowers armor durability, as if the armor blocked the given amount of damage.", }, ArmorCoversAgainst = { Params = { { Name = "DamageType", Type = "eDamageType", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns whether armor will protect against the specified damage type", }, Destroy = { Params = { { Name = "ShouldBroadcast (DEPRECATED)", Type = "boolean", IsOptional = true, }, }, Notes = "Schedules the entity to be destroyed; broadcasts the DestroyEntity packet", }, DoesPreventBlockPlacement = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if this entity doesn't allow blocks to be placed intersecting the entity.", }, GetAirLevel = { Returns = { { Type = "number", }, }, Notes = "Returns the air level (number of ticks of air left). Note, this function is only updated with mobs or players.", }, GetArmorCoverAgainst = { Params = { { Name = "AttackerEntity", Type = "cEntity", }, { Name = "DamageType", Type = "eDamageType", }, { Name = "RawDamage", Type = "number", }, }, Returns = { { Type = "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.", }, GetBoundingBox = { Returns = { { Type = "cBoundingBox", }, }, Notes = "Returns the bounding box of the entity, which has width and height corresponding to the entity, and is aligned with the block grid.", }, GetChunkX = { Returns = { { Type = "number", }, }, Notes = "Returns the X-coord of the chunk in which the entity is placed", }, GetChunkZ = { Returns = { { Type = "number", }, }, Notes = "Returns the Z-coord of the chunk in which the entity is placed", }, GetClass = { Returns = { { Type = "string", }, }, Notes = "Returns the classname of the entity, such as \"cSpider\" or \"cPickup\"", }, GetClassStatic = { IsStatic = true, Returns = { { Type = "string", }, }, Notes = "Returns the entity classname that this class implements. Each descendant overrides this function.", }, GetEnchantmentBlastKnockbackReduction = { Returns = { { Type = "number", }, }, Notes = "Returns explosion knock back reduction percent from blast protection level.", }, GetEnchantmentCoverAgainst = { Params = { { Name = "AttackerEntity", Type = "cEntity", }, { Name = "DamageType", Type = "eDamageType", }, { Name = "RawDamage", Type = "number", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the number of hitpoints out of RawDamage that the enchantments on the currently equipped armor would cover. See {{TakeDamageInfo}} for more information on attack damage.", }, GetEntityType = { Returns = { { Name = "EntityType", Type = "cEntity#eEntityType", }, }, Notes = "Returns the type of the entity, one of the {{cEntity#eEntityType|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 = { Returns = { { Type = "cItem", }, }, Notes = "Returns the boots that the entity has equipped. Returns an empty cItem if no boots equipped or not applicable.", }, GetEquippedChestplate = { Returns = { { Type = "cItem", }, }, Notes = "Returns the chestplate that the entity has equipped. Returns an empty cItem if no chestplate equipped or not applicable.", }, GetEquippedHelmet = { Returns = { { Type = "cItem", }, }, Notes = "Returns the helmet that the entity has equipped. Returns an empty cItem if no helmet equipped or not applicable.", }, GetEquippedLeggings = { Returns = { { Type = "cItem", }, }, Notes = "Returns the leggings that the entity has equipped. Returns an empty cItem if no leggings equipped or not applicable.", }, GetEquippedWeapon = { Returns = { { Type = "cItem", }, }, Notes = "Returns the weapon that the entity has equipped. Returns an empty cItem if no weapon equipped or not applicable.", }, GetOffHandEquipedItem = { Returns = { { Type = "cItem", }, }, Notes = "Returns the item that the entity has equipped on off-hand. Returns an empty cItem if no item equipped or not applicable.", }, GetGravity = { Returns = { { Type = "number", }, }, Notes = "Returns the number that is used as the gravity for physics simulation. 1G (9.78) by default.", }, GetHeadYaw = { Returns = { { Type = "number", }, }, Notes = "Returns the pitch of the entity's head (FIXME: Rename to GetHeadPitch() ).", }, GetHealth = { Returns = { { Type = "number", }, }, Notes = "Returns the current health of the entity.", }, GetHeight = { Returns = { { Type = "number", }, }, Notes = "Returns the height (Y size) of the entity", }, GetInvulnerableTicks = { Returns = { { Type = "number", }, }, Notes = "Returns the number of ticks that this entity will be invulnerable for. This is used for after-hit recovery - the entities are invulnerable for half a second after being hit.", }, GetKnockbackAmountAgainst = { Params = { { Name = "ReceiverEntity", Type = "cEntity", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the amount of knockback that the currently equipped items would cause when attacking the ReceiverEntity.", }, GetLookVector = { Returns = { { Type = "Vector3f", }, }, Notes = "Returns the vector that defines the direction in which the entity is looking", }, GetMass = { Returns = { { Type = "number", }, }, Notes = "Returns the mass of the entity. Currently unused.", }, GetMaxHealth = { Returns = { { Type = "number", }, }, Notes = "Returns the maximum number of hitpoints this entity is allowed to have.", }, GetParentClass = { Returns = { { Type = "string", }, }, Notes = "Returns the name of the direct parent class for this entity", }, GetPitch = { Returns = { { Type = "number", }, }, Notes = "Returns the pitch (nose-down rotation) of the entity. Measured in degrees, normal values range from -90 to +90. +90 means looking down, 0 means looking straight ahead, -90 means looking up.", }, GetPosition = { Returns = { { Type = "Vector3d", }, }, Notes = "Returns the entity's pivot position as a 3D vector", }, GetPosX = { Returns = { { Type = "number", }, }, Notes = "Returns the X-coord of the entity's pivot", }, GetPosY = { Returns = { { Type = "number", }, }, Notes = "Returns the Y-coord of the entity's pivot", }, GetPosZ = { Returns = { { Type = "number", }, }, Notes = "Returns the Z-coord of the entity's pivot", }, GetRawDamageAgainst = { Params = { { Name = "ReceiverEntity", Type = "cEntity", }, }, Returns = { { Type = "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 = { Returns = { { Type = "number", }, }, Notes = "Returns the roll (sideways rotation) of the entity. Currently unused.", }, GetSpeed = { Returns = { { Type = "Vector3d", }, }, Notes = "Returns the complete speed vector of the entity", }, GetSpeedX = { Returns = { { Type = "number", }, }, Notes = "Returns the X-part of the speed vector", }, GetSpeedY = { Returns = { { Type = "number", }, }, Notes = "Returns the Y-part of the speed vector", }, GetSpeedZ = { Returns = { { Type = "number", }, }, Notes = "Returns the Z-part of the speed vector", }, GetTicksAlive = { Returns = { { Type = "number", }, }, Notes = "Returns the number of ticks that this entity has been alive for.", }, GetUniqueID = { Returns = { { Type = "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 = { Returns = { { Type = "number", }, }, Notes = "Returns the width (X and Z size) of the entity.", }, GetWorld = { Returns = { { Type = "cWorld", }, }, Notes = "Returns the world where the entity resides", }, GetYaw = { Returns = { { Type = "number", }, }, Notes = "Returns the yaw (direction) of the entity. Measured in degrees, values range from -180 to +180. 0 means ZP, 90 means XM, -180 means ZM, -90 means XP.", }, HandleSpeedFromAttachee = { Params = { { Name = "ForwardAmount", Type = "number", }, { Name = "SidewaysAmount", Type = "number", }, }, Notes = "Updates the entity's speed based on the attachee exerting the specified force forward and sideways. Used for entities being driven by other entities attached to them - usually players driving minecarts and boats.", }, Heal = { Params = { { Name = "Hitpoints", Type = "number", }, }, Notes = "Heals the specified number of hitpoints. Hitpoints is expected to be a positive number.", }, IsA = { Params = { { Name = "ClassName", Type = "string", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity class is a descendant of the specified class name, or the specified class itself", }, IsArrow = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is an arrow.", }, IsBoat = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is a {{cBoat|boat}}.", }, IsCrouched = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is crouched. Always false for entities that don't support crouching.", }, IsDestroyed = { Returns = { { Type = "boolean", }, }, Notes = "(DEPRECATED) Please use cEntity:IsTicking().", }, IsElytraFlying = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is flying with an elytra. Entities that cannot fly with an elytra return always false.", }, IsEnderCrystal = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is an ender crystal.", }, IsExpOrb = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity represents an experience orb", }, IsFallingBlock = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity represents a {{cFallingBlock}} entity.", }, IsFireproof = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity takes no damage from being on fire.", }, IsFloater = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity represents a fishing rod floater", }, IsHeadInWater = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity's head is in a water block", }, IsInvisible = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is invisible.", }, IsInFire = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if any part of the entity is in a fire block", }, IsInLava = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if any part of the entity is in a lava block", }, IsInWater = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if any part of the entity is in a water block", }, IsItemFrame = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is an item frame.", }, IsLeashKnot = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is a leash knot.", }, IsMinecart = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity represents a {{cMinecart|minecart}}", }, IsMob = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity represents any {{cMonster|mob}}.", }, IsOnFire = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is on fire", }, IsOnGround = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is on ground (not falling, not jumping, not flying)", }, IsPainting = { Returns = { { Type = "boolean", }, }, Notes = "Returns if this entity is a painting.", }, IsPawn = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is a {{cPawn}} descendant.", }, IsPickup = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity represents a {{cPickup|pickup}}.", }, IsPlayer = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity represents a {{cPlayer|player}}", }, IsProjectile = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is a {{cProjectileEntity}} descendant.", }, IsRclking = { Returns = { { Type = "boolean", }, }, Notes = "Currently unimplemented", }, IsRiding = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is attached to (riding) another entity.", }, IsSprinting = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is sprinting. Entities that cannot sprint return always false", }, IsSubmerged = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity's head is in a water block Currently deprecated in favour of IsHeadInWater()", }, IsSwimming = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if any part of the entity is in a water block. Note, this function is only updated with mobs or players. Currently deprecated in favour of IsInWater()", }, IsTicking = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity is valid and ticking. Returns false if the entity is not ticking and is about to leave its current world either via teleportation or destruction. If this returns false, you must stop using the cEntity pointer you have.", }, IsTNT = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the entity represents a {{cTNTEntity|TNT entity}}", }, Killed = { Params = { { Name = "Victim", Type = "cEntity", }, }, Notes = "This entity has killed another entity (the Victim). For players, adds the scoreboard statistics about the kill.", }, MoveToWorld = { { Params = { { Name = "World", Type = "cWorld", }, { Name = "ShouldSendRespawn", Type = "boolean", IsOptional = true, }, }, Returns = { { Type = "boolean", }, }, Notes = "Removes the entity from this world and starts moving it to the specified world's spawn point. Note that to avoid deadlocks, the move is asynchronous - the entity is moved into a queue and will be moved from that queue into the destination world at some (unpredictable) time in the future. ShouldSendRespawn is used only for players, it specifies whether the player should be sent a Respawn packet upon leaving the world (The client handles respawns only between different dimensions).", }, { Params = { { Name = "WorldName", Type = "string", }, { Name = "ShouldSendRespawn", Type = "boolean", IsOptional = true, }, }, Returns = { { Type = "boolean", }, }, Notes = "Removes the entity from this world and starts moving it to the specified world's spawn point. Note that to avoid deadlocks, the move is asynchronous - the entity is moved into a queue and will be moved from that queue into the destination world at some (unpredictable) time in the future. ShouldSendRespawn is used only for players, it specifies whether the player should be sent a Respawn packet upon leaving the world (The client handles respawns only between different dimensions).", }, { Params = { { Name = "World", Type = "cWorld", }, { Name = "ShouldSendRespawn", Type = "boolean", }, { Name = "Position", Type = "Vector3d", }, }, Returns = { { Type = "boolean", }, }, Notes = "Removes the entity from this world and starts moving it to the specified world. Note that to avoid deadlocks, the move is asynchronous - the entity is moved into a queue and will be moved from that queue into the destination world at some (unpredictable) time in the future. ShouldSendRespawn is used only for players, it specifies whether the player should be sent a Respawn packet upon leaving the world (The client handles respawns only between different dimensions). The Position parameter specifies the location that the entity should be placed in, in the new world.", }, { Params = { { Name = "World", Type = "cWorld", }, { Name = "Position", Type = "Vector3d", }, { Name = "ShouldSetPortalCooldown", Type = "boolean", IsOptional = true, }, { Name = "ShouldSendRespawn", Type = "boolean", IsOptional = true, }, }, Returns = { { Type = "boolean", }, }, Notes = "Removes the entity from this world and starts moving it to the specified world. Note that to avoid deadlocks, the move is asynchronous - the entity is moved into a queue and will be moved from that queue into the destination world at some (unpredictable) time in the future. If ShouldSetPortalCooldown is false (default), doesn't set any portal cooldown, if it is true, the default portal cooldown is applied to the entity. ShouldSendRespawn is used only for players, it specifies whether the player should be sent a Respawn packet upon leaving the world (The client handles respawns only between different dimensions). The Position parameter specifies the location that the entity should be placed in, in the new world.", }, }, SetGravity = { Params = { { Name = "Gravity", Type = "number", }, }, Notes = "Sets the number that is used as the gravity for physics simulation. 1G (9.78) by default.", }, SetHeadYaw = { Params = { { Name = "HeadPitch", Type = "number", }, }, Notes = "Sets the head pitch (FIXME: Rename to SetHeadPitch() ).", }, SetHealth = { Params = { { Name = "Hitpoints", Type = "number", }, }, 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.", }, SetInvulnerableTicks = { Params = { { Name = "NumTicks", Type = "number", }, }, Notes = "Sets the amount of ticks for which the entity will not receive any damage from other entities.", }, SetIsFireproof = { Params = { { Name = "IsFireproof", Type = "boolean", }, }, Notes = "Sets whether the entity receives damage from being on fire.", }, SetMass = { Params = { { Name = "Mass", Type = "number", }, }, Notes = "Sets the mass of the entity. Currently unused.", }, SetMaxHealth = { Params = { { Name = "MaxHitpoints", Type = "number", }, }, Notes = "Sets the maximum hitpoints of the entity. If current health is above MaxHitpoints, it is capped to MaxHitpoints.", }, SetPitch = { Params = { { Name = "Pitch", Type = "number", }, }, Notes = "Sets the pitch (nose-down rotation) of the entity", }, SetPitchFromSpeed = { Notes = "Sets the entity pitch to match its speed (entity looking forwards as it moves)", }, SetPosition = { { Params = { { Name = "PosX", Type = "number", }, { Name = "PosY", Type = "number", }, { Name = "PosZ", Type = "number", }, }, Notes = "Sets all three coords of the entity's pivot", }, { Params = { { Name = "Vector3d", Type = "Vector3d", }, }, Notes = "Sets all three coords of the entity's pivot", }, }, SetPosX = { Params = { { Name = "PosX", Type = "number", }, }, Notes = "Sets the X-coord of the entity's pivot", }, SetPosY = { Params = { { Name = "PosY", Type = "number", }, }, Notes = "Sets the Y-coord of the entity's pivot", }, SetPosZ = { Params = { { Name = "PosZ", Type = "number", }, }, Notes = "Sets the Z-coord of the entity's pivot", }, SetRoll = { Params = { { Name = "Roll", Type = "number", }, }, Notes = "Sets the roll (sideways rotation) of the entity. Currently unused.", }, SetSpeed = { { Params = { { Name = "SpeedX", Type = "number", }, { Name = "SpeedY", Type = "number", }, { Name = "SpeedZ", Type = "number", }, }, Notes = "Sets the current speed of the entity", }, { Params = { { Name = "Speed", Type = "Vector3d", }, }, Notes = "Sets the current speed of the entity", }, }, SetSpeedX = { Params = { { Name = "SpeedX", Type = "number", }, }, Notes = "Sets the X component of the entity speed", }, SetSpeedY = { Params = { { Name = "SpeedY", Type = "number", }, }, Notes = "Sets the Y component of the entity speed", }, SetSpeedZ = { Params = { { Name = "SpeedZ", Type = "number", }, }, Notes = "Sets the Z component of the entity speed", }, SetYaw = { Params = { { Name = "Yaw", Type = "number", }, }, Notes = "Sets the yaw (direction) of the entity.", }, SetYawFromSpeed = { Notes = "Sets the entity's yaw to match its current speed (entity looking forwards as it moves).", }, StartBurning = { Params = { { Name = "NumTicks", Type = "number", }, }, 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 = { { Name = "ForwardAmount", Type = "number", }, { Name = "SidewaysAmount", Type = "number", }, }, Notes = "Applies the specified steering to the vehicle this entity is attached to. Ignored if not attached to any entity.", }, StopBurning = { Notes = "Extinguishes the entity fire, cancels all fire timers.", }, TakeDamage = { { Params = { { Name = "AttackerEntity", Type = "cEntity", }, }, Notes = "Causes this entity to take damage that AttackerEntity would inflict. Includes their weapon and this entity's armor.", }, { Params = { { Name = "DamageType", Type = "eDamageType", }, { Name = "AttackerEntity", Type = "cEntity", }, { Name = "RawDamage", Type = "number", }, { Name = "KnockbackAmount", Type = "number", }, }, 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 = { { Name = "DamageType", Type = "eDamageType", }, { Name = "AttackerEntity", Type = "cEntity", }, { Name = "RawDamage", Type = "number", }, { Name = "FinalDamage", Type = "number", }, { Name = "KnockbackAmount", Type = "number", }, }, 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 = { { Name = "PosX", Type = "number", }, { Name = "PosY", Type = "number", }, { Name = "PosZ", Type = "number", }, }, Notes = "Teleports the entity to the specified coords. Asks plugins if the teleport is allowed.", }, TeleportToEntity = { Params = { { Name = "DestEntity", Type = "cEntity", }, }, Notes = "Teleports this entity to the specified destination entity. Asks plugins if the teleport is allowed.", }, }, Constants = { INVALID_ID = { Notes = "Special value of an entity ID, indicating a failure. Used primarily in functions that create entities when the entity cannot be created.", }, etBoat = { Notes = "The entity is a {{cBoat}}", }, etEnderCrystal = { Notes = "The entity is a {{cEnderCrystal}}", }, etEntity = { Notes = "No further specialization available", }, etExpOrb = { Notes = "The entity is a {{cExpOrb}}", }, etFallingBlock = { Notes = "The entity is a {{cFallingBlock}}", }, etFloater = { Notes = "The entity is a fishing rod floater", }, etItemFrame = { Notes = "The entity is an item frame", }, etLeashKnot = { Notes = "The entity is a leash knot", }, etMinecart = { Notes = "The entity is a {{cMinecart}} descendant", }, etMob = { Notes = "The entity is a {{cMonster}} descendant", }, etMonster = { Notes = "The entity is a {{cMonster}} descendant", }, etPainting = { Notes = "The entity is a {{cPainting}}", }, etPickup = { Notes = "The entity is a {{cPickup}}", }, etPlayer = { Notes = "The entity is a {{cPlayer}}", }, etProjectile = { Notes = "The entity is a {{cProjectileEntity}} descendant", }, etTNT = { Notes = "The entity is a {{cTNTEntity}}", }, }, ConstantGroups = { eEntityType = { Include = "et.*", TextBefore = "The following constants are used to distinguish between different entity types:", }, }, }, cEntityEffect = { Functions = { GetPotionColor = { IsStatic = true, Params = { { Name = "ItemDamage", Type = "number", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the potion color (used by the client for visuals), based on the potion's damage value", }, GetPotionEffectDuration = { IsStatic = true, Params = { { Name = "ItemDamage", Type = "number", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the effect duration, in ticks, based on the potion's damage value", }, GetPotionEffectIntensity = { IsStatic = true, Params = { { Name = "ItemDamage", Type = "number", }, }, Returns = { { Name = "short", Type = "number", }, }, Notes = "Retrieves the intensity level from the potion's damage value. Returns 0 for level I potions, 1 for level II potions.", }, GetPotionEffectType = { IsStatic = true, Params = { { Name = "ItemDamage", Type = "number", }, }, Returns = { { Name = "eType", Type = "cEntityEffect#eType", }, }, Notes = "Translates the potion's damage value into the entity effect that the potion gives", }, IsPotionDrinkable = { IsStatic = true, Params = { { Name = "ItemDamage", Type = "number", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the potion with the given damage is drinkable", }, }, -- Functions ConstantGroups = { eType = { Include = { "eff.*" }, }, }, -- ConstantGroups }, -- cEntityEffect cFile = { Desc = [[ Provides helper functions for manipulating and querying the filesystem. Most functions are static, so they should be called directly on the cFile class itself:
cFile:DeleteFile("/usr/bin/virus.exe");
]],
Functions =
{
ChangeFileExt =
{
IsStatic = true,
Params =
{
{
Name = "FileName",
Type = "string",
},
{
Name = "NewExt",
Type = "string",
},
},
Returns =
{
{
Type = "string",
},
},
Notes = "Returns FileName with its extension changed to NewExt. NewExt may begin with a dot, but needn't, the result is the same in both cases (the first dot, if present, is ignored). FileName may contain path elements, extension is recognized as the last dot after the last path separator in the string.",
},
Copy =
{
IsStatic = true,
Params =
{
{
Name = "SrcFileName",
Type = "string",
},
{
Name = "DstFileName",
Type = "string",
},
},
Returns =
{
{
Name = "IsSuccess",
Type = "boolean",
},
},
Notes = "Copies a single file to a new destination. Returns true if successful. Fails if the destination already exists.",
},
CreateFolder =
{
IsStatic = true,
Params =
{
{
Name = "FolderPath",
Type = "string",
},
},
Returns =
{
{
Name = "IsSuccess",
Type = "boolean",
},
},
Notes = "Creates a new folder. Returns true if successful. Only a single level can be created at a time, use CreateFolderRecursive() to create multiple levels of folders at once.",
},
CreateFolderRecursive =
{
IsStatic = true,
Params =
{
{
Name = "FolderPath",
Type = "string",
},
},
Returns =
{
{
Name = "IsSuccess",
Type = "boolean",
},
},
Notes = "Creates a new folder, creating its parents if needed. Returns true if successful.",
},
Delete =
{
IsStatic = true,
Params =
{
{
Name = "Path",
Type = "string",
},
},
Returns =
{
{
Name = "IsSuccess",
Type = "boolean",
},
},
Notes = "Deletes the specified file or folder. Returns true if successful. Only deletes folders that are empty.The INI files follow this basic structure:
; Header comment line [KeyName0] ; Key comment line 0 ValueName0=Value0 ValueName1=Value1 [KeyName1] ; Key comment line 0 ; Key comment line 1 ValueName0=SomeOtherValueThe cIniFile object stores all the objects in numbered arrays and provides access to the information either based on names (KeyName, ValueName) or zero-based indices.
The objects of this class are created empty. You need to either load a file using ReadFile(), or insert values by hand. Then you can store the object's contents to a disk file using WriteFile(), or just forget everything by destroying the object. Note that the file operations are quite slow.
For storing high-volume low-latency data, use the {{sqlite3}} class. For storing hierarchically-structured data, use the XML format, using the LuaExpat parser in the {{lxp}} class. ]], Functions = { AddHeaderComment = { Params = { { Name = "Comment", Type = "string", }, }, Notes = "Adds a comment to be stored in the file header.", }, AddKeyComment = { { Params = { { Name = "KeyID", Type = "number", }, { Name = "Comment", Type = "string", }, }, Notes = "Adds a comment to be stored in the file under the specified key", }, { Params = { { Name = "KeyName", Type = "string", }, { Name = "Comment", Type = "string", }, }, Notes = "Adds a comment to be stored in the file under the specified key", }, }, AddKeyName = { Params = { { Name = "KeyName", Type = "string", }, }, Returns = { { Type = "number", }, }, Notes = "Adds a new key of the specified name. Returns the KeyID of the new key.", }, AddValue = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "Value", Type = "string", }, }, Notes = "Adds a new value of the specified name to the specified key. If another value of the same name exists in the key, both are kept (nonstandard INI file)", }, AddValueB = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "Value", Type = "boolean", }, }, Notes = "Adds a new bool value of the specified name to the specified key. If another value of the same name exists in the key, both are kept (nonstandard INI file)", }, AddValueF = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "Value", Type = "number", }, }, Notes = "Adds a new float value of the specified name to the specified key. If another value of the same name exists in the key, both are kept (nonstandard INI file)", }, AddValueI = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "Value", Type = "number", }, }, Notes = "Adds a new integer value of the specified name to the specified key. If another value of the same name exists in the key, both are kept (nonstandard INI file)", }, CaseInsensitive = { Notes = "Sets key names' and value names' comparisons to case insensitive (default).", }, CaseSensitive = { Notes = "Sets key names and value names comparisons to case sensitive.", }, Clear = { Notes = "Removes all the in-memory data. Note that , like all the other operations, this doesn't affect any file data.", }, constructor = { Returns = { { Type = "cIniFile", }, }, Notes = "Creates a new empty cIniFile object.", }, DeleteHeaderComment = { Params = { { Name = "CommentID", Type = "number", }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Deletes the specified header comment. Returns true if successful.", }, DeleteHeaderComments = { Notes = "Deletes all headers comments.", }, DeleteKey = { Params = { { Name = "KeyName", Type = "string", }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Deletes the specified key, and all values in that key. Returns true if successful.", }, DeleteKeyComment = { { Params = { { Name = "KeyID", Type = "number", }, { Name = "CommentID", Type = "number", }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Deletes the specified key comment. Returns true if successful.", }, { Params = { { Name = "KeyName", Type = "string", }, { Name = "CommentID", Type = "number", }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Deletes the specified key comment. Returns true if successful.", }, }, DeleteKeyComments = { { Params = { { Name = "KeyID", Type = "number", }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Deletes all comments for the specified key. Returns true if successful.", }, { Params = { { Name = "KeyName", Type = "string", }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Deletes all comments for the specified key. Returns true if successful.", }, }, DeleteValue = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Deletes the specified value. Returns true if successful.", }, DeleteValueByID = { Params = { { Name = "KeyID", Type = "number", }, { Name = "ValueID", Type = "number", }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Deletes the specified value. Returns true if successful.", }, FindKey = { Params = { { Name = "KeyName", Type = "string", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the KeyID for the specified key name, or the noID constant if the key doesn't exist.", }, FindValue = { Params = { { Name = "KeyID", Type = "number", }, { Name = "ValueName", Type = "string", }, }, Returns = { { Name = "ValueID", Type = "number", }, }, Notes = "Returns the ValueID for the specified value name, or the noID constant if the specified key doesn't contain a value of that name.", }, Flush = { Returns = { { Type = "boolean", }, }, Notes = "Writes the data stored in the object to the file that was last associated with the object (ReadFile() or WriteFile()). Returns true on success, false on failure.", }, GetHeaderComment = { Params = { { Name = "CommentID", Type = "number", }, }, Returns = { { Type = "string", }, }, Notes = "Returns the specified header comment, or an empty string if such comment doesn't exist", }, GetKeyComment = { { Params = { { Name = "KeyID", Type = "number", }, { Name = "CommentID", Type = "number", }, }, Returns = { { Type = "string", }, }, Notes = "Returns the specified key comment, or an empty string if such a comment doesn't exist", }, { Params = { { Name = "KeyName", Type = "string", }, { Name = "CommentID", Type = "number", }, }, Returns = { { Type = "string", }, }, Notes = "Returns the specified key comment, or an empty string if such a comment doesn't exist", }, }, GetKeyName = { Params = { { Name = "KeyID", Type = "number", }, }, Returns = { { Type = "string", }, }, Notes = "Returns the key name for the specified key ID. Inverse for FindKey().", }, GetNumHeaderComments = { Returns = { { Type = "number", }, }, Notes = "Retuns the number of header comments.", }, GetNumKeyComments = { { Params = { { Name = "KeyID", Type = "number", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the number of comments under the specified key", }, { Params = { { Name = "KeyName", Type = "string", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the number of comments under the specified key", }, }, GetNumKeys = { Returns = { { Type = "number", }, }, Notes = "Returns the total number of keys. This is the range for the KeyID (0 .. GetNumKeys() - 1)", }, GetNumValues = { { Params = { { Name = "KeyID", Type = "number", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the number of values stored under the specified key.", }, { Params = { { Name = "KeyName", Type = "string", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the number of values stored under the specified key.", }, }, GetValue = { { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "DefaultValue", Type = "string", IsOptional = true, }, }, Returns = { { Type = "string", }, }, Notes = "Returns the value of the specified name under the specified key. Returns DefaultValue (empty string if not given) if the value doesn't exist.", }, { Params = { { Name = "KeyID", Type = "number", }, { Name = "ValueID", Type = "number", }, { Name = "DefaultValue", Type = "string", IsOptional = true, }, }, Returns = { { Type = "string", }, }, Notes = "Returns the value of the specified name under the specified key. Returns DefaultValue (empty string if not given) if the value doesn't exist.", }, }, GetValueB = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "DefaultValue", Type = "boolean", IsOptional = true, }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns the value of the specified name under the specified key, as a bool. Returns DefaultValue (false if not given) if the value doesn't exist.", }, GetValueF = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "DefaultValue", Type = "number", IsOptional = true, }, }, Returns = { { Type = "number", }, }, Notes = "Returns the value of the specified name under the specified key, as a floating-point number. Returns DefaultValue (zero if not given) if the value doesn't exist.", }, GetValueI = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "DefaultValue", Type = "number", IsOptional = true, }, }, Returns = { { Type = "number", }, }, Notes = "Returns the value of the specified name under the specified key, as an integer. Returns DefaultValue (zero if not given) if the value doesn't exist.", }, GetValueName = { { Params = { { Name = "KeyID", Type = "number", }, { Name = "ValueID", Type = "number", }, }, Returns = { { Type = "string", }, }, Notes = "Returns the name of the value specified by its ID. Inverse for FindValue().", }, { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueID", Type = "number", }, }, Returns = { { Type = "string", }, }, Notes = "Returns the name of the value specified by its ID. Inverse for FindValue().", }, }, GetValueSet = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "DefaultValue", Type = "string", IsOptional = true, }, }, Returns = { { Type = "string", }, }, Notes = "Returns the value of the specified name under the specified key. If the value doesn't exist, creates it with the specified default (empty string if not given).", }, GetValueSetB = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "DefaultValue", Type = "boolean", IsOptional = true, }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns the value of the specified name under the specified key, as a bool. If the value doesn't exist, creates it with the specified default (false if not given).", }, GetValueSetF = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "DefaultValue", Type = "number", IsOptional = true, }, }, Returns = { { Type = "number", }, }, Notes = "Returns the value of the specified name under the specified key, as a floating-point number. If the value doesn't exist, creates it with the specified default (zero if not given).", }, GetValueSetI = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "DefaultValue", Type = "number", IsOptional = true, }, }, Returns = { { Type = "number", }, }, Notes = "Returns the value of the specified name under the specified key, as an integer. If the value doesn't exist, creates it with the specified default (zero if not given).", }, HasValue = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the specified value is present.", }, ReadFile = { Params = { { Name = "FileName", Type = "string", }, { Name = "AllowExampleFallback", Type = "boolean", IsOptional = true, }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Reads the values from the specified file. Previous in-memory contents are lost. If the file cannot be opened, and AllowExample is true, another file, \"filename.example.ini\", is loaded and then saved as \"filename.ini\". Returns true if successful, false if not.", }, SetValue = { { Params = { { Name = "KeyID", Type = "number", }, { Name = "ValueID", Type = "number", }, { Name = "NewValue", Type = "string", }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Overwrites the specified value with a new value. If the specified value doesn't exist, returns false (doesn't add).", }, { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "NewValue", Type = "string", }, { Name = "CreateIfNotExists", Type = "boolean", IsOptional = true, }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Overwrites the specified value with a new value. If CreateIfNotExists is true (default) and the value doesn't exist, it is first created. Returns true if the value was successfully set, false if not (didn't exists, CreateIfNotExists false).", }, }, SetValueB = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "NewValue", Type = "boolean", }, { Name = "CreateIfNotExists", Type = "boolean", IsOptional = true, }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Overwrites the specified value with a new bool value. If CreateIfNotExists is true (default) and the value doesn't exist, it is first created. Returns true if the value was successfully set, false if not (didn't exists, CreateIfNotExists false).", }, SetValueF = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "NewValue", Type = "number", }, { Name = "CreateIfNotExists", Type = "boolean", IsOptional = true, }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Overwrites the specified value with a new floating-point number value. If CreateIfNotExists is true (default) and the value doesn't exist, it is first created. Returns true if the value was successfully set, false if not (didn't exists, CreateIfNotExists false).", }, SetValueI = { Params = { { Name = "KeyName", Type = "string", }, { Name = "ValueName", Type = "string", }, { Name = "NewValue", Type = "number", }, { Name = "CreateIfNotExists", Type = "boolean", IsOptional = true, }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Overwrites the specified value with a new integer value. If CreateIfNotExists is true (default) and the value doesn't exist, it is first created. Returns true if the value was successfully set, false if not (didn't exists, CreateIfNotExists false).", }, WriteFile = { Params = { { Name = "FileName", Type = "string", }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Writes the current in-memory data into the specified file. Returns true if successful, false if not.", }, }, Constants = { noID = { Notes = "", }, }, AdditionalInfo = { { Header = "Code example: Reading a simple value", Contents = [[ cIniFile is very easy to use. For example, you can find out what port the server is supposed to use according to settings.ini by using this little snippet:
local IniFile = cIniFile();
if (IniFile:ReadFile("settings.ini")) then
ServerPort = IniFile:GetValueI("Server", "Port");
end
]],
},
{
Header = "Code example: Enumerating all objects in a file",
Contents = [[
To enumerate all keys in a file, you need to query the total number of keys, using GetNumKeys(),
and then query each key's name using GetKeyName(). Similarly, to enumerate all values under a
key, you need to query the total number of values using GetNumValues() and then query each
value's name using GetValueName().
The following code logs all keynames and their valuenames into the server log:
local IniFile = cIniFile();
IniFile:ReadFile("somefile.ini")
local NumKeys = IniFile:GetNumKeys();
for k = 0, (NumKeys - 1) do
local NumValues = IniFile:GetNumValues(k);
LOG("key \"" .. IniFile:GetKeyName(k) .. "\" has " .. NumValues .. " values:");
for v = 0, (NumValues - 1) do
LOG(" value \"" .. IniFile:GetValueName(k, v) .. "\".");
end
end
]],
},
},
},
cInventory =
{
Desc = [[
This object is used to store the items that a {{cPlayer|cPlayer}} has. It also keeps track of what item the player has currently selected in their hotbar.
Internally, the class uses three {{cItemGrid|cItemGrid}} objects to store the contents:
When using the raw slot access functions, such as GetSlot() and SetSlot(), the slots are numbered consecutively, each ItemGrid has its offset and count. To future-proff your plugins, use the named constants instead of hard-coded numbers. ]], Functions = { AddItem = { Params = { { Name = "cItem", Type = "cItem", }, { Name = "AllowNewStacks", Type = "boolean", IsOptional = true, }, }, Returns = { { Type = "number", }, }, Notes = "Adds an item to the storage; if AllowNewStacks is true (default), will also create new stacks in empty slots. Fills existing stacks first and fills the hotbar before the main inventory. Returns the number of items added", }, AddItems = { Params = { { Name = "cItems", Type = "cItems", }, { Name = "AllowNewStacks", Type = "boolean", IsOptional = true, }, }, Returns = { { Type = "number", }, }, Notes = "Same as AddItem, but for several items at once", }, ChangeSlotCount = { Params = { { Name = "SlotNum", Type = "number", }, { Name = "AddToCount", Type = "number", }, }, Returns = { { Type = "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 = { Notes = "Empties all slots", }, CopyToItems = { Params = { { Name = "cItems", Type = "cItems", }, }, Notes = "Copies all non-empty slots into the cItems object provided; original cItems contents are preserved", }, DamageEquippedItem = { Params = { { Name = "DamageAmount", Type = "number", IsOptional = true, }, }, Returns = { { Name = "HasDestroyed", Type = "boolean", }, }, Notes = "Adds the specified damage (1 by default) to the currently equipped item. Removes the item and returns true if the item reached its max damage and was destroyed.", }, DamageItem = { Params = { { Name = "SlotNum", Type = "number", }, { Name = "DamageAmount", Type = "number", IsOptional = true, }, }, Returns = { { Name = "HasDestroyed", Type = "boolean", }, }, Notes = "Adds the specified damage (1 by default) to the specified item. Removes the item and returns true if the item reached its max damage and was destroyed.", }, FindItem = { Params = { { Name = "RecipeItem", Type = "cItem", }, }, Returns = { { Type = "cItem", }, }, Notes = "Finds an item in the shield, hotbar and inventory slots matching `ItemType` and `ItemDamage`. The actual item is returned, if none is found `nullptr`. This can be used to validate that the player has a specific type of item.", }, GetArmorGrid = { Returns = { { Type = "cItemGrid", }, }, Notes = "Returns the ItemGrid representing the armor grid (1 x 4 slots)", }, GetArmorSlot = { Params = { { Name = "ArmorSlotNum", Type = "number", }, }, Returns = { { Type = "cItem", }, }, Notes = "Returns the specified armor slot contents. Note that the returned item is read-only", }, GetEquippedBoots = { Returns = { { Type = "cItem", }, }, Notes = "Returns the item in the \"boots\" slot of the armor grid. Note that the returned item is read-only", }, GetEquippedChestplate = { Returns = { { Type = "cItem", }, }, Notes = "Returns the item in the \"chestplate\" slot of the armor grid. Note that the returned item is read-only", }, GetEquippedHelmet = { Returns = { { Type = "cItem", }, }, Notes = "Returns the item in the \"helmet\" slot of the armor grid. Note that the returned item is read-only", }, GetEquippedItem = { Returns = { { Type = "cItem", }, }, Notes = "Returns the currently selected item from the hotbar. Note that the returned item is read-only. Also note that the returned item is bound to the actual inventory slot - if a player moves another item into the slot, this object will update to the new item. Use a {{cItem}} constructor to make a copy if you need to store the contents of the slot.", }, GetEquippedLeggings = { Returns = { { Type = "cItem", }, }, Notes = "Returns the item in the \"leggings\" slot of the armor grid. Note that the returned item is read-only", }, GetEquippedSlotNum = { Returns = { { Type = "number", }, }, Notes = "Returns the hotbar slot number for the currently selected item", }, GetHotbarGrid = { Returns = { { Type = "cItemGrid", }, }, Notes = "Returns the ItemGrid representing the hotbar grid (9 x 1 slots)", }, GetHotbarSlot = { Params = { { Name = "HotBarSlotNum", Type = "number", }, }, Returns = { { Type = "cItem", }, }, Notes = "Returns the specified hotbar slot contents. Note that the returned item is read-only", }, GetShieldSlot = { Returns = { { Type = "cItem", }, }, Notes = "Returns current item in shield slot.", }, GetInventoryGrid = { Returns = { { Type = "cItemGrid", }, }, Notes = "Returns the ItemGrid representing the main inventory (9 x 3 slots)", }, GetInventorySlot = { Params = { { Name = "InventorySlotNum", Type = "number", }, }, Returns = { { Type = "cItem", }, }, Notes = "Returns the specified main inventory slot contents. Note that the returned item is read-only", }, GetOwner = { Returns = { { Type = "cPlayer", }, }, Notes = "Returns the player whose inventory this object represents", }, GetSlot = { Params = { { Name = "SlotNum", Type = "number", }, }, Returns = { { Type = "cItem", }, }, Notes = "Returns the contents of the specified slot. Note that the returned item is read-only", }, HasItems = { Params = { { Name = "cItem", Type = "cItem", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if there are at least as many items of the specified type as in the parameter", }, HowManyCanFit = { { Params = { { Name = "ItemStack", Type = "cItem", }, { Name = "AllowNewStacks", Type = "boolean", IsOptional = true, }, }, Returns = { { Type = "number", }, }, Notes = "Returns number of items out of a_ItemStack that can fit in the storage. If AllowNewStacks is false, only considers slots already containing the specified item. AllowNewStacks defaults to true if not given.", }, { Params = { { Name = "ItemStack", Type = "cItem", }, { Name = "BeginSlotNum", Type = "number", }, { Name = "EndSlotNum", Type = "number", }, { Name = "AllowNewStacks", Type = "boolean", IsOptional = true, }, }, Returns = { { Type = "number", }, }, Notes = "Returns how many items of the specified type would fit into the slot range specified. If AllowNewStacks is false, only considers slots already containing the specified item. AllowNewStacks defaults to true if not given.", }, }, HowManyItems = { Params = { { Name = "cItem", Type = "cItem", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the number of the specified items that are currently stored", }, RemoveItem = { Params = { { Name = "cItem", Type = "cItem", }, }, Returns = { { Type = "number", }, }, Notes = "Removes the specified item from the inventory, as many as possible, up to the item's m_ItemCount. Returns the number of items that were removed.", }, RemoveOneEquippedItem = { Returns = { { Type = "boolean", }, }, Notes = "Removes one item from the hotbar's currently selected slot. Returns true on success.", }, ReplaceOneEquippedItem = { Params = { { Name = "Item", Type = "cItem", }, { Name = "TryOtherSlots", Type = "boolean", IsOptional = true, }, }, Returns = { { Type = "number", }, }, Notes = "Removes one item from the the current equipped item stack, and attempts to add the specified item stack back to the same slot. If it is not possible to place the item in the same slot, optionally (default true) tries to place the specified item elsewhere in the inventory. Returns the number of items successfully added. If the currently equipped slot is empty, its contents are simply set to the given Item.", }, SendEquippedSlot = { Notes = "Sends the equipped item slot to the client", }, SetArmorSlot = { Params = { { Name = "ArmorSlotNum", Type = "number", }, { Name = "cItem", Type = "cItem", }, }, Notes = "Sets the specified armor slot contents", }, SetEquippedSlotNum = { Params = { { Name = "EquippedSlotNum", Type = "number", }, }, Notes = "Sets the currently selected hotbar slot number", }, SetHotbarSlot = { Params = { { Name = "HotbarSlotNum", Type = "number", }, { Name = "cItem", Type = "cItem", }, }, Notes = "Sets the specified hotbar slot contents", }, SetInventorySlot = { Params = { { Name = "InventorySlotNum", Type = "number", }, { Name = "cItem", Type = "cItem", }, }, Notes = "Sets the specified main inventory slot contents", }, SetShieldSlot = { Params = { { Name = "Item", Type = "cItem", }, }, Notes = "Sets the shield slot content", }, SetSlot = { Params = { { Name = "SlotNum", Type = "number", }, { Name = "cItem", Type = "cItem", }, }, Notes = "Sets the specified slot contents", }, SetEquippedItem = { Params = { { Name = "Item", Type = "cItem", }, }, Notes = "Sets current item in the equipped hotbar slot", }, }, Constants = { invArmorCount = { Notes = "Number of slots in the Armor part", }, invArmorOffset = { Notes = "Starting slot number of the Armor part", }, invHotbarCount = { Notes = "Number of slots in the Hotbar part", }, invHotbarOffset = { Notes = "Starting slot number of the Hotbar part", }, invInventoryCount = { Notes = "Number of slots in the main inventory part", }, invInventoryOffset = { Notes = "Starting slot number of the main inventory part", }, invShieldCount = { Notes = "Number of slots in the Shield part", }, invShieldOffset = { Notes = "Starting slot number of the Shield part", }, invNumSlots = { Notes = "Total number of slots in a cInventory", }, }, ConstantGroups = { SlotIndices = { Include = "inv.*", TextBefore = [[ Rather than hardcoding numbers, use the following constants for slot indices and counts: ]], }, }, }, cItem = { Desc = [[ cItem is what defines an item or stack of items in the game, it contains the item ID, damage, quantity and enchantments. Each slot in a {{cInventory}} class or a {{cItemGrid}} class is a cItem and each {{cPickup}} contains a cItem. The enchantments are contained in a separate {{cEnchantments}} class and are accessible through the m_Enchantments variable.
To test if a cItem object represents an empty item, do not compare the item type nor the item count, but rather use the IsEmpty() function.
To translate from a cItem to its string representation, use the {{Globals#functions|global function}} ItemToString(), ItemTypeToString() or ItemToFullString(). To translate from a string to a cItem, use the StringToItem() global function. ]], Functions = { AddCount = { Params = { { Name = "AmountToAdd", Type = "number", }, }, Returns = { { Type = "cItem", }, }, Notes = "Adds the specified amount to the item count. Returns self (useful for chaining).", }, AddEnchantment = { Params = { { Name = "Enchantment ID", Type = "number", }, { Name = "Level", Type = "number", }, { Name = "FromBook", Type = "boolean", }, }, Returns = { { Type = "number", }, }, Notes = "Adds the given enchantment at the given level to this item, following anvil enchantment combining rules. Returns the XP level cost of the addition. FromBook specifies whether to use the XP multiplier for books or the multiplier used for other items, if true it uses the multiplier for books.", }, AddEnchantmentsFromItem = { Params = { { Name = "Additive", Type = "cItem", }, }, Returns = { { Name = "LevelCost", Type = "number", }, }, Notes = "Adds the enchantments from the specified item to this item, returning the cost as if this were an anvil.", }, Clear = { Notes = "Resets the instance to an empty item", }, constructor = { { Returns = { { Type = "cItem", }, }, Notes = "Creates a new empty cItem object", }, { Params = { { Name = "ItemType", Type = "number", }, { Name = "Count", Type = "number", IsOptional = true, }, { Name = "Damage", Type = "number", IsOptional = true, }, { Name = "EnchantmentString", Type = "string", IsOptional = true, }, { Name = "CustomName", Type = "string", IsOptional = true, }, { Name = "Lore", Type = "table", IsOptional = true, }, }, Returns = { { Type = "cItem", }, }, Notes = "Creates a new cItem object of the specified type, count (1 by default), damage (0 by default), enchantments (non-enchanted by default), CustomName (empty by default) and Lore (string, empty by default)", }, { Params = { { Name = "cItem", Type = "cItem", }, }, Returns = { { Type = "cItem", }, }, Notes = "Creates an exact copy of the cItem object in the parameter", }, }, CopyOne = { Returns = { { Type = "cItem", }, }, Notes = "Creates a copy of this object, with its count set to 1", }, DamageItem = { Params = { { Name = "Amount", Type = "number", IsOptional = true, }, }, Returns = { { Name = "HasReachedMaxDamage", Type = "boolean", }, }, 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 = { Notes = "Resets the instance to an empty item", }, EnchantByXPLevels = { Params = { { Name = "NumXPLevels", Type = "number", }, }, Returns = { { Name = "HasEnchanted", Type = "boolean", }, }, Notes = "Randomly enchants the item using the specified number of XP levels. Returns true if the item was enchanted, false if not (not enchantable / too many enchantments already).", }, GetEnchantability = { Returns = { { Type = "number", }, }, Notes = "Returns the enchantability of the item. Returns zero if the item doesn't have enchantability.", }, GetMaxDamage = { Returns = { { Type = "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", }, GetMaxStackSize = { Returns = { { Type = "number", }, }, Notes = "Returns the maximum stack size for this item.", }, IsBothNameAndLoreEmpty = { Returns = { { Type = "boolean", }, }, Notes = "Returns if both the custom name and lore are not set.", }, IsCustomNameEmpty = { Returns = { { Type = "boolean", }, }, Notes = "Returns if the custom name is empty.", }, IsDamageable = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if this item does account for its damage", }, IsEmpty = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if this object represents an empty item (zero count or invalid ItemType)", }, IsEnchantable = { IsStatic = true, Params = { { Name = "ItemType", Type = "number", }, { Name = "FromBook", Type = "boolean", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the specified item type is enchantable. If FromBook is true, the function is used in the anvil inventory with book enchantments. So it checks the \"only book enchantments\" too. Example: You can only enchant a hoe with a book.", }, IsEqual = { Params = { { Name = "OtherItem", Type = "cItem", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the item in the parameter is the same as the one stored in the object (type, damage, lore, name and enchantments)", }, IsFullStack = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the item is stacked up to its maximum stacking", }, IsLoreEmpty = { Notes = "Returns if the lore of the cItem is empty.", Returns = { { Type = "boolean", }, }, }, IsSameType = { Params = { { Name = "OtherItem", Type = "cItem", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the item in the parameter is of the same ItemType as the one stored in the object. This is true even if the two items have different enchantments", }, }, Variables = { m_CustomName = { Type = "string", Notes = "The custom name for an item.", }, m_Enchantments = { Type = "{{cEnchantments|cEnchantments}}}", Notes = "The enchantments of the item.", }, m_ItemCount = { Type = "number", Notes = "Number of items in this stack", }, m_ItemDamage = { Type = "number", Notes = "The damage of the item. Zero means no damage. Maximum damage can be queried with GetMaxDamage()", }, m_ItemType = { Type = "number", Notes = "The item type. One of E_ITEM_ or E_BLOCK_ constants", }, m_LoreTable = { Type = "table", Notes = "The lore for an item. Represented as an array table of lines.", }, m_RepairCost = { Type = "number", Notes = "The repair cost of the item. The anvil need this value", }, }, AdditionalInfo = { { Header = "Usage notes", Contents = [[ Note that the object contained in a cItem class is quite complex and quite often new Minecraft versions add more stuff. Therefore it is recommended to copy cItem objects using the copy-constructor ("local copy = cItem(original);"), this is the only way that guarantees that the object will be copied at full, even with future versions of Cuberite. ]], }, { Header = "Example code", Contents = [[ The following code shows how to create items in several different ways (adapted from the Debuggers plugin):
-- empty item: local Item1 = cItem(); -- enchanted sword, enchantment given as numeric string (bad style; see Item5): local Item2 = cItem(E_ITEM_DIAMOND_SWORD, 1, 0, "1=1"); -- 1 undamaged shovel, no enchantment: local Item3 = cItem(E_ITEM_DIAMOND_SHOVEL); -- Add the Unbreaking enchantment. Note that Vanilla's levelcap isn't enforced: Item3.m_Enchantments:SetLevel(cEnchantments.enchUnbreaking, 4); -- 1 undamaged pickaxe, no enchantment: local Item4 = cItem(E_ITEM_DIAMOND_PICKAXE); -- Add multiple enchantments: Item4.m_Enchantments:SetLevel(cEnchantments.enchUnbreaking, 5); Item4.m_Enchantments:SetLevel(cEnchantments.enchEfficiency, 3); -- enchanted chestplate, enchantment given as textual stringdesc (good style) local Item5 = cItem(E_ITEM_DIAMOND_CHESTPLATE, 1, 0, "thorns=1;unbreaking=3");]], }, }, }, cItemFrame = { Functions = { GetItem = { Returns = { { Type = "cItem", IsConst = true, }, }, Notes = "Returns the item in the frame (readonly object, do not modify)", }, GetItemRotation = { Returns = { { Type = "number", }, }, Notes = "Returns the rotation from the item in the frame", }, SetItem = { Params = { { Name = "Item", Type = "cItem", }, }, Notes = "Set the item in the frame", }, SetItemRotation = { Params = { { Name = "ItemRotation", Type = "number", }, }, Notes = "Set the rotation from the item in the frame", }, }, }, cItemGrid = { Desc = [[ This class represents a 2D array of items. It is used as the underlying storage and API for all cases that use a grid of items:
The items contained in this object are accessed either by a pair of XY coords, or a slot number (x + Width * y). There are functions available for converting between the two formats. ]], Functions = { AddItem = { Params = { { Name = "ItemStack", Type = "cItem", }, { Name = "AllowNewStacks", Type = "boolean", IsOptional = true, }, { Name = "PrioritySlot", Type = "number", IsOptional = true, }, }, Returns = { { Type = "number", }, }, Notes = "Adds as many items out of ItemStack as can fit. If AllowNewStacks is set to false, only existing stacks can be topped up. If AllowNewStacks is set to true (default), empty slots can be used for the rest. If PrioritySlot is set to a non-negative value, then the corresponding slot will be used first (if empty or compatible with added items). If PrioritySlot is set to -1 (default), regular order applies. Returns the number of items that fit.", }, AddItems = { Params = { { Name = "ItemStackList", Type = "cItems", }, { Name = "AllowNewStacks", Type = "boolean", IsOptional = true, }, { Name = "PrioritySlot", Type = "number", IsOptional = true, }, }, Returns = { { Type = "number", }, }, Notes = "Same as AddItem, but works on an entire list of item stacks. The a_ItemStackList is modified to reflect the leftover items. If a_AllowNewStacks is set to false, only existing stacks can be topped up. If AllowNewStacks is set to true, empty slots can be used for the rest. If PrioritySlot is set to a non-negative value, then the corresponding slot will be used first (if empty or compatible with added items). If PrioritySlot is set to -1 (default), regular order applies. Returns the total number of items that fit.", }, ChangeSlotCount = { { Params = { { Name = "SlotNum", Type = "number", }, { Name = "AddToCount", Type = "number", }, }, Returns = { { Type = "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 = { { Name = "X", Type = "number", }, { Name = "Y", Type = "number", }, { Name = "AddToCount", Type = "number", }, }, Returns = { { Type = "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 = { Notes = "Empties all slots", }, CopyToItems = { Params = { { Name = "cItems", Type = "cItems", }, }, Notes = "Copies all non-empty slots into the {{cItems}} object provided; original cItems contents are preserved as well.", }, DamageItem = { { Params = { { Name = "SlotNum", Type = "number", }, { Name = "DamageAmount", Type = "number", IsOptional = true, }, }, Returns = { { Name = "HasReachedMaxDamage", Type = "boolean", }, }, 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 (but doesn't destroy the item).", }, { Params = { { Name = "X", Type = "number", }, { Name = "Y", Type = "number", }, { Name = "DamageAmount", Type = "number", IsOptional = true, }, }, Returns = { { Name = "HasReachedMaxDamage", Type = "boolean", }, }, 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 (but doesn't destroy the item).", }, }, EmptySlot = { { Params = { { Name = "SlotNum", Type = "number", }, }, Notes = "Destroys the item in the specified slot", }, { Params = { { Name = "X", Type = "number", }, { Name = "Y", Type = "number", }, }, Notes = "Destroys the item in the specified slot", }, }, FindItem = { Params = { { Name = "RecipeItem", Type = "cItem", }, }, Returns = { { Type = "cItem", }, }, Notes = "Finds an item within the grid matching `ItemType` and `ItemDamage`. The actual item is returned, if none is found `nullptr`.", }, GetFirstEmptySlot = { Returns = { { Type = "number", }, }, Notes = "Returns the SlotNumber of the first empty slot, -1 if all slots are full", }, GetFirstUsedSlot = { Returns = { { Type = "number", }, }, Notes = "Returns the SlotNumber of the first non-empty slot, -1 if all slots are empty", }, GetHeight = { Returns = { { Type = "number", }, }, Notes = "Returns the Y dimension of the grid", }, GetLastEmptySlot = { Returns = { { Type = "number", }, }, Notes = "Returns the SlotNumber of the last empty slot, -1 if all slots are full", }, GetLastUsedSlot = { Returns = { { Type = "number", }, }, Notes = "Returns the SlotNumber of the last non-empty slot, -1 if all slots are empty", }, GetNextEmptySlot = { Params = { { Name = "StartFrom", Type = "number", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the SlotNumber of the first empty slot following StartFrom, -1 if all the following slots are full", }, GetNextUsedSlot = { Params = { { Name = "StartFrom", Type = "number", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the SlotNumber of the first non-empty slot following StartFrom, -1 if all the following slots are full", }, GetNumSlots = { Returns = { { Type = "number", }, }, Notes = "Returns the total number of slots in the grid (Width * Height)", }, GetSlot = { { Params = { { Name = "SlotNumber", Type = "number", }, }, Returns = { { Type = "cItem", }, }, Notes = "Returns the item in the specified slot. Note that the item is read-only", }, { Params = { { Name = "X", Type = "number", }, { Name = "Y", Type = "number", }, }, Returns = { { Type = "cItem", }, }, Notes = "Returns the item in the specified slot. Note that the item is read-only", }, }, GetSlotCoords = { Params = { { Name = "SlotNum", Type = "number", }, }, Returns = { { Type = "number", }, { Type = "number", }, }, Notes = "Returns the X and Y coords for the specified SlotNumber. Returns \"-1, -1\" on invalid SlotNumber", }, GetSlotNum = { Params = { { Name = "X", Type = "number", }, { Name = "Y", Type = "number", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the SlotNumber for the specified slot coords. Returns -1 on invalid coords", }, GetWidth = { Returns = { { Type = "number", }, }, Notes = "Returns the X dimension of the grid", }, HasItems = { Params = { { Name = "ItemStack", Type = "cItem", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if there are at least as many items of the specified type as in the parameter", }, HowManyCanFit = { Params = { { Name = "ItemStack", Type = "cItem", }, { Name = "AllowNewStacks", Type = "boolean", IsOptional = true, }, }, Returns = { { Type = "number", }, }, Notes = "Returns the number of the specified items that can fit in the storage. If AllowNewStacks is true (default), includes empty slots in the returned count.", }, HowManyItems = { Params = { { Name = "Item", Type = "cItem", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the number of the specified item that are currently stored", }, IsSlotEmpty = { { Params = { { Name = "SlotNum", Type = "number", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the specified slot is empty, or an invalid slot is specified", }, { Params = { { Name = "X", Type = "number", }, { Name = "Y", Type = "number", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the specified slot is empty, or an invalid slot is specified", }, }, RemoveItem = { Params = { { Name = "ItemStack", Type = "cItem", }, }, Returns = { { Type = "number", }, }, Notes = "Removes the specified item from the grid, as many as possible, up to ItemStack's m_ItemCount. Returns the number of items that were removed.", }, RemoveOneItem = { { Params = { { Name = "SlotNum", Type = "number", }, }, Returns = { { Type = "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 = { { Name = "X", Type = "number", }, { Name = "Y", Type = "number", }, }, Returns = { { Type = "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 = { { Name = "SlotNum", Type = "number", }, { Name = "cItem", Type = "cItem", }, }, Notes = "Sets the specified slot to the specified item", }, { Params = { { Name = "SlotNum", Type = "number", }, { Name = "ItemType", Type = "number", }, { Name = "ItemCount", Type = "number", }, { Name = "ItemDamage", Type = "number", }, }, Notes = "Sets the specified slot to the specified item", }, { Params = { { Name = "X", Type = "number", }, { Name = "Y", Type = "number", }, { Name = "cItem", Type = "cItem", }, }, Notes = "Sets the specified slot to the specified item", }, { Params = { { Name = "X", Type = "number", }, { Name = "Y", Type = "number", }, { Name = "ItemType", Type = "number", }, { Name = "ItemCount", Type = "number", }, { Name = "ItemDamage", Type = "number", }, }, Notes = "Sets the specified slot to the specified item", }, }, }, AdditionalInfo = { { Header = "Code example: Add items to player inventory", Contents = [[ The following code tries to add 32 sticks to a player's main inventory:
local Items = cItem(E_ITEM_STICK, 32);
local PlayerInventory = Player:GetInventory();
local PlayerMainInventory = PlayerInventory:GetInventoryGrid(); -- PlayerMainInventory is of type cItemGrid
local NumAdded = PlayerMainInventory:AddItem(Items);
if (NumAdded == Items.m_ItemCount) then
-- All the sticks did fit
LOG("Added 32 sticks");
else
-- Some (or all) of the sticks didn't fit
LOG("Tried to add 32 sticks, but only " .. NumAdded .. " could fit");
end
]],
},
{
Header = "Code example: Damage an item",
Contents = [[
The following code damages the helmet in the player's armor and destroys it if it reaches max damage:
local PlayerInventory = Player:GetInventory(); local PlayerArmor = PlayerInventory:GetArmorGrid(); -- PlayerArmor is of type cItemGrid if (PlayerArmor:DamageItem(0)) then -- Helmet is at SlotNum 0 -- The helmet has reached max damage, destroy it: PlayerArmor:EmptySlot(0); end]], }, }, }, cItems = { Desc = [[ This class represents a numbered collection (array) of {{cItem}} objects. The array indices start at zero, each consecutive item gets a consecutive index. This class is used for spawning multiple pickups or for mass manipulating an inventory. ]], Functions = { Add = { { Params = { { Name = "cItem", Type = "cItem", }, }, Notes = "Adds a new item to the end of the collection", }, { Params = { { Name = "ItemType", Type = "number", }, { Name = "ItemCount", Type = "number", }, { Name = "ItemDamage", Type = "number", }, }, Notes = "Adds a new item to the end of the collection", }, }, AddItemGrid = { Params = { { Name = "ItemGrid", Type = "cItemGrid", }, }, Notes = "Adds a copy of each item in the specified {{cItemGrid|ItemGrid}}.", }, Clear = { Notes = "Removes all items from the collection", }, constructor = { Returns = { { Type = "cItems", }, }, Notes = "Creates a new empty cItems object", }, Contains = { Params = { { Name = "Item", Type = "cItem", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the collection contains an item that is fully equivalent to the parameter", }, ContainsType = { Params = { { Name = "Item", Type = "cItem", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the collection contains an item that is the same type as the parameter", }, Delete = { Params = { { Name = "Index", Type = "number", }, }, Notes = "Deletes item at the specified index", }, Get = { Params = { { Name = "Index", Type = "number", }, }, Returns = { { Type = "cItem", }, }, Notes = "Returns the item at the specified index", }, Set = { { Params = { { Name = "Index", Type = "number", }, { Name = "cItem", Type = "cItem", }, }, Notes = "Sets the item at the specified index to the specified item", }, { Params = { { Name = "Index", Type = "number", }, { Name = "ItemType", Type = "number", }, { Name = "ItemCount", Type = "number", }, { Name = "ItemDamage", Type = "number", }, }, Notes = "Sets the item at the specified index to the specified item", }, }, Size = { Returns = { { Type = "number", }, }, Notes = "Returns the number of items in the collection", }, }, }, cJson = { Desc = [[ Exposes the Json parser and serializer available in the server. Plugins can parse Json strings into Lua tables, and serialize Lua tables into Json strings easily. ]], Functions = { Parse = { IsStatic = true, Params = { { Name = "InputString", Type = "string", }, }, Returns = { { Type = "table", }, }, Notes = "Parses the Json in the input string into a Lua table. Returns nil and detailed error message if parsing fails.", }, Serialize = { IsStatic = true, Params = { { Name = "table", Type = "table", }, { Name = "options", Type = "table", IsOptional = true, }, }, Returns = { { Type = "string", }, }, Notes = "Serializes the input table into a Json string. The options table, if present, is used to adjust the formatting of the serialized string, see below for details.
local t1 = cJson:Parse([[{"a": 1, "b": "2", "c": [3, "4", 5]}]])
assert(t1.a == 1)
assert(t1.b == "2")
assert(t1.c[1] == 3)
assert(t1.c[2] == "4")
assert(t1.c[3] == 5)
]==],
},
{
Header = "Code example: Serializing into a Json string",
Contents = [[
The following code, adapted from the Debuggers plugin, serializes a simple Lua table into a
string, using custom indentation:
local s1 = cJson:Serialize({a = 1, b = "2", c = {3, "4", 5}}, {indentation = " "})
LOG("Serialization result: " .. (s1 or ""))
]],
},
},
},
cLuaWindow =
{
Desc = [[
This class is used by plugins wishing to display a custom window to the player, unrelated to block entities or entities near the player. The window can be of any type and have any contents that the plugin defines. Callbacks for when the player modifies the window contents and when the player closes the window can be set.
This class inherits from the {{cWindow|cWindow}} class, so all cWindow's functions and constants can be used, in addition to the cLuaWindow-specific functions listed below.
The contents of this window are represented by a {{cWindow|cWindow}}:GetSlot() etc. or {{cPlayer|cPlayer}}:GetInventory() to access the player inventory.
When creating a new cLuaWindow object, you need to specify both the window type and the contents' width and height. Note that Cuberite accepts any combination of these, but opening a window for a player may crash their client if the contents' dimensions don't match the client's expectations.
To open the window for a player, call {{cPlayer|cPlayer}}:OpenWindow(). Multiple players can open window of the same cLuaWindow object. All players see the same items in the window's contents (like chest, unlike crafting table). ]], Functions = { constructor = { Params = { { Name = "WindowType", Type = "cWindow#WindowType", }, { Name = "ContentsWidth", Type = "number", }, { Name = "ContentsHeight", Type = "number", }, { Name = "Title", Type = "string", }, }, Notes = "Creates a new object of this class. The window is not shown to any player yet.", }, GetContents = { Returns = { { Type = "cItemGrid", }, }, Notes = "Returns the cItemGrid object representing the internal storage in this window", }, SetOnClicked = { Params = { { Name = "OnClickedCallback", Type = "function", }, }, Notes = "Sets the function that the window will call when it is about to process a click from a player. See {{#additionalinfo_1|below}} for the signature of the callback function.", }, SetOnClosing = { Params = { { Name = "OnClosingCallback", Type = "function", }, }, Notes = "Sets the function that the window will call when it is about to be closed by a player", }, SetOnSlotChanged = { Params = { { Name = "OnSlotChangedCallback", Type = "function", }, }, Notes = "Sets the function that the window will call when a slot is changed by a player", }, }, AdditionalInfo = { { Header = "Callbacks", Contents = [[ The object calls the following functions at the appropriate time: ]], }, { Header = "OnClicked Callback", Contents = [[ This callback, settable via the SetOnClicked() function, will be called when the player clicks a slot in the window. The callback can cancel the click.
function OnWindowClicked(a_Window, a_Player, a_SlotNum, a_ClickAction, a_ClickedItem)
The a_Window parameter is the cLuaWindow object representing the window, a_Player is the player who made the click, a_SlotNum is the slot the player clicked, a_ClickAction is the type of click the player made, and a_ClickedItem is the item the player clicked on, if applicable. If the function returns true, the click is cancelled (internally, the server resends the window slots to the player to keep the player in sync). ]], }, { Header = "OnClosing Callback", Contents = [[ This callback, settable via the SetOnClosing() function, will be called when the player tries to close the window, or the window is closed for any other reason (such as a player disconnecting).
function OnWindowClosing(a_Window, a_Player, a_CanRefuse)
The a_Window parameter is the cLuaWindow object representing the window, a_Player is the player for whom the window is about to close. a_CanRefuse specifies whether the callback can refuse the closing. If the callback returns true and a_CanRefuse is true, the window is not closed (internally, the server sends a new OpenWindow packet to the client). ]], }, { Header = "OnSlotChanged Callback", Contents = [[ This callback, settable via the SetOnSlotChanged() function, will be called whenever the contents of any slot in the window's contents (i. e. NOT in the player inventory!) changes.
function OnWindowSlotChanged(a_Window, a_SlotNum)
The a_Window parameter is the cLuaWindow object representing the window, a_SlotNum is the slot number. There is no reference to a {{cPlayer}}, because the slot change needn't originate from the player action. To get or set the slot, you'll need to retrieve a cPlayer object, for example by calling {{cWorld|cWorld}}:DoWithPlayer().
Any returned values are ignored. ]], }, { Header = "Example", Contents = [[ This example is taken from the Debuggers plugin, used to test the API functionality. It opens a window and refuse to close it 3 times. It also logs slot changes to the server console and prevents shift-clicking in the window.
-- Callback that refuses to close the window twice, then allows:
local Attempt = 1;
local OnClosing = function(Window, Player, CanRefuse)
Player:SendMessage("Window closing attempt #" .. Attempt .. "; CanRefuse = " .. tostring(CanRefuse));
Attempt = Attempt + 1;
return CanRefuse and (Attempt <= 3); -- refuse twice, then allow, unless CanRefuse is set to true
end
-- Log the slot changes:
local OnSlotChanged = function(Window, SlotNum)
LOG("Window \"" .. Window:GetWindowTitle() .. "\" slot " .. SlotNum .. " changed.");
end
-- Prevent shift-clicking:
local OnClicked = function(Window, ClickingPlayer, SlotNum, ClickAction, ClickedItem)
if ClickAction == caShiftLeftClick then
return true
end
end
-- Set window contents:
-- a_Player is a cPlayer object received from the outside of this code fragment
local Window = cLuaWindow(cWindow.wtHopper, 3, 3, "TestWnd");
Window:SetSlot(a_Player, 0, cItem(E_ITEM_DIAMOND, 64));
Window:SetOnClicked(OnClicked);
Window:SetOnClosing(OnClosing);
Window:SetOnSlotChanged(OnSlotChanged);
-- Open the window:
a_Player:OpenWindow(Window);
]],
},
},
Inherits = "cWindow",
},
cMap =
{
Desc = [[
This class encapsulates a single in-game colored map.
The contents (i.e. pixel data) of a cMap are dynamically updated by each tracked {{cPlayer}} instance. Furthermore, a cMap maintains and periodically updates a list of map decorators, which are objects drawn on the map that can freely move (e.g. Player and item frame pointers). ]], Functions = { EraseData = { Notes = "Erases all pixel data.", }, GetCenterX = { Returns = { { Type = "number", }, }, Notes = "Returns the X coord of the map's center.", }, GetCenterZ = { Returns = { { Type = "number", }, }, Notes = "Returns the Y coord of the map's center.", }, GetDimension = { Returns = { { Type = "eDimension", }, }, Notes = "Returns the dimension of the associated world.", }, GetHeight = { Returns = { { Type = "number", }, }, Notes = "Returns the height of the map.", }, GetID = { Returns = { { Type = "number", }, }, Notes = "Returns the numerical ID of the map. (The item damage value)", }, GetName = { Returns = { { Type = "string", }, }, Notes = "Returns the name of the map.", }, GetNumPixels = { Returns = { { Type = "number", }, }, Notes = "Returns the number of pixels in this map.", }, GetPixel = { Params = { { Name = "PixelX", Type = "number", }, { Name = "PixelZ", Type = "number", }, }, Returns = { { Name = "ColorID", Type = "number", }, }, Notes = "Returns the color of the specified pixel.", }, GetPixelWidth = { Returns = { { Type = "number", }, }, Notes = "Returns the width of a single pixel in blocks.", }, GetScale = { Returns = { { Type = "number", }, }, Notes = "Returns the scale of the map. Range: [0,4]", }, GetWidth = { Returns = { { Type = "number", }, }, Notes = "Returns the width of the map.", }, GetWorld = { Returns = { { Type = "cWorld", }, }, Notes = "Returns the associated world.", }, Resize = { Params = { { Name = "Width", Type = "number", }, { Name = "Height", Type = "number", }, }, Notes = "Resizes the map. WARNING: This will erase the pixel data.", }, SetPixel = { Params = { { Name = "PixelX", Type = "number", }, { Name = "PixelZ", Type = "number", }, { Name = "ColorID", Type = "number", }, }, Returns = { { Name = "IsSuccess", Type = "boolean", }, }, Notes = "Sets the color of the specified pixel. Returns false on error (Out of range).", }, SetPosition = { Params = { { Name = "CenterX", Type = "number", }, { Name = "CenterZ", Type = "number", }, }, Notes = "Relocates the map. The pixel data will not be modified.", }, SetScale = { Params = { { Name = "Scale", Type = "number", }, }, Notes = "Rescales the map. The pixel data will not be modified.", }, }, Constants = { E_BASE_COLOR_BLUE = { Notes = "", }, E_BASE_COLOR_BROWN = { Notes = "", }, E_BASE_COLOR_DARK_BROWN = { Notes = "", }, E_BASE_COLOR_DARK_GRAY = { Notes = "", }, E_BASE_COLOR_DARK_GREEN = { Notes = "", }, E_BASE_COLOR_GRAY_1 = { Notes = "", }, E_BASE_COLOR_GRAY_2 = { Notes = "", }, E_BASE_COLOR_LIGHT_BROWN = { Notes = "", }, E_BASE_COLOR_LIGHT_GRAY = { Notes = "", }, E_BASE_COLOR_LIGHT_GREEN = { Notes = "", }, E_BASE_COLOR_PALE_BLUE = { Notes = "", }, E_BASE_COLOR_RED = { Notes = "", }, E_BASE_COLOR_TRANSPARENT = { Notes = "", }, E_BASE_COLOR_WHITE = { Notes = "", }, }, }, cMapManager = { Desc = [[ This class is associated with a single {{cWorld}} instance and manages a list of maps. ]], Functions = { DoWithMap = { Params = { { Name = "MapID", Type = "number", }, { Name = "CallbackFunction", Type = "function", }, }, Returns = { { Type = "boolean", }, }, Notes = "If a map with the specified ID exists, calls the CallbackFunction for that map. The CallbackFunction has the following signature:
function Callback({{cMap|Map}}) Returns true if the map was found and the callback called, false if map not found.",
},
GetNumMaps =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the number of registered maps.",
},
},
},
cMojangAPI =
{
Desc = [[
Provides interface to various API functions that Mojang provides through their servers. Note that
some of these calls will wait for a response from the network, and so shouldn't be used while the
server is fully running (or at least when there are players connected) to avoid percepted lag.
All the functions are static, call them using the cMojangAPI:Function() convention.
Mojang uses two formats for UUIDs, short and dashed. Cuberite will accept either format for any functions taking a UUID. The MakeUUIDShort() and MakeUUIDDashed() functions are provided for plugins to use for conversion between the two formats.
This class will cache values returned by the API service. The cache will hold the values for 7 days by default, after that, they will no longer be available. This is in order to not let the server get banned from using the API service, since they are rate-limited to 600 queries per 10 minutes. The cache contents also gets updated whenever a player successfully joins, since that makes the server contact the API service, too, and retrieve the relevant data.
]], Functions = { AddPlayerNameToUUIDMapping = { IsStatic = true, Params = { { Name = "PlayerName", Type = "string", }, { Name = "UUID", Type = "cUUID", }, }, Notes = "Adds the specified PlayerName-to-UUID mapping into the cache, with current timestamp.", }, GetPlayerNameFromUUID = { IsStatic = true, Params = { { Name = "UUID", Type = "cUUID", }, { Name = "UseOnlyCached", Type = "boolean", IsOptional = true, }, }, Returns = { { Name = "PlayerName", Type = "string", }, }, Notes = "Returns the playername that corresponds to the given UUID, or an empty string on error. If UseOnlyCached is false (the default), queries the Mojang servers if the UUID is not in the cache. The UUID can be either short or dashed.
To spawn a mob in a world, use the {{cWorld}}:SpawnMob() function.
]],
Functions =
{
BurnsInDaylight =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns whether the mob burns in daylight.",
},
CanBeLeashed =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns whether the mob can be leashed.",
},
FamilyFromType =
{
IsStatic = true,
Params =
{
{
Name = "MobType",
Type = "eMonsterType",
},
},
Returns =
{
{
Name = "MobFamily",
Type = "cMonster#eFamily",
},
},
Notes = "Returns the mob family ({{cMonster#eFamily|mfXXX}} constants) based on the mob type ({{Globals#eMonsterType|mtXXX}} constants)",
},
GetAge =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the age of the monster",
},
GetCustomName =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Gets the custom name of the monster. If no custom name is set, the function returns an empty string.",
},
GetLeashedTo =
{
Returns =
{
{
Name = "LeashedTo",
Type = "cEntity",
},
},
Notes = "Returns the entity to where this mob is leashed, returns nil if it's not leashed",
},
GetMobFamily =
{
Returns =
{
{
Name = "MobFamily",
Type = "cMonster#eFamily",
},
},
Notes = "Returns this mob's family ({{cMonster#eFamily|mfXXX}} constant)",
},
GetMobType =
{
Returns =
{
{
Name = "MobType",
Type = "eMonsterType",
},
},
Notes = "Returns the type of this mob ({{Globals#eMonsterType|mtXXX}} constant)",
},
GetRelativeWalkSpeed =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the relative walk speed of this mob. Standard is 1.0",
},
HasCustomName =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the monster has a custom name.",
},
IsBaby =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the monster is a baby",
},
IsCustomNameAlwaysVisible =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Is the custom name of this monster always visible? If not, you only see the name when you sight the mob.",
},
IsLeashed =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns whether the monster is leashed to an entity.",
},
LeashTo =
{
Params =
{
{
Name = "Entity",
Type = "cEntity",
}
},
Notes = "Leash the monster to an entity.",
},
MobTypeToString =
{
IsStatic = true,
Params =
{
{
Name = "MobType",
Type = "eMonsterType",
},
},
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the string representing the given mob type ({{Globals#eMonsterType|mtXXX}} constant), or empty string if unknown type.",
},
MobTypeToVanillaName =
{
IsStatic = true,
Params =
{
{
Name = "MobType",
Type = "eMonsterType",
},
},
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the vanilla name of the given mob type, or empty string if unknown type.",
},
MoveToPosition =
{
Params =
{
{
Name = "Position",
Type = "Vector3d",
},
},
Notes = "Start moving (using a pathfinder) towards the specified position",
},
SetAge =
{
Params =
{
{
Name = "Age",
Type = "number",
},
},
Notes = "Sets the age of the monster",
},
SetBurnsInDaylight =
{
Params =
{
{
Name = "BurnsInDaylight",
Type = "boolean",
},
},
Notes = "Sets whether the mob burns in daylight. Only evaluated at next burn-decision tick",
},
SetCanBeLeashed =
{
Params =
{
{
Name = "CanBeLeashed",
Type = "boolean",
}
},
Notes = "Sets whether the mob can be leashed, for extensibility in plugins"
},
SetCustomName =
{
Params =
{
{
Name = "CustomName",
Type = "string",
},
},
Notes = "Sets the custom name of the monster. You see the name over the monster. If you want to disable the custom name, simply set an empty string.",
},
SetCustomNameAlwaysVisible =
{
Params =
{
{
Name = "IsCustomNameAlwaysVisible",
Type = "boolean",
},
},
Notes = "Sets the custom name visiblity of this monster. If it's false, you only see the name when you sight the mob. If it's true, you always see the custom name.",
},
SetRelativeWalkSpeed =
{
Params =
{
{
Name = "RelativeWalkSpeed",
Type = "number",
},
},
Notes = "Sets the relative walk speed of this mob. The default relative speed is 1.0.",
},
StringToMobType =
{
IsStatic = true,
Params =
{
{
Name = "MobTypeString",
Type = "string",
},
},
Returns =
{
{
Name = "MobType",
Type = "eMonsterType",
},
},
Notes = "Returns the mob type ({{Globals#eMonsterType|mtXXX}} constant) parsed from the string type (\"creeper\"), or mtInvalidType if unrecognized.",
},
Unleash =
{
Params =
{
{
Name = "ShouldDropLeashPickup",
Type = "boolean",
},
},
Notes = "Unleash the monster.",
},
},
Constants =
{
mfAmbient =
{
Notes = "Family: ambient (bat)",
},
mfHostile =
{
Notes = "Family: hostile (blaze, cavespider, creeper, enderdragon, enderman, ghast, giant, magmacube, silverfish, skeleton, slime, spider, witch, wither, zombie, zombiepigman)",
},
mfPassive =
{
Notes = "Family: passive (chicken, cow, horse, irongolem, mooshroom, ocelot, pig, sheep, snowgolem, villager, wolf)",
},
mfWater =
{
Notes = "Family: water (squid)",
},
},
ConstantGroups =
{
eFamily =
{
Include = "mf.*",
TextBefore = [[
Mobs are divided into families. The following constants are used for individual family types:
]],
},
},
Inherits = "cPawn",
},
cObjective =
{
Desc = [[
This class represents a single scoreboard objective.
]],
Functions =
{
AddScore =
{
Params =
{
{
Name = "string",
Type = "string",
},
{
Name = "number",
Type = "number",
},
},
Returns =
{
{
Name = "Score",
Type = "
NOTE: Instead of comparing the value returned by this function to the gmXXX constants, use the IsGameModeXXX() functions. These functions handle the gamemode inheritance automatically.",
},
GetInventory =
{
Returns =
{
{
Name = "Inventory",
Type = "cInventory",
},
},
Notes = "Returns the player's inventory",
},
GetIP =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the IP address of the player, if available. Returns an empty string if there's no IP to report.",
},
GetLastBedPos =
{
Returns =
{
{
Type = "Vector3i",
},
},
Notes = "Returns the player's respawn position. The player is guaranteed to respawn from death here if {{cPlayer}}:IsRespawnPointForced is true or if a bed exists at this position.",
},
GetMaxSpeed =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the player's current maximum speed, relative to the game default speed. Takes into account the sprinting / flying status.",
},
GetName =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the player's name",
},
GetNormalMaxSpeed =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the player's maximum walking speed, relative to the game default speed. Defaults to 1, but plugins may modify it for faster or slower walking.",
},
GetPermissions =
{
Returns =
{
{
Type = "table",
},
},
Notes = "Returns an array-table of all permissions (strings) that the player has assigned to them through their rank.",
},
GetPlayerListName =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the name that is used in the playerlist.",
},
GetPrefix =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the prefix to player names for messages (based on their rank), may contain @ format codes.",
},
GetRestrictions =
{
Returns =
{
{
Type = "table",
},
},
Notes = "Returns an array-table of all the restrictions that the player has assigned to them.",
},
GetSprintingMaxSpeed =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the player's maximum sprinting speed, relative to the game default speed. Defaults to 1.3, but plugins may modify it for faster or slower sprinting.",
},
GetSkinParts =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the player's current set of skin part flags. This is a bitwise OR of various {{Globals#eSkinPart|eSkinPart}} constants. Note that HasSkinPart may be easier to use in most situations.",
},
GetStatistics =
{
Returns =
{
{
Type = "StatisticsManager",
},
},
Notes = "Returns the player's statistics manager."
},
GetSuffix =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the suffix to player names for messages (based on their rank), may contain @ format codes.",
},
GetTeam =
{
Returns =
{
{
Type = "cTeam",
},
},
Notes = "Returns the team that the player belongs to, or nil if none.",
},
GetThrowSpeed =
{
Params =
{
{
Name = "SpeedCoeff",
Type = "number",
},
},
Returns =
{
{
Type = "Vector3d",
},
},
Notes = "Returns the speed vector for an object thrown with the specified speed coeff. Basically returns the normalized look vector multiplied by the coeff, with a slight random variation.",
},
GetThrowStartPos =
{
Returns =
{
{
Type = "Vector3d",
},
},
Notes = "Returns the position where the projectiles should start when thrown by this player.",
},
GetUUID =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the (short) UUID that the player is using. Could be empty string for players that don't have a Mojang account assigned to them (in the future, bots for example).",
},
GetWindow =
{
Returns =
{
{
Type = "cWindow",
},
},
Notes = "Returns the currently open UI window. If the player doesn't have any UI window open, returns the inventory window.",
},
GetXpLevel =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the current XP level (based on current XP amount).",
},
GetXpLifetimeTotal =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the amount of XP that has been accumulated throughout the player's lifetime.",
},
GetXpPercentage =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the percentage of the experience bar - the amount of XP towards the next XP level. Between 0 and 1.",
},
HasCustomName =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player has a custom name.",
},
HasPermission =
{
Params =
{
{
Name = "PermissionString",
Type = "string",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player has the specified permission",
},
HasSkinPart =
{
Params =
{
{
Name = "Part",
Type = "eSkinPart",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player has the specified skin part enabled",
},
Heal =
{
Params =
{
{
Name = "HitPoints",
Type = "number",
},
},
Notes = "Heals the player by the specified amount of HPs. Only positive amounts are expected. Sends a health update to the client.",
},
IsEating =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player is currently eating the item in their hand.",
},
IsFireproof =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if a player is fireproof. This is when the flag has been explicitly set, or the player is in creative or spectator mode.",
},
IsFishing =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player is currently fishing",
},
IsFlying =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player is flying.",
},
IsFrozen =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player is frozen. See Freeze()",
},
IsGameModeAdventure =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player is in the gmAdventure gamemode, or has their gamemode unset and the world is a gmAdventure world.",
},
IsGameModeCreative =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player is in the gmCreative gamemode, or has their gamemode unset and the world is a gmCreative world.",
},
IsGameModeSpectator =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player is in the gmSpectator gamemode, or has their gamemode unset and the world is a gmSpectator world.",
},
IsGameModeSurvival =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player is in the gmSurvival gamemode, or has their gamemode unset and the world is a gmSurvival world.",
},
IsInBed =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player is currently lying in a bed.",
},
IsLeftHanded =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player's left hand is dominant.",
},
IsRespawnPointForced = {
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player unconditionally respawns from death at the position given by {{cPlayer}}:GetLastBedPos with no bed checks performed.",
},
IsSatiated =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the player is satiated (cannot eat).",
},
LoadRank =
{
Notes = "Reloads the player's rank, message visuals and permissions from the {{cRankManager}}, based on the player's current rank.",
},
OpenWindow =
{
Params =
{
{
Name = "Window",
Type = "cWindow",
},
},
Notes = "Opens the specified UI window for the player.",
},
PermissionMatches =
{
IsStatic = true,
Params =
{
{
Name = "Permission",
Type = "string",
},
{
Name = "Template",
Type = "string",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the specified permission matches the specified template. The template may contain asterisk as a wildcard for any word.",
},
PlaceBlock =
{
Params =
{
{
Name = "BlockPos",
Type = "Vector3i",
},
{
Name = "BlockType",
Type = "number",
},
{
Name = "BlockMeta",
Type = "number",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Places a block while impersonating the player. The {{OnPlayerPlacingBlock|HOOK_PLAYER_PLACING_BLOCK}} hook is called before the placement, and if it succeeds, the block is placed and the {{OnPlayerPlacedBlock|HOOK_PLAYER_PLACED_BLOCK}} hook is called. Returns true iff the block is successfully placed.",
},
ReplaceOneEquippedItemTossRest =
{
Params =
{
{
Name = "Item",
Type = "cItem",
},
},
Notes = "Removes one item from the the current equipped item stack, and attempts to add the specified item stack back to the same slot. If it is not possible to place the item in the same slot, tries to place the specified item elsewhere in the inventory. If this is not possible, then any remaining items are tossed. If the currently equipped slot is empty, its contents are simply set to the given Item.",
},
Respawn =
{
Notes = "Restores the health, extinguishes fire, makes visible and sends the Respawn packet.",
},
SendAboveActionBarMessage =
{
Params =
{
{
Name = "Message",
Type = "string",
},
},
Notes = "Sends the specified message to the player (shows above action bar).",
},
SendBlocksAround =
{
Params =
{
{
Name = "BlockX",
Type = "number",
},
{
Name = "BlockY",
Type = "number",
},
{
Name = "BlockZ",
Type = "number",
},
{
Name = "BlockRange",
Type = "number",
IsOptional = true,
},
},
Notes = "Sends all the world's blocks in BlockRange from the specified coords to the player, as a BlockChange packet. Range defaults to 1 (only one block sent).",
},
SendMessage =
{
{
Params =
{
{
Name = "Message",
Type = "string",
},
},
Notes = "Sends the specified message to the player.",
},
{
Params =
{
{
Name = "Message",
Type = "cCompositeChat",
},
},
Notes = "Sends the {{cCompositeChat}} to the player, using a severity defined by the CompositeChat's MessageType.",
},
},
SendMessageRaw =
{
Params =
{
{
Name = "Json",
Type = "string",
},
{
Name = "eChatType",
Type = "number",
IsOptional = true,
}
},
Notes = "Sends the specified json string to the player. The optional value eChatType (default ctChatBox) can be ctChatBox, ctSystem or ctAboveActionBar. You can use {{cJson}} to build a json string.",
},
SendMessageFailure =
{
Params =
{
{
Name = "Message",
Type = "string",
},
},
Notes = "Prepends Rose [INFO] / colours entire text (depending on ShouldUseChatPrefixes()) and sends message to player. For a command that failed to run because of insufficient permissions, etc.",
},
SendMessageFatal =
{
Params =
{
{
Name = "Message",
Type = "string",
},
},
Notes = "Prepends Red [FATAL] / colours entire text (depending on ShouldUseChatPrefixes()) and sends message to player. For something serious, such as a plugin crash, etc.",
},
SendMessageInfo =
{
Params =
{
{
Name = "Message",
Type = "string",
},
},
Notes = "Prepends Yellow [INFO] / colours entire text (depending on ShouldUseChatPrefixes()) and sends message to player. Informational message, such as command usage, etc.",
},
SendMessagePrivateMsg =
{
Params =
{
{
Name = "Message",
Type = "string",
},
{
Name = "SenderName",
Type = "string",
},
},
Notes = "Prepends Light Blue [MSG: *SenderName*] / prepends SenderName and colours entire text (depending on ShouldUseChatPrefixes()) and sends message to player. For private messaging.",
},
SendMessageSuccess =
{
Params =
{
{
Name = "Message",
Type = "string",
},
},
Notes = "Prepends Green [INFO] / colours entire text (depending on ShouldUseChatPrefixes()) and sends message to player. Success notification.",
},
SendMessageWarning =
{
Params =
{
{
Name = "Message",
Type = "string",
},
},
Notes = "Prepends Rose [WARN] / colours entire text (depending on ShouldUseChatPrefixes()) and sends message to player. Denotes that something concerning, such as plugin reload, is about to happen.",
},
SendRotation =
{
Params =
{
{
Name = "YawDegrees",
Type = "number",
},
{
Name = "PitchDegrees",
Type = "number",
},
},
Notes = "Sends the specified rotation to the player, forcing them to look that way",
},
SendSystemMessage =
{
Params =
{
{
Name = "Message",
Type = "string",
},
},
Notes = "Sends the specified message to the player.",
},
SetBedPos =
{
Params =
{
{
Name = "Position",
Type = "Vector3i",
},
{
Name = "World",
Type = "cWorld",
IsOptional = true,
},
},
Notes = "Sets the position and world of the player's bed. If the world is not specified, it is set to the player's current world. The player will respawn at this position and world upon death if there is a bed there.",
},
SetCanFly =
{
Params =
{
{
Name = "CanFly",
Type = "boolean",
},
},
Notes = "Sets if the player can fly or not.",
},
SetCrouch =
{
Params =
{
{
Name = "IsCrouched",
Type = "boolean",
},
},
Notes = "Sets the crouch state, broadcasts the change to other players.",
},
SetCurrentExperience =
{
Params =
{
{
Name = "XPAmount",
Type = "number",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Sets the current amount of experience (and indirectly, the XP level).",
},
SetCustomName =
{
Params =
{
{
Name = "CustomName",
Type = "string",
},
},
Notes = "Sets the custom name for this player. If you want to disable the custom name, simply set an empty string. The custom name will be used in the tab-list, in the player nametag and in the tab-completion.",
},
SetDraggingItem =
{
Params =
{
{
Name = "Item",
Type = "cItem",
},
},
Notes = "Sets the item that the player is dragging in a UI window. If no UI window is open, this function does nothing."
},
SetElytraFlight =
{
Params =
{
{
Name = "IsElytraFlying",
Type = "boolean",
},
},
Notes = "Sets whether the player is elytra flying or not.",
},
SetFlying =
{
Params =
{
{
Name = "IsFlying",
Type = "boolean",
},
},
Notes = "Sets if the player is flying or not.",
},
SetFlyingMaxSpeed =
{
Params =
{
{
Name = "FlyingMaxSpeed",
Type = "number",
},
},
Notes = "Sets the flying maximum speed, relative to the game default speed. The default value is 1. Sends the updated speed to the client.",
},
SetFoodExhaustionLevel =
{
Params =
{
{
Name = "ExhaustionLevel",
Type = "number",
},
},
Notes = "Sets the food exhaustion to the specified level.",
},
SetFoodLevel =
{
Params =
{
{
Name = "FoodLevel",
Type = "number",
},
},
Notes = "Sets the food level (number of half-drumsticks on-screen)",
},
SetFoodSaturationLevel =
{
Params =
{
{
Name = "FoodSaturationLevel",
Type = "number",
},
},
Notes = "Sets the food saturation (overcharge of the food level).",
},
SetFoodTickTimer =
{
Params =
{
{
Name = "FoodTickTimer",
Type = "number",
},
},
Notes = "Sets the number of ticks past the last food-based heal or damage action; when this timer reaches 80, a new heal / damage is applied.",
},
SetGameMode =
{
Params =
{
{
Name = "NewGameMode",
Type = "eGameMode",
},
},
Notes = "Sets the gamemode for the player. The new gamemode overrides the world's default gamemode, unless it is set to gmInherit.",
},
SetIsFishing =
{
Params =
{
{
Name = "IsFishing",
Type = "boolean",
},
{
Name = "FloaterEntityID",
Type = "number",
IsOptional = true,
},
},
Notes = "Sets the 'IsFishing' flag for the player. The floater entity ID is expected for the true variant, it can be omitted when IsFishing is false. FIXME: Undefined behavior when multiple fishing rods are used simultanously",
},
SetLeftHanded =
{
Params =
{
{
Name = "IsLeftHanded",
Type = "boolean",
},
},
Notes = "Sets the dominant hand of the player.",
},
SetName =
{
Params =
{
{
Name = "Name",
Type = "string",
},
},
Notes = "Sets the player name. This rename will NOT be visible to any players already in the server who are close enough to see this player.",
},
SetNormalMaxSpeed =
{
Params =
{
{
Name = "NormalMaxSpeed",
Type = "number",
},
},
Notes = "Sets the normal (walking) maximum speed, relative to the game default speed. The default value is 1. Sends the updated speed to the client, if appropriate.",
},
SetRespawnPosition =
{
Params =
{
{
Name = "Position",
Type = "Vector3i",
},
{
Name = "World",
Type = "cWorld",
},
},
Notes = "Sets the position and world of the player's respawn point. The player will respawn at this position and world upon death.",
},
SetSprint =
{
Params =
{
{
Name = "IsSprinting",
Type = "boolean",
},
},
Notes = "Sets whether the player is sprinting or not.",
},
SetSkinParts =
{
Params =
{
{
Name = "Parts",
Type = "number",
},
},
Notes = "Sets the skin part flags of the player. The value should be a bitwise OR of several {{Globals#eSkinPart|eSkinPart}} constants.",
},
SetSprintingMaxSpeed =
{
Params =
{
{
Name = "SprintingMaxSpeed",
Type = "number",
},
},
Notes = "Sets the sprinting maximum speed, relative to the game default speed. The default value is 1.3. Sends the updated speed to the client, if appropriate.",
},
SetTeam =
{
Params =
{
{
Name = "Team",
Type = "cTeam",
},
},
Notes = "Moves the player to the specified team.",
},
SetVisible =
{
Params =
{
{
Name = "IsVisible",
Type = "boolean",
},
},
Notes = "Sets the player visibility to other players",
},
SpectateEntity =
{
Params =
{
{
Name = "Target",
Type = "cEntity",
},
},
Notes = "Spectates the target entity. Does not change the player's gamemode to spectator mode. When called with self or nil as the target, resets the spectation.",
},
TossEquippedItem =
{
Params =
{
{
Name = "Amount",
Type = "number",
IsOptional = true,
},
},
Notes = "Tosses the item that the player has selected in their hotbar. Amount defaults to 1.",
},
TossHeldItem =
{
Params =
{
{
Name = "Amount",
Type = "number",
IsOptional = true,
},
},
Notes = "Tosses the item held by the cursor, when the player is in a UI window. Amount defaults to 1.",
},
TossPickup =
{
Params =
{
{
Name = "Item",
Type = "cItem",
},
},
Notes = "Tosses a pickup newly created from the specified item.",
},
Unfreeze =
{
Notes = "Allows the player to move again, canceling the effects of Freeze()",
},
XpForLevel =
{
IsStatic = true,
Params =
{
{
Name = "XPLevel",
Type = "number",
},
},
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the total amount of XP needed for the specified XP level. Inverse of CalcLevelFromXp().",
},
},
Constants =
{
MAX_FOOD_LEVEL =
{
Notes = "The maximum food level value. When the food level is at this value, the player cannot eat.",
},
MAX_HEALTH =
{
Notes = "The maximum health value",
},
},
Inherits = "cPawn",
}, -- cPlayer
cRoot =
{
Desc = [[
This class represents the root of Cuberite's object hierarchy. There is always only one cRoot
object. It manages and allows querying all the other objects, such as {{cServer}},
{{cPluginManager}}, individual {{cWorld|worlds}} etc.
To get the singleton instance of this object, you call the cRoot:Get() function. Then you can call the individual functions on this object. Note that some of the functions are static and don't need the instance, they are to be called directly on the cRoot class, such as cRoot:GetPhysicalRAMUsage() ]], Functions = { BroadcastChat = { { Params = { { Name = "MessageText", Type = "string", }, { Name = "MessageType", Type = "eMessageType", }, }, Notes = "Broadcasts a message to all players, with its message type set to MessageType (default: mtCustom).", }, { Params = { { Name = "CompositeChat", Type = "cCompositeChat", }, }, Notes = "Broadcasts a {{cCompositeChat|composite chat message}} to all players.", }, }, BroadcastChatDeath = { Params = { { Name = "MessageText", Type = "string", }, }, Notes = "Broadcasts the specified message to all players, with its message type set to mtDeath. Use for when a player has died.", }, BroadcastChatFailure = { Params = { { Name = "MessageText", Type = "string", }, }, Notes = "Broadcasts the specified message to all players, with its message type set to mtFailure. Use for a command that failed to run because of insufficient permissions, etc.", }, BroadcastChatFatal = { Params = { { Name = "MessageText", Type = "string", }, }, Notes = "Broadcasts the specified message to all players, with its message type set to mtFatal. Use for a plugin that crashed, or similar.", }, BroadcastChatInfo = { Params = { { Name = "MessageText", Type = "string", }, }, Notes = "Broadcasts the specified message to all players, with its message type set to mtInfo. Use for informational messages, such as command usage.", }, BroadcastChatJoin = { Params = { { Name = "MessageText", Type = "string", }, }, Notes = "Broadcasts the specified message to all players, with its message type set to mtJoin. Use for players joining the server.", }, BroadcastChatLeave = { Params = { { Name = "MessageText", Type = "string", }, }, Notes = "Broadcasts the specified message to all players, with its message type set to mtLeave. Use for players leaving the server.", }, BroadcastChatSuccess = { Params = { { Name = "MessageText", Type = "string", }, }, Notes = "Broadcasts the specified message to all players, with its message type set to mtSuccess. Use for success messages.", }, BroadcastChatWarning = { Params = { { Name = "MessageText", Type = "string", }, }, Notes = "Broadcasts the specified message to all players, with its message type set to mtWarning. Use for concerning events, such as plugin reload etc.", }, BroadcastPlayerListsHeaderFooter = { Params = { { Type = "cCompositeChat", Name = "Header", }, { Type = "cCompositeChat", Name = "Footer", }, }, Desc = "Broadcasts the header and footer of the player list to all players.", }, DoWithPlayerByUUID = { Params = { { Name = "PlayerUUID", Type = "cUUID", }, { Name = "CallbackFunction", Type = "function", }, }, Returns = { { Type = "boolean", }, }, Notes = "If there is the player with the uuid, calls the CallbackFunction with the {{cPlayer}} parameter representing the player. The CallbackFunction has the following signature:
function Callback({{cPlayer|Player}}) The function returns false if the player was not found, or whatever bool value the callback returned if the player was found.",
},
FindAndDoWithPlayer =
{
Params =
{
{
Name = "PlayerName",
Type = "string",
},
{
Name = "CallbackFunction",
Type = "function",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Calls the given callback function for the player with the name best matching the name string provided.function Callback({{cPlayer|Player}})",
},
ForEachPlayer =
{
Params =
{
{
Name = "CallbackFunction",
Type = "function",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Calls the given callback function for each player. The callback function has the following signature: function Callback({{cPlayer|cPlayer}})",
},
ForEachWorld =
{
Params =
{
{
Name = "CallbackFunction",
Type = "function",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Calls the given callback function for each world. The callback function has the following signature: function Callback({{cWorld|cWorld}}). Returns false if a callback aborts, otherwise true.",
},
Get =
{
IsStatic = true,
Returns =
{
{
Type = "cRoot",
},
},
Notes = "Returns the one and only cRoot object.",
},
GetBrewingRecipe =
{
IsStatic = true,
Params =
{
{
Name = "Bottle",
Type = "cItem",
},
{
Name = "Ingredient",
Type = "cItem",
},
},
Returns =
{
{
Type = "cItem",
},
},
Notes = "Returns the result item, if a recipe has been found to brew the Ingredient into Bottle. If no recipe is found, returns no value.",
},
GetBuildCommitID =
{
IsStatic = true,
Returns =
{
{
Type = "string",
},
},
Notes = "For official builds (Travis CI / Jenkins) it returns the exact commit hash used for the build. For unofficial local builds, returns the approximate commit hash (since the true one cannot be determined), formatted as \"approx: <CommitHash>\".",
},
GetBuildDateTime =
{
IsStatic = true,
Returns =
{
{
Type = "string",
},
},
Notes = "For official builds (Travic CI / Jenkins) it returns the date and time of the build. For unofficial local builds, returns the approximate datetime of the commit (since the true one cannot be determined), formatted as \"approx: <DateTime-iso8601>\".",
},
GetBuildID =
{
IsStatic = true,
Returns =
{
{
Type = "string",
},
},
Notes = "For official builds (Travis CI / Jenkins) it returns the unique ID of the build, as recognized by the build system. For unofficial local builds, returns the string \"Unknown\".",
},
GetBuildSeriesName =
{
IsStatic = true,
Returns =
{
{
Type = "string",
},
},
Notes = "For official builds (Travis CI / Jenkins) it returns the series name of the build (for example \"Cuberite Windows x64 Master\"). For unofficial local builds, returns the string \"local build\".",
},
GetCraftingRecipes =
{
Returns =
{
{
Type = "cCraftingRecipe",
},
},
Notes = "Returns the CraftingRecipes object",
},
GetDefaultWorld =
{
Returns =
{
{
Type = "cWorld",
},
},
Notes = "Returns the world object from the default world.",
},
GetFurnaceFuelBurnTime =
{
IsStatic = true,
Params =
{
{
Name = "Fuel",
Type = "cItem",
},
},
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the number of ticks for how long the item would fuel a furnace. Returns zero if not a fuel.",
},
GetFurnaceRecipe =
{
IsStatic = true,
Params =
{
{
Name = "InItem",
Type = "cItem",
},
},
Returns =
{
{
Name = "OutItem",
Type = "cItem",
},
{
Name = "NumTicks",
Type = "number",
},
{
Name = "InItem",
Type = "cItem",
},
},
Notes = "Returns the furnace recipe for smelting the specified input. If a recipe is found, returns the smelted result, the number of ticks required for the smelting operation, and the input consumed (note that Cuberite supports smelting M items into N items and different smelting rates). If no recipe is found, returns no value.",
},
GetPhysicalRAMUsage =
{
IsStatic = true,
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the amount of physical RAM that the entire Cuberite process is using, in KiB. Negative if the OS doesn't support this query.",
},
GetPluginManager =
{
Returns =
{
{
Type = "cPluginManager",
},
},
Notes = "Returns the cPluginManager object.",
},
GetProtocolVersionTextFromInt =
{
IsStatic = true,
Params =
{
{
Name = "ProtocolVersionNumber",
Type = "number",
},
},
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the Minecraft client version from the given Protocol version number. If there is no version found, it returns 'Unknown protocol (Number)'",
},
GetServer =
{
Returns =
{
{
Type = "cServer",
},
},
Notes = "Returns the cServer object.",
},
GetServerUpTime =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the uptime of the server in seconds.",
},
GetTotalChunkCount =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the amount of loaded chunks.",
},
GetVirtualRAMUsage =
{
IsStatic = true,
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the amount of virtual RAM that the entire Cuberite process is using, in KiB. Negative if the OS doesn't support this query.",
},
GetWebAdmin =
{
Returns =
{
{
Type = "cWebAdmin",
},
},
Notes = "Returns the cWebAdmin object.",
},
GetWorld =
{
Params =
{
{
Name = "WorldName",
Type = "string",
},
},
Returns =
{
{
Type = "cWorld",
},
},
Notes = "Returns the cWorld object of the given world. It returns nil if there is no world with the given name.",
},
QueueExecuteConsoleCommand =
{
Params =
{
{
Name = "Message",
Type = "string",
},
},
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.",
},
SaveAllChunks =
{
Notes = "Saves all the chunks in all the worlds. Note that the saving is queued on each world's tick thread and this functions returns before the chunks are actually saved.",
},
SetSavingEnabled =
{
Params =
{
{
Name = "SavingEnabled",
Type = "boolean",
},
},
Notes = "Sets whether saving chunk data is enabled for all worlds. If disabled, dirty chunks will stay in memory forever, which can cause performance and stability issues.",
},
},
AdditionalInfo =
{
{
Header = "Querying a furnace recipe",
Contents = [[
To find the furnace recipe for an item, use the following code (adapted from the Debuggers plugin's /fr command):
local HeldItem = a_Player:GetEquippedItem();
local Out, NumTicks, In = cRoot:GetFurnaceRecipe(HeldItem); -- Note STATIC call - no need for a Get()
if (Out ~= nil) then
-- There is a recipe, list it:
a_Player:SendMessage(
"Furnace turns " .. ItemToFullString(In) ..
" to " .. ItemToFullString(Out) ..
" in " .. NumTicks .. " ticks (" ..
tostring(NumTicks / 20) .. " seconds)."
);
else
-- No recipe found
a_Player:SendMessage("There is no furnace recipe that would smelt " .. ItemToString(HeldItem));
end
]],
},
},
},
cScoreboard =
{
Desc = [[
This class manages the objectives and teams of a single world.
]],
Functions =
{
AddPlayerScore =
{
Params =
{
{
Name = "Name",
Type = "string",
},
{
Name = "Type",
Type = "function Callback({{cObjective|Objective}}) The callback should return false or no value to continue with the next objective, or true to abort the enumeration.",
},
ForEachTeam =
{
Params =
{
{
Name = "CallbackFunction",
Type = "function",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Calls the specified callback for each team in the scoreboard. Returns true if all teams have been processed (including when there are zero teams), or false if the callback function has aborted the enumeration by returning true. The callback function has the following signature: function Callback({{cObjective|Objective}}) The callback should return false or no value to continue with the next team, or true to abort the enumeration.",
},
GetNumObjectives =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the nuber of registered objectives.",
},
GetNumTeams =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the number of registered teams.",
},
GetObjective =
{
Params =
{
{
Name = "string",
Type = "string",
},
},
Returns =
{
{
Type = "cObjective",
},
},
Notes = "Returns the objective with the specified name.",
},
GetObjectiveIn =
{
Params =
{
{
Name = "DisplaySlot",
Type = "It used to support broadcasting chat messages to all players, this functionality has been moved to {{cRoot}}:BroadcastChat(). ]], Functions = { DoesAllowMultiLogin = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if players can log in multiple times from the same account (normally used for debugging), false if only one player per name is allowed.", }, GetDescription = { Returns = { { Type = "string", }, }, Notes = "Returns the server description set in the settings.ini.", }, GetShutdownMessage = { Returns = { { Type = "string", }, }, Notes = "Returns the shutdown message set in the settings.ini.", }, GetMaxPlayers = { Returns = { { Type = "number", }, }, Notes = "Returns the max amount of players who can join the server.", }, GetNumPlayers = { Returns = { { Type = "number", }, }, Notes = "Returns the amount of players online.", }, GetServerID = { Returns = { { Type = "string", }, }, Notes = "Returns the ID of the server?", }, IsHardcore = { Returns = { { Type = "boolean", }, }, Notes = "Returns true if the server is hardcore (players get banned on death).", }, IsPlayerInQueue = { Params = { { Name = "Username", Type = "string", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the specified player is queued to be transferred to a World.", }, RegisterForgeMod = { Params = { { Name = "ModName", Type = "string", }, { Name = "ModVersion", Type = "string", }, { Name = "ProtocolVersionNumber", Type = "number", }, }, Notes = "Add a Forge mod name/version to the server ping list.", }, ScheduleTask = { Params = { { Name = "DelayTicks", Type = "number", }, { Name = "TaskFunction", Type = "function", }, }, Notes = "Queues the specified function to be executed in the server's tick thread after a the specified number of ticks. This enables operations to be queued for execution in the future. The function signature is
function({{cServer|Server}})All return values from the function are ignored. Note that it is unsafe to store references to Cuberite objects, such as entities, across from the caller to the task handler function; store the EntityID instead.",
},
SetMaxPlayers =
{
Params =
{
{
Name = "MaxPlayers",
Type = "number",
},
},
Notes = "Sets the max amount of players who can join.",
},
ShouldAuthenticate =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true iff the server is set to authenticate players (\"online mode\").",
},
UnregisterForgeMod =
{
Params =
{
{
Name = "ModName",
Type = "string",
},
{
Name = "ProtocolVersionNumber",
Type = "number",
},
},
Notes = "Remove a Forge mod name/version from the server ping list.",
},
},
},
cStringCompression =
{
Desc = [[
Provides functions to compress or decompress string
All functions in this class are static, so they should be called in the dot convention:
local CompressedString = cStringCompression.CompressStringGZIP("DataToCompress")
]],
Functions =
{
CompressStringGZIP =
{
IsStatic = true,
Params =
{
{
Name = "Data",
Type = "string",
},
},
Returns =
{
{
Type = "string",
},
},
Notes = "Compresses data in a string using GZIP",
},
CompressStringZLIB =
{
IsStatic = true,
Params =
{
{
Name = "Data",
Type = "string",
},
{
Name = "factor",
Type = "number",
},
},
Returns =
{
{
Type = "string",
},
},
Notes = "Compresses data in a string using ZLIB. Factor 0 is no compression and factor 9 is maximum compression.",
},
InflateString =
{
IsStatic = true,
Params =
{
{
Name = "Data",
Type = "string",
},
},
Returns =
{
{
Type = "string",
},
},
Notes = "Uncompresses a string using Inflate",
},
UncompressStringGZIP =
{
IsStatic = true,
Params =
{
{
Name = "Data",
Type = "string",
},
},
Returns =
{
{
Type = "string",
},
},
Notes = "Uncompress a string using GZIP",
},
UncompressStringZLIB =
{
IsStatic = true,
Params =
{
{
Name = "Data",
Type = "string",
},
{
Name = "UncompressedLength",
Type = "number",
},
},
Returns =
{
{
Type = "string",
},
},
Notes = "Uncompresses Data using ZLIB",
},
},
},
cTeam =
{
Desc = [[
This class manages a single player team.
]],
Functions =
{
AddPlayer =
{
Params =
{
{
Name = "PlayerName",
Type = "string",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Adds a player to this team. Returns true if the operation was successful.",
},
AllowsFriendlyFire =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns whether team friendly fire is allowed.",
},
CanSeeFriendlyInvisible =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns whether players can see invisible teammates.",
},
GetDisplayName =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the display name of the team.",
},
GetName =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the internal name of the team.",
},
GetNumPlayers =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the number of registered players.",
},
GetPrefix =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the prefix prepended to the names of the members of this team.",
},
GetSuffix =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Returns the suffix appended to the names of the members of this team.",
},
HasPlayer =
{
Params =
{
{
Name = "PlayerName",
Type = "string",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns whether the specified player is a member of this team.",
},
RemovePlayer =
{
Params =
{
{
Name = "PlayerName",
Type = "string",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Removes the player with the specified name from this team. Returns true if the operation was successful.",
},
Reset =
{
Notes = "Removes all players from this team.",
},
SetCanSeeFriendlyInvisible =
{
Params =
{
{
Name = "CanSeeFriendlyInvisible",
Type = "boolean",
},
},
Notes = "Set whether players can see invisible teammates.",
},
SetDisplayName =
{
Params =
{
{
Name = "DisplayName",
Type = "string",
},
},
Notes = "Sets the display name of this team. (i.e. what will be shown to the players)",
},
SetFriendlyFire =
{
Params =
{
{
Name = "AllowFriendlyFire",
Type = "boolean",
},
},
Notes = "Sets whether team friendly fire is allowed.",
},
SetPrefix =
{
Params =
{
{
Name = "Prefix",
Type = "string",
},
},
Notes = "Sets the prefix prepended to the names of the members of this team.",
},
SetSuffix =
{
Params =
{
{
Name = "Suffix",
Type = "string",
},
},
Notes = "Sets the suffix appended to the names of the members of this team.",
},
},
},
cTNTEntity =
{
Desc = "This class manages a TNT entity.",
Functions =
{
Explode =
{
Notes = "Explode the tnt.",
},
GetFuseTicks =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the fuse ticks - the number of game ticks until the tnt explodes.",
},
SetFuseTicks =
{
Params =
{
{
Name = "TicksUntilExplosion",
Type = "number",
},
},
Notes = "Set the fuse ticks until the tnt will explode.",
},
},
Inherits = "cEntity",
},
cUrlParser =
{
Desc = [[
Provides a parser for generic URLs that returns the individual components of the URL.
Note that all functions are static. Call them by using "cUrlParser:Parse(...)" etc. ]], Functions = { GetDefaultPort = { IsStatic = true, Params = { { Name = "Scheme", Type = "string", }, }, Returns = { { Type = "number", }, }, Notes = "Returns the default port that should be used for the given scheme (protocol). Returns zero if the scheme is not known.", }, IsKnownScheme = { IsStatic = true, Params = { { Name = "Scheme", Type = "string", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the scheme (protocol) is recognized by the parser.", }, Parse = { IsStatic = true, Params = { { Name = "URL", Type = "string", }, }, Returns = { { Name = "Scheme", Type = "string", }, { Name = "Username", Type = "string", }, { Name = "Password", Type = "string", }, { Name = "Host", Type = "string", }, { Name = "Port", Type = "number", }, { Name = "Path", Type = "string", }, { Name = "Query", Type = "string", }, { Name = "Fragment", Type = "string", }, }, Notes = "Returns the individual parts of the URL. Parts that are not explicitly specified in the URL are empty, the default port for the scheme is used. If parsing fails, the function returns nil and an error message.", }, ParseAuthorityPart = { IsStatic = true, Params = { { Name = "AuthPart", Type = "string", }, }, Returns = { { Name = "Username", Type = "string", }, { Name = "Password", Type = "string", }, { Name = "Host", Type = "string", }, { Name = "Port", Type = "number", }, }, Notes = "Parses the Authority part of the URL. Parts that are not explicitly specified in the AuthPart are returned empty, the port is returned zero. If parsing fails, the function returns nil and an error message.", }, UrlDecode = { IsStatic = true, Params = { { Name = "Text", Type = "string", }, }, Returns = { { Name = "Decoded", Type = "string", }, }, Notes = "Returns the Text, URL-decoded. Returns nil if there is a problem while decoding (invalid input).", }, UrlEncode = { IsStatic = true, Params = { { Name = "Text", Type = "string", }, }, Returns = { { Name = "Encoded", Type = "string", }, }, Notes = "Returns the Text, URL-encoded.", }, }, AdditionalInfo = { { Header = "Code example", Contents = [[ The following code fragment uses the cUrlParser to parse an URL string into its components, and prints those components out:
local Scheme, Username, Password, Host, Port, Path, Query, Fragment = cUrlParser:Parse(
"http://anonymous:user@example.com@ftp.cuberite.org:9921/releases/2015/?sort=date#files"
)
if not(Scheme) then
-- Parsing failed, the second returned value (in Username) is the error message:
LOG(" Error: " .. (Username or ""))
else
LOG(" Scheme = " .. Scheme) -- "http"
LOG(" Username = " .. Username) -- "anonymous"
LOG(" Password = " .. Password) -- "user@example.com"
LOG(" Host = " .. Host) -- "ftp.cuberite.org"
LOG(" Port = " .. Port) -- 9921
LOG(" Path = " .. Path) -- "releases/2015/"
LOG(" Query = " .. Query) -- "sort=date"
LOG(" Fragment = " .. Fragment) -- "files"
end
]],
},
},
},
cUUID =
{
Desc = [[
Class representing a Universally Unique Identifier.
Note that all Cuberite's API functions that take a cUUID parameter will also
accept a string in its place, as long as that string can be converted to a cUUID
(using the {{#FromString_1|cUUID:FromString}} function).
]],
Functions =
{
constructor =
{
Returns =
{
{
Type = "cUUID",
},
},
Notes = "Constructs a nil-valued UUID (all zeros)",
},
Compare =
{
Params =
{
{
Name = "Other",
Type = "cUUID",
},
},
Returns =
{
{
Type = "number",
},
},
Notes = [[
Compares this UUID with the specified Other UUID, Returns:
0 when equal to Other,
< 0 when less than Other,
> 0 when greater than Other
]],
},
IsNil =
{
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if this contains the \"nil\" UUID with all bits set to 0",
},
FromString =
{
Params =
{
{
Name = "StringUUID",
Type = "string",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Tries to interpret the string as a short or long form UUID and assign from it. On error, returns false and does not set the value.",
},
ToShortString =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Converts the UUID to a short form string (i.e without dashes).",
},
ToLongString =
{
Returns =
{
{
Type = "string",
},
},
Notes = "Converts the UUID to a long form string (i.e with dashes).",
},
Version =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the version number of the UUID.",
},
Variant =
{
Returns =
{
{
Type = "number",
},
},
Notes = "Returns the variant number of the UUID",
},
GenerateVersion3 =
{
IsStatic = true,
Params =
{
{
Name = "Name",
Type = "string",
},
},
Returns =
{
{
Type = "cUUID",
},
},
Notes = "Generates a version 3, variant 1 UUID based on the md5 hash of Name."
},
},
},
cWebPlugin =
{
Desc = "",
Functions =
{
},
},
cWindow =
{
Desc = [[
This class is the common ancestor for all window classes used by Cuberite. It is inherited by the
{{cLuaWindow|cLuaWindow}} class that plugins use for opening custom windows. It is planned to be
used for window-related hooks in the future. It implements the basic functionality of any
window.
Note that one cWindow object can be used for multiple players at the same time, and therefore the slot contents are player-specific (e. g. crafting grid, or player inventory). Thus the GetSlot() and SetSlot() functions need to have the {{cPlayer|cPlayer}} parameter that specifies the player for whom the contents are to be queried.
Windows also have numeric properties, these are used to set the progressbars for furnaces or the XP costs for enchantment tables. ]], Functions = { GetSlot = { Params = { { Name = "Player", Type = "cPlayer", }, { Name = "SlotNumber", Type = "number", }, }, Returns = { { Type = "cItem", }, }, Notes = "Returns the item at the specified slot for the specified player. Returns nil and logs to server console on error.", }, GetWindowID = { Returns = { { Type = "number", }, }, Notes = "Returns the ID of the window, as used by the network protocol", }, GetWindowTitle = { Returns = { { Type = "string", }, }, Notes = "Returns the window title that will be displayed to the player", }, GetWindowType = { Returns = { { Type = "number", }, }, Notes = "Returns the type of the window, one of the constants in the table above", }, GetWindowTypeName = { Returns = { { Type = "string", }, }, Notes = "Returns the textual representation of the window's type, such as \"minecraft:chest\".", }, IsSlotInPlayerHotbar = { Params = { { Name = "SlotNum", Type = "number", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the specified slot number is in the player hotbar", }, IsSlotInPlayerInventory = { Params = { { Name = "SlotNum", Type = "number", }, }, Returns = { { Type = "boolean", }, }, 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 = { { Name = "SlotNum", Type = "number", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the specified slot number is in the player's main inventory", }, SetProperty = { Params = { { Name = "PropertyID", Type = "number", }, { Name = "PropertyValue", Type = "number", }, { Name = "Player", Type = "cPlayer", IsOptional = true, }, }, Notes = "Updates a numerical property associated with the window. Typically used for furnace progressbars. Sends the UpdateWindowProperty packet to the specified Player, or to all current clients of the window if Player is not specified.", }, SetSlot = { Params = { { Name = "Player", Type = "cPlayer", }, { Name = "SlotNum", Type = "number", }, { Name = "cItem", Type = "cItem", }, }, Notes = "Sets the contents of the specified slot for the specified player. Ignored if the slot number is invalid", }, SetWindowTitle = { Params = { { Name = "WindowTitle", Type = "string", }, }, Notes = "Sets the window title that will be displayed to the player", }, }, Constants = { wtAnimalChest = { Notes = "A horse or donkey window", }, wtAnvil = { Notes = "An anvil window", }, wtBeacon = { Notes = "A beacon window", }, wtBrewery = { Notes = "A brewing stand window", }, wtChest = { Notes = "A {{cChestEntity|chest}} or doublechest window", }, wtDropSpenser = { Notes = "A {{cDropperEntity|dropper}} or a {{cDispenserEntity|dispenser}} window", }, wtEnchantment = { Notes = "An enchantment table window", }, wtFurnace = { Notes = "A {{cFurnaceEntity|furnace}} window", }, wtHopper = { Notes = "A {{cHopperEntity|hopper}} window", }, wtInventory = { Notes = "An inventory window", }, wtNPCTrade = { Notes = "A villager trade window", }, wtWorkbench = { Notes = "A workbench (crafting table) window", }, }, -- Constants ConstantGroups = { WindowType = { Include = { "wt.*" }, } }, -- ConstantGroups }, StatisticsManager = { Desc = [[ This class provides a store for various types of player statistics. The store will be read and sent to the client when the Statistics button is pressed. ]], Variables = { Custom = { Type = "Map of {{CustomStatistic}} to number", Notes = "Gets or sets the value of a custom statistic.", }, }, AdditionalInfo = { { Header = "Example usage", Contents = [[ Each store is a table, keyed by the statistic that the entry tracks, with value typically representing the number of times the event happened:
function ModifyPlayerFurnaceInteractions(Player) local Statistics = Player:GetStatistics() if (Statistics.Custom[CustomStatistic.WalkOneCm] > 10) then Statistics.Custom[CustomStatistic.InteractWithFurnace] = 1337 end -- Next time the player presses Statistics they will see the updated value for furnace interactions. end]], }, }, }, BannerPattern = { Desc = [[ An enumeration of banner patterns. ]], Constants = { BottomStripe = { Notes = "A base pattern." }, TopStripe = { Notes = "A chief pattern." }, LeftStripe = { Notes = "A pale dexter pattern." }, RightStripe = { Notes = "A pale sinister pattern." }, CenterStripeVertical = { Notes = "A pale pattern." }, MiddleStripeHorizontal = { Notes = "A fess pattern." }, DownRightStripe = { Notes = "A bend pattern." }, DownLeftStripe = { Notes = "A bend sinister pattern." }, SmallVerticalStripes = { Notes = "A paly pattern." }, DiagonalCross = { Notes = "A saltire pattern." }, SquareCross = { Notes = "A cross pattern." }, LeftOfDiagonal = { Notes = "A per bend sinister pattern." }, RightOfUpsideDownDiagonal = { Notes = "A per bend pattern." }, LeftOfUpsideDownDiagonal = { Notes = "A per bend inverted pattern." }, RightOfDiagonal = { Notes = "A per bend sinister inverted pattern." }, VerticalHalfLeft = { Notes = "A per pale pattern." }, VerticalHalfRight = { Notes = "A per pale inverted pattern." }, HorizontalHalfTop = { Notes = "A per fess pattern." }, HorizontalHalfBottom = { Notes = "A per fess inverted pattern." }, BottomLeftCorner = { Notes = "A base dexter canton pattern." }, BottomRightCorner = { Notes = "A base sinister canton pattern." }, TopLeftCorner = { Notes = "A chief dexter canton pattern." }, TopRightCorner = { Notes = "A chief sinister canton pattern." }, BottomTriangle = { Notes = "A chevron pattern." }, TopTriangle = { Notes = "An inverted chevron pattern." }, BottomTriangleSawtooth = { Notes = "A base indented pattern." }, TopTriangleSawtooth = { Notes = "A chief indented pattern." }, MiddleCircle = { Notes = "A roundel pattern." }, MiddleRhombus = { Notes = "A lozenge pattern." }, Border = { Notes = "A bordure pattern." }, CurlyBorder = { Notes = "A bordure indented pattern." }, Brick = { Notes = "A field masoned pattern." }, Gradient = { Notes = "A gradient pattern." }, GradientUpsideDown = { Notes = "A base gradient pattern." }, Creeper = { Notes = "A creeper charge pattern." }, Skull = { Notes = "A skull charge pattern." }, Flower = { Notes = "A flower charge pattern." }, Mojang = { Notes = "A... thing." }, Globe = { Notes = "A globe." }, Piglin = { Notes = "A snoot." }, }, }, BossBarColor = { Desc = [[ An enumeration of boss bar display colours which can be used with {{cClientHandle#SendBossBarAdd|SendBossBarAdd}}. ]], Constants = { Pink = { Notes = "A pink boss bar." }, Blue = { Notes = "A blue boss bar." }, Red = { Notes = "A red boss bar." }, Green = { Notes = "A green boss bar." }, Yellow = { Notes = "A yellow boss bar." }, Purple = { Notes = "A purple boss bar." }, White = { Notes = "A white boss bar." }, }, }, BossBarDivisionType = { Desc = [[ An enumeration of boss bar division types which can be used with {{cClientHandle#SendBossBarAdd|SendBossBarAdd}}. These constants control the number of notches the bar itself renders with. ]], Constants = { None = { Notes = "A completely smooth boss bar." }, SixNotches = { Notes = "A six-notch'd boss bar." }, TenNotches = { Notes = "A ten-notch'd boss bar." }, TwelveNotches = { Notes = "A twelve notch'd boss bar." }, TwentyNotches = { Notes = "A twenty notch'd boss bar." }, }, }, EffectID = { Desc = [[ An enumeration of sound and particle effects which can be used with {{cWorld#BroadcastSoundParticleEffect|BroadcastSoundParticleEffect}}. ]], Constants = { SFX_RANDOM_DISPENSER_DISPENSE = { Notes = "Sound of droper/dispenser releasing an item", }, SFX_RANDOM_DISPENSER_DISPENSE_FAIL = { Notes = "Sound of a droper/dispenser activated without items", }, SFX_RANDOM_DISPENSER_SHOOT = { Notes = "Sound of a dispenser shooting", }, SFX_RANDOM_ENDER_EYE_LAUNCH = { Notes = "Sound of an ender eye launch" }, SFX_RANDOM_FIREWORK_SHOT = { Notes = "Sound of a firework shot", }, SFX_RANDOM_IRON_DOOR_OPEN = { Notes = "Sound of an iron door opening", }, SFX_RANDOM_WOODEN_DOOR_OPEN = { Notes = "Sound of a wooden door opening" }, SFX_RANDOM_WOODEN_TRAPDOOR_OPEN = { Notes = "Sound of a wooden trapdoor opening" }, SFX_RANDOM_FENCE_GATE_OPEN = { Notes = "Sound of a fence gate opening", }, SFX_RANDOM_FIRE_EXTINGUISH = { Notes = "Sound of a fire extinguishing", }, SFX_RANDOM_PLAY_MUSIC_DISC = { Notes = "Starts playing a music disc. Needs an accompanting music disc ID", }, SFX_RANDOM_IRON_DOOR_CLOSE = { Notes = "Sound of an iron door closing", }, SFX_RANDOM_WOODEN_DOOR_CLOSE = { Notes = "Sound of a wooden door closing", }, SFX_RANDOM_WOODEN_TRAPDOOR_CLOSE = { Notes = "Sound of a trapdoor closing", }, SFX_RANDOM_FENCE_GATE_CLOSE = { Notes = "Sound of a fence gate closing", }, SFX_MOB_GHAST_WARN = { Notes = "Sound of a ghast warning cry", }, SFX_MOB_GHAST_SHOOT = { Notes = "Sound of a ghast shooting", }, SFX_MOB_ENDERDRAGON_SHOOT = { Notes = "Sound of the enderdragon shooting", }, SFX_MOB_BLAZE_SHOOT = { Notes = "Sound of a blaze shooting", }, SFX_MOB_ZOMBIE_WOOD = { Notes = "Sound of a zombie attacking a wooden door", }, SFX_MOB_ZOMBIE_METAL = { Notes = "Sound of a zombie attacking a metal door", }, SFX_MOB_ZOMBIE_WOOD_BREAK = { Notes = "Sound of a zombie breaking a wooden door", }, SFX_MOB_WITHER_BREAK_BLOCK = { Notes = "Sound of a wither breaking blocks", }, SFX_MOB_WITHER_SPAWN = { Notes = "Sound of a wither spawning", }, SFX_MOB_WITHER_SHOOT = { Notes = "Sound of a wither shooting", }, SFX_MOB_BAT_TAKEOFF = { Notes = "Sound of a bat taking off", }, SFX_MOB_ZOMBIE_INFECT = { Notes = "Sound of a zombie infecting a villager", }, SFX_MOB_ZOMBIE_UNFECT = { Notes = "Sound of a zombie villager converting to villager", }, SFX_MOB_ENDERDRAGON_DEATH = { Notes = "Sound of the dragon releasing dragon breath", }, SFX_RANDOM_ANVIL_BREAK = { Notes = "Sound of an anvil breaking", }, SFX_RANDOM_ANVIL_USE = { Notes = "Sound of using an anvil", }, SFX_RANDOM_ANVIL_LAND = { Notes = "Sound of a falling anvil landing", }, SFX_RANDOM_PORTAL_TRAVEL = { Notes = "Sound of travelling through a portal", }, SFX_RANDOM_CHORUS_FLOWER_GROW = { Notes = "Sound of a growing chorus flower", }, SFX_RANDOM_CHORUS_FLOWER_DEATH = { Notes = "Sound of a dieing chorus flower", }, SFX_RANDOM_BREWING_STAND_BREW = { Notes = "Sound of an active brewing stand", }, SFX_RANDOM_IRON_TRAPDOOR_OPEN = { Notes = "Sound of an iron trapdoor opening", }, SFX_RANDOM_IRON_TRAPDOOR_CLOSE = { Notes = "Sound of an iron trapdoor closing", }, PARTICLE_SMOKE = { Notes = "Spawns 10 smoke particles, e.g. from a fire. Needs a {{SmokeDirection|SmokeDirection}}", }, PARTICLE_BLOCK_BREAK = { Notes = "Block break particle and sound. Needs a BlockID", }, PARTICLE_SPLASH_POTION = { Notes = "Splash potion particles and glass break sound. Needs a PotionID", }, PARTICLE_EYE_OF_ENDER = { Notes = "Eye of ender entity break particles and sound", }, PARTICLE_MOBSPAWN = { Notes = "Mob spawn particle effect: smoke and flames", }, PARTICLE_HAPPY_VILLAGER = { Notes = "Happy villager/bonemeal particles. Number of particles may be given or 0 for default of 15", }, PARTICLE_DRAGON_BREATH = { Notes = "Dragon breath particle effect", }, PARTICLE_END_GATEWAY_SPAWN = { Notes = "End gateway spawn particle effect", }, PARTICLE_ENDERDRAGON_GROWL = { Notes = "Ender dragon growl particle effect", }, }, }, SmokeDirection = { Desc = [[ An enumeration of the direction spawned smoke will drift in as it floats up. ]], Constants = { SOUTH_EAST = { Notes = "Smoke drifts south-east", }, SOUTH = { Notes = "Smoke drifts south", }, SOUTH_WEST = { Notes = "Smoke drifts south-west", }, EAST = { Notes = "Smoke drifts east", }, CENTRE = { Notes = "Smoke does not drift", }, WEST = { Notes = "Smoke drifts west", }, NORTH_EAST = { Notes = "Smoke drifts north-east", }, NORTH = { Notes = "Smoke drifts north", }, NORTH_WEST = { Notes = "Smoke drifts west", }, } }, CustomStatistic = { Desc = [[ An enumeration of statistics of the custom type to be used with the {{StatisticsManager#Custom|Custom}} statistics store. ]], Constants = { AnimalsBred = { Notes = "The number of times the player bred two mobs.", }, AviateOneCm = { Notes = "The total distance travelled by elytra.", }, BellRing = { Notes = "The number of times the player has rung a bell.", }, BoatOneCm = { Notes = "The total distance travelled by boats.", }, CleanArmor = { Notes = "The number of dyed leather armors washed with a cauldron.", }, CleanBanner = { Notes = "The number of banner patterns washed with a cauldron.", }, CleanShulkerBox = { Notes = "The number of times the player has washed a Shulker Box with a cauldron.", }, ClimbOneCm = { Notes = "The total distance travelled up ladders or vines.", }, CrouchOneCm = { Notes = "The total distance walked while sneaking.", }, DamageAbsorbed = { Notes = "The amount of damage the player has absorbed in tenths of 1.", }, DamageBlockedByShield = { Notes = "The amount of damage the player has blocked with a shield in tenths of 1.", }, DamageDealt = { Notes = "The amount of damage the player has dealt in tenths 1. Includes only melee attacks.", }, DamageDealtAbsorbed = { Notes = "The amount of damage the player has dealt that was absorbed, in tenths of 1.", }, DamageDealtResisted = { Notes = "The amount of damage the player has dealt that was resisted, in tenths of 1.", }, DamageResisted = { Notes = "The amount of damage the player has resisted in tenths of 1.", }, DamageTaken = { Notes = "The amount of damage the player has taken in tenths of 1.", }, Deaths = { Notes = "The number of times the player died.", }, Drop = { Notes = "The number of items the drop key was pressed.", }, EatCakeSlice = { Notes = "The number of cake slices eaten.", }, EnchantItem = { Notes = "The number of items enchanted.", }, FallOneCm = { Notes = "The total distance fallen.", }, FillCauldron = { Notes = "The number of times the player filled cauldrons with water buckets.", }, FishCaught = { Notes = "The number of fish caught.", }, FlyOneCm = { Notes = "The total distance flown.", }, HorseOneCm = { Notes = "The total distance travelled by horses.", }, InspectDispenser = { Notes = "The number of times interacted with dispensers.", }, InspectDropper = { Notes = "The number of times interacted with droppers.", }, InspectHopper = { Notes = "The number of times interacted with hoppers.", }, InteractWithAnvil = { Notes = "The number of times interacted with anvils.", }, InteractWithBeacon = { Notes = "The number of times interacted with beacons.", }, InteractWithBlastFurnace = { Notes = "The number of times interacted with Blast Furnaces.", }, InteractWithBrewingstand = { Notes = "The number of times interacted with brewing stands.", }, InteractWithCampfire = { Notes = "The number of times interacted with campfires.", }, InteractWithCartographyTable = { Notes = "The number of times interacted with cartography tables.", }, InteractWithCraftingTable = { Notes = "The number of times interacted with crafting tables.", }, InteractWithFurnace = { Notes = "The number of times interacted with furnaces.", }, InteractWithGrindstone = { Notes = "The number of times interacted with grindstones.", }, InteractWithLectern = { Notes = "The number of times interacted with lecterns.", }, InteractWithLoom = { Notes = "The number of times interacted with looms.", }, InteractWithSmithingTable = { Notes = "The number of times interacted with smithing tables.", }, InteractWithSmoker = { Notes = "The number of times interacted with smokers.", }, InteractWithStonecutter = { Notes = "The number of times interacted with stonecutters.", }, JunkFished = { Notes = "The amount of junk fished.", }, Jump = { Notes = "The number of jumps performed.", }, LeaveGame = { Notes = "The number of times disconnected from the server.", }, MinecartOneCm = { Notes = "The total distance travelled by minecarts.", }, MobKills = { Notes = "The number of mobs the player killed.", }, OpenBarrel = { Notes = "The number of times the player has opened a barrel.", }, OpenChest = { Notes = "The number of times the player opened chests.", }, OpenEnderchest = { Notes = "The number of times the player opened ender chests.", }, OpenShulkerBox = { Notes = "The number of times the player has opened a shulker box.", }, PigOneCm = { Notes = "The total distance travelled by pigs via saddles.", }, PlayNoteblock = { Notes = "The number of note blocks hit.", }, PlayOneMinute = { Notes = "The total time played.", }, PlayRecord = { Notes = "The number of music discs played on a jukebox.", }, PlayerKills = { Notes = "The number of players the player directly killed.", }, PotFlower = { Notes = "The number of plants potted into flower pots.", }, RaidTrigger = { Notes = "The number of times the player has triggered a raid.", }, RaidWin = { Notes = "The number of times the player has won a raid.", }, SleepInBed = { Notes = "The number of times the player has slept in a bed.", }, SneakTime = { Notes = "The time the player has held down the sneak button.", }, SprintOneCm = { Notes = "The total distance sprinted.", }, StriderOneCm = { Notes = "The total distance travelled by striders via saddles.", }, SwimOneCm = { Notes = "The total distance swum.", }, TalkedToVillager = { Notes = "The number of times interacted with villagers (opened the trading GUI).", }, TargetHit = { Notes = "The number of times the player has shot a target block.", }, TimeSinceDeath = { Notes = "The time since the player's last death.", }, TimeSinceRest = { Notes = "The time since the player's last rest. This is used to spawn phantoms.", }, TradedWithVillager = { Notes = "The number of times traded with villagers.", }, TreasureFished = { Notes = "The number of treasures fished.", }, TriggerTrappedChest = { Notes = "The number of times the player opened trapped chests.", }, TuneNoteblock = { Notes = "The number of times interacted with note blocks.", }, UseCauldron = { Notes = "The number of times the player took water from cauldrons with glass bottles.", }, WalkOnWaterOneCm = { Notes = "The distance covered while bobbing up and down over water.", }, WalkOneCm = { Notes = "The total distance walked.", }, WalkUnderWaterOneCm = { Notes = "The total distance walked underwater.", }, }, }, Globals = { Desc = [[ These functions are available directly, without a class instance. Any plugin can call them at any time. ]], Functions = { AddFaceDirection = { { Params = { { Name = "BlockX", Type = "number", }, { Name = "BlockY", Type = "number", }, { Name = "BlockZ", Type = "number", }, { Name = "BlockFace", Type = "eBlockFace", }, { Name = "IsInverse", Type = "boolean", IsOptional = true, }, }, Returns = { { Name = "BlockX", Type = "number", }, { Name = "BlockY", Type = "number", }, { Name = "BlockZ", Type = "number", }, }, Notes = "Returns the coords of a block adjacent to the specified block through the specified {{Globals#BlockFaces|face}}", }, { Params = { { Name = "BlockPos", Type = "Vector3i", }, { Name = "BlockFace", Type = "eBlockFace", }, { Name = "IsInverse", Type = "boolean", IsOptional = true, }, }, Returns = { { Name = "BlockPos", Type = "Vector3i", }, }, Notes = "Returns the coords of a block adjacent to the specified block through the specified {{Globals#BlockFaces|face}}", }, }, Base64Decode = { Params = { { Name = "Input", Type = "string", }, }, Returns = { { Type = "string" }, }, Notes = "Decodes a Base64-encoded string into the raw data.", }, Base64Encode = { Params = { { Name = "Input", Type = "string", }, }, Returns = { { Type = "string" }, }, Notes = "Encodes a string into Base64.", }, BiomeToString = { Params = { { Name = "Biome", Type = "EMCSBiome", }, }, Returns = { { Type = "string" }, }, Notes = "Translates biome enum into biome string. Returns empty string on failure (unknown biome).", }, BlockFaceToString = { Params = { { Name = "eBlockFace", Type = "eBlockFace", }, }, Returns = { { Type = "string", }, }, Notes = "Returns the string representation of the {{Globals#BlockFaces|eBlockFace}} constant. Uses the axis-direction-based names, such as BLOCK_FACE_XP.", }, BlockStringToType = { Params = { { Name = "BlockTypeString", Type = "string", }, }, Returns = { { Name = "BLOCKTYPE", Type = "number", }, }, Notes = "Returns the block type parsed from the given string", }, Clamp = { Params = { { Name = "Number", Type = "number", }, { Name = "Min", Type = "number", }, { Name = "Max", Type = "number", }, }, Returns = { { Type = "number", }, }, Notes = "Clamp the number to the specified range.", }, ClickActionToString = { Params = { { Name = "ClickAction", Type = "eClickAction", }, }, Returns = { { Type = "string", }, }, Notes = "Returns a string description of the ClickAction enumerated value", }, DamageTypeToString = { Params = { { Name = "DamageType", Type = "eDamageType", }, }, Returns = { { Type = "string", }, }, Notes = "Converts the {{Globals#eDamageType|DamageType}} to a string representation ", }, DimensionToString = { Params = { { Name = "Dimension", Type = "eDimension", }, }, Returns = { { Type = "string", }, }, Notes = "Converts an {{Globals#eDimension|eDimension}} to a string value. Returns Overworld on failure.", }, EscapeString = { Params = { { Name = "Input", Type = "string", }, }, Returns = { { Type = "string", }, }, Notes = "Returns a copy of the string with all quotes and backslashes escaped by a backslash", }, GetIniItemSet = { Params = { { Name = "IniFile", Type = "cIniFile", }, { Name = "SectionName", Type = "string", }, { Name = "KeyName", Type = "string", }, { Name = "DefaultValue", Type = "string", }, }, Returns = { { Type = "cItem", }, }, Notes = "Returns the item that has been read from the specified INI file value. If the value is not present in the INI file, the DefaultValue is stored in the file and parsed as the result. Returns empty item if the value cannot be parsed. ", }, GetSnowStartHeight = { Params = { { Name = "Biome", Type = "EMCSBiome", }, }, Returns = { { Type = "number" }, }, Notes = "Returns the height at which snow will start falling in the {{Globals#EMCSBiome|Biome}}. Check functions IsBiomeCold and IsBiomeVeryCold for more informations.", }, GetTime = { Returns = { { Type = "number", }, }, Notes = "Returns the current OS time, as a unix time stamp (number of seconds since Jan 1, 1970)", }, IsBiomeCold = { Params = { { Name = "Biome", Type = "EMCSBiome", }, }, Returns = { { Type = "boolean" }, }, Notes = "Returns true if the biome is cold (has snow and snowfall at higher elevations but not at regular heights). Doesn't report Very Cold biomes, use IsBiomeVeryCold() for those.", }, IsBiomeNoDownfall = { Params = { { Name = "Biome", Type = "EMCSBiome", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the biome is 'dry', that is, there is no precipitation during rains and storms.", }, IsBiomeOcean = { Params = { { Name = "Biome", Type = "EMCSBiome", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the biome is an ocean biome.", }, IsBiomeVeryCold = { Params = { { Name = "Biome", Type = "EMCSBiome", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the biome is very cold (has snow on ground everywhere, turns top water to ice, has snowfall instead of rain everywhere). Doesn't report mildly cold biomes (where it snows above certain elevation), use IsBiomeCold() for those.", }, IsBiomeMountain = { Params = { { Name = "Biome", Type = "EMCSBiome", } }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the biome is mountainous (mutations of the extreme hills biome)." }, IsBiomeMesa = { Params = { { Name = "Biome", Type = "EMCSBiome", } }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if the biome is a type of Mesa (mutations of the Mesa biome)." }, IsValidBlock = { Params = { { Name = "BlockType", Type = "number", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if BlockType is a known block type", }, IsValidItem = { Params = { { Name = "ItemType", Type = "number", }, }, Returns = { { Type = "boolean", }, }, Notes = "Returns true if ItemType is a known item type", }, ItemToFullString = { Params = { { Name = "cItem", Type = "cItem", }, }, Returns = { { Type = "string", }, }, Notes = "Returns the string representation of the item, in the format 'ItemTypeText:ItemDamage * Count'", }, ItemToString = { Params = { { Name = "cItem", Type = "cItem", }, }, Returns = { { Type = "string", }, }, Notes = "Returns the string representation of the item type", }, ItemTypeToString = { Params = { { Name = "ItemType", Type = "number", }, }, Returns = { { Type = "string", }, }, Notes = "Returns the string representation of ItemType ", }, LOG = { { Params = { { Name = "Message", Type = "string", }, { Name = "SuppressPluginNamePrefix", Type = "boolean", IsOptional = true, }, }, Notes = "Logs a text into the server console and logfile using 'normal' severity (gray text).", }, { Params = { { Name = "Message", Type = "cCompositeChat", }, { Name = "SuppressPluginNamePrefix", Type = "boolean", IsOptional = true, }, }, Notes = "Logs the {{cCompositeChat}}'s human-readable text into the server console, using a severity defined by the CompositeChat's MessageType.", }, }, LOGERROR = { Params = { { Name = "Message", Type = "string", }, { Name = "SuppressPluginNamePrefix", Type = "boolean", IsOptional = true, }, }, Notes = "Logs a text into the server console and logfile using 'error' severity (black text on red background).", }, LOGINFO = { Params = { { Name = "Message", Type = "string", }, { Name = "SuppressPluginNamePrefix", Type = "boolean", IsOptional = true, }, }, Notes = "Logs a text into the server console and logfile using 'info' severity (yellow text).", }, LOGWARN = { Params = { { Name = "Message", Type = "string", }, { Name = "SuppressPluginNamePrefix", Type = "boolean", IsOptional = true, }, }, Notes = "Logs a text into the server console and logfile using 'warning' severity (red text); OBSOLETE, use LOGWARNING() instead.", }, LOGWARNING = { Params = { { Name = "Message", Type = "string", }, { Name = "SuppressPluginNamePrefix", Type = "boolean", IsOptional = true, }, }, Notes = "Logs a text into the server console and logfile using 'warning' severity (red text).", }, md5 = { Params = { { Name = "Data", Type = "string", }, }, Returns = { { Type = "string", }, }, Notes = "OBSOLETE, use the {{cCryptoHash}} functions instead.
-- a_Player is a {{cPlayer}} object, possibly received as a hook param
local HeldItem = a_Player:GetEquippedItem()
if (ItemCategory.IsShovel(HeldItem.m_ItemType)) then
-- It's a shovel
end
]],
},
},
},
lxp =
{
Desc = [[
This class provides an interface to the XML parser,
{{https://matthewwild.co.uk/projects/luaexpat/|LuaExpat}}. It provides a SAX interface with an
incremental XML parser.
With an event-based API like SAX the XML document can be fed to the parser in chunks, and the parsing begins as soon as the parser receives the first document chunk. LuaExpat reports parsing events (such as the start and end of elements) directly to the application through callbacks. The parsing of huge documents can benefit from this piecemeal operation.
See the online {{https://matthewwild.co.uk/projects/luaexpat/manual.html#parser|LuaExpat documentation}} for details on how to work with this parser. The code examples below should provide some basic help, too. ]], Functions = { new = { Params = { { Name = "CallbacksTable", Type = "table", }, { Name = "SeparatorChar", Type = "string", IsOptional = true, }, }, Returns = { { Name = "XMLParser object", Type = "table", }, }, Notes = "Creates a new XML parser object, with the specified callbacks table and optional separator character.", }, }, Constants = { _COPYRIGHT = { Notes = "", }, _DESCRIPTION = { Notes = "", }, _VERSION = { Notes = "", }, }, AdditionalInfo = { { Header = "Parser callbacks", Contents = [[ The callbacks table passed to the new() function specifies the Lua functions that the parser calls upon various events. The following table lists the most common functions used, for a complete list see the online {{https://matthewwild.co.uk/projects/luaexpat/manual.html#parser|LuaExpat documentation}}.
| Function name | Parameters | Notes |
|---|---|---|
| CharacterData | Parser, string | Called when the parser recognizes a raw string inside the element |
| EndElement | Parser, ElementName | Called when the parser detects the ending of an XML element |
| StartElement | Parser, ElementName, AttributesTable | Called when the parser detects the start of an XML element. The AttributesTable is a Lua table containing all the element's attributes, both in the array section (in the order received) and in the dictionary section. |
local Depth = 0;
-- Define the callbacks:
local Callbacks = {
CharacterData = function(a_Parser, a_String)
LOG(string.rep(" ", Depth) .. "* " .. a_String);
end
EndElement = function(a_Parser, a_ElementName)
Depth = Depth - 1;
LOG(string.rep(" ", Depth) .. "- " .. a_ElementName);
end
StartElement = function(a_Parser, a_ElementName, a_Attribs)
LOG(string.rep(" ", Depth) .. "+ " .. a_ElementName);
Depth = Depth + 1;
end
}
-- Create the parser:
local Parser = lxp.new(Callbacks);
-- Parse the XML file:
local f = io.open("file.xml", "rb");
while (true) do
local block = f:read(128 * 1024); -- Use a 128KiB buffer for reading
if (block == nil) then
-- End of file
break;
end
Parser:parse(block);
end
-- Signalize to the parser that no more data is coming
Parser:parse();
-- Close the parser:
Parser:close();
]],
},
},
},
sqlite3 =
{
Desc = [[
]],
Functions =
{
complete =
{
IsStatic = true,
IsGlobal = true, -- Emulate a global function without a self parameter - this is called with a dot convention
Params =
{
{
Name = "SQL",
Type = "string",
},
},
Returns =
{
{
Type = "boolean",
},
},
Notes = "Returns true if the input string comprises one or more complete SQL statements.",
},
open =
{
IsStatic = true,
IsGlobal = true, -- Emulate a global function without a self parameter - this is called with a dot convention
Params =
{
{
Name = "FileName",
Type = "string",
},
},
Returns =
{
{
Name = "DBClass",
Type = "SQLite DB object",
},
},
Notes = [[
Opens (or creates if it does not exist) an SQLite database with name filename and returns its
handle (the returned object should be used for all further method calls in connection
with this specific database, see
{{http://lua.sqlite.org/index.cgi/doc/tip/doc/lsqlite3.wiki#database_methods|Database methods}}).
Example:
-- open the database:
myDB = sqlite3.open('MyDatabaseFile.sqlite3')
-- do some database calls...
-- Close the database:
myDB:close()
]],
},
open_memory =
{
IsStatic = true,
IsGlobal = true, -- Emulate a global function without a self parameter - this is called with a dot convention
Returns =
{
{
Name = "DBClass",
Type = "SQLite DB object",
},
},
Notes = "Opens an SQLite database in memory and returns its handle. In case of an error, the function returns nil, an error code and an error message. (In-memory databases are volatile as they are never stored on disk.)",
},
version =
{
IsStatic = true,
IsGlobal = true, -- Emulate a global function without a self parameter - this is called with a dot convention
Returns =
{
{
Type = "string",
},
},
Notes = "Returns a string with SQLite version information, in the form 'x.y[.z]'.",
},
},
},
TakeDamageInfo =
{
Desc = [[
This class contains the amount of damage, and the entity that caused the damage. It is used in the
{{OnTakeDamage|HOOK_TAKE_DAMAGE}} hook and in the {{cEntity}}'s TakeDamage() function.
]],
Variables =
{
Attacker =
{
Type = "{{cEntity}}",
Notes = "The entity who is attacking. Only valid if dtAttack.",
},
DamageType =
{
Type = "eDamageType",
Notes = "Source of the damage. One of the dtXXX constants.",
},
FinalDamage =
{
Type = "number",
Notes = "The final amount of damage that will be applied to the Receiver. It is the RawDamage minus any Receiver's armor-protection.",
},
Knockback =
{
Type = "{{Vector3d}}",
Notes = "Vector specifying the amount and direction of knockback that will be applied to the Receiver ",
},
RawDamage =
{
Type = "number",
Notes = "Amount of damage that the attack produces on the Receiver, including the Attacker's equipped weapon, but excluding the Receiver's armor.",
},
},
AdditionalInfo =
{
{
Header = "",
Contents = [[
The TDI is passed as the second parameter in the HOOK_TAKE_DAMAGE hook, and can be used to
modify the damage before it is applied to the receiver:
function OnTakeDamage(Receiver, TDI)
LOG("Damage: Raw ".. TDI.RawDamage .. ", Final:" .. TDI.FinalDamage);
-- If the attacker is a spider, make it deal 999 points of damage (insta-death spiders):
if ((TDI.Attacker ~= nil) and TDI.Attacker:IsA("cSpider")) then
TDI.FinalDamage = 999;
end
end
]],
},
},
},
tolua =
{
Desc = [[
This class represents the tolua bridge between the Lua API and Cuberite. It supports some low
level operations and queries on the objects. See also the tolua++'s documentation at
{{https://www8.cs.umu.se/kurser/TDBD12/VT04/lab/lua/tolua++.html#utilities}}. Normally you shouldn't use any of these
functions except for type()
]],
Functions =
{
cast =
{
IsStatic = true,
IsGlobal = true, -- Emulate a global function without a self parameter - this is called with a dot convention
Params =
{
{
Name = "Object",
Type = "any",
},
{
Name = "TypeStr",
Type = "string",
},
},
Returns =
{
{
Name = "Object",
Type = "any",
},
},
Notes = "Casts the object to the specified type.