summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/APIDesc.lua
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-11-15 13:10:36 +0100
committermadmaxoft <github@xoft.cz>2013-11-15 13:10:36 +0100
commit7586e832bf74d6ca9f6fcfe75f55378b6ea3ac20 (patch)
tree2b1db47ce5e6dfb15278c305d221af9c143274ef /MCServer/Plugins/APIDump/APIDesc.lua
parentAPIDump: Documented the cJukeboxEntity. (diff)
downloadcuberite-7586e832bf74d6ca9f6fcfe75f55378b6ea3ac20.tar
cuberite-7586e832bf74d6ca9f6fcfe75f55378b6ea3ac20.tar.gz
cuberite-7586e832bf74d6ca9f6fcfe75f55378b6ea3ac20.tar.bz2
cuberite-7586e832bf74d6ca9f6fcfe75f55378b6ea3ac20.tar.lz
cuberite-7586e832bf74d6ca9f6fcfe75f55378b6ea3ac20.tar.xz
cuberite-7586e832bf74d6ca9f6fcfe75f55378b6ea3ac20.tar.zst
cuberite-7586e832bf74d6ca9f6fcfe75f55378b6ea3ac20.zip
Diffstat (limited to 'MCServer/Plugins/APIDump/APIDesc.lua')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua21
1 files changed, 20 insertions, 1 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 993c2a40b..54bd86c77 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -1711,7 +1711,26 @@ a_Player:OpenWindow(Window);
mtZombiePigman = { Notes = "" },
},
Inherits = "cPawn",
- },
+ }, -- cMonster
+
+ cNoteEntity =
+ {
+ Desc = [[
+ This class represents a note block entity in the world. It takes care of the note block's pitch,
+ and also can play the sound, either when the {{cPlayer|player}} right-clicks it, redstone activates
+ it, or upon a plugin's request.</p>
+ <p>
+ The pitch is stored as an integer between 0 and 24.
+ ]],
+ Functions =
+ {
+ GetPitch = { Params = "", Return = "number", Notes = "Returns the current pitch set for the block" },
+ IncrementPitch = { Params = "", Return = "", Notes = "Adds 1 to the current pitch. Wraps around to 0 when the pitch cannot go any higher." },
+ MakeSound = { Params = "", Return = "", Notes = "Plays the sound for all {{cClientHandle|clients}} near this block." },
+ SetPitch = { Params = "Pitch", Return = "", Notes = "Sets a new pitch for the block." },
+ },
+ Inherits = "cBlockEntity",
+ }, -- cNoteEntity
cPawn =
{