summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/APIDesc.lua
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-09-14 17:56:51 +0200
committermadmaxoft <github@xoft.cz>2013-09-14 17:56:51 +0200
commit3ed9e148e8d13b0e6e3115a5d1ad2c87bdcfb443 (patch)
tree8d12ea9717530361c0fcf05283e11c71660c1f8b /MCServer/Plugins/APIDump/APIDesc.lua
parentAPIDump: Added an example on how to fill in the documentation. (diff)
downloadcuberite-3ed9e148e8d13b0e6e3115a5d1ad2c87bdcfb443.tar
cuberite-3ed9e148e8d13b0e6e3115a5d1ad2c87bdcfb443.tar.gz
cuberite-3ed9e148e8d13b0e6e3115a5d1ad2c87bdcfb443.tar.bz2
cuberite-3ed9e148e8d13b0e6e3115a5d1ad2c87bdcfb443.tar.lz
cuberite-3ed9e148e8d13b0e6e3115a5d1ad2c87bdcfb443.tar.xz
cuberite-3ed9e148e8d13b0e6e3115a5d1ad2c87bdcfb443.tar.zst
cuberite-3ed9e148e8d13b0e6e3115a5d1ad2c87bdcfb443.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua29
1 files changed, 29 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index af5828405..f29ce7f27 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -42,9 +42,38 @@ g_APIDesc =
Contents = "Contents of the additional section 2",
}
},
+
+ Inherits = "ParentClassName", -- Only present if the class inherits from another API class
},
]]--
+ cArrowEntity =
+ {
+ Desc = [[
+ Represents the arrow when it is shot from the bow. A subclass of the {{cProjectileEntity}}.
+ ]],
+
+ Functions =
+ {
+ CanPickup = { Params = "{{cPlayer|Player}}", Return = "bool", Notes = "Returns true if the specified player can pick the arrow when it's on the ground" },
+ GetDamageCoeff = { Params = "", Return = "number", Notes = "Returns the damage coefficient stored within the arrow. The damage dealt by this arrow is multiplied by this coeff" },
+ GetPickupState = { Params = "", Return = "PickupState", Notes = "Returns the pickup state (one of the psXXX constants, above)" },
+ IsCritical = { Params = "", Return = "bool", Notes = "Returns true if the arrow should deal critical damage. Based on the bow charge when the arrow was shot." },
+ SetDamageCoeff = { Params = "number", Return = "", Notes = "Sets the damage coefficient. The damage dealt by this arrow is multiplied by this coeff" },
+ SetIsCritical = { Params = "bool", Return = "", Notes = "Sets the IsCritical flag on the arrow. Critical arrow deal additional damage" },
+ SetPickupState = { Params = "PickupState", Return = "", Notes = "Sets the pickup state (one of the psXXX constants, above)" },
+ },
+
+ Constants =
+ {
+ psInCreative = { Notes = "The arrow can be picked up only by players in creative gamemode" },
+ psInSurvivalOrCreative = { Notes = "The arrow can be picked up by players in survival or creative gamemode" },
+ psNoPickup = { Notes = "The arrow cannot be picked up at all" },
+ },
+
+ Inherits = "cProjectileEntity",
+ },
+
cBlockArea =
{
Desc = [[