summaryrefslogtreecommitdiffstats
path: root/Server/Plugins
diff options
context:
space:
mode:
authorLukas Pioch <lukas@zgow.de>2017-05-09 14:21:25 +0200
committerLukas Pioch <lukas@zgow.de>2017-05-24 19:02:18 +0200
commit73a3c4e3be1916bdd4830e7ce7454035a1f572f6 (patch)
tree95716ef6c87706de98866b0fa13f862dd07855ff /Server/Plugins
parentOff-hand/shield slot functional, save and load slot, bow + arrow functional (#3725) (diff)
downloadcuberite-73a3c4e3be1916bdd4830e7ce7454035a1f572f6.tar
cuberite-73a3c4e3be1916bdd4830e7ce7454035a1f572f6.tar.gz
cuberite-73a3c4e3be1916bdd4830e7ce7454035a1f572f6.tar.bz2
cuberite-73a3c4e3be1916bdd4830e7ce7454035a1f572f6.tar.lz
cuberite-73a3c4e3be1916bdd4830e7ce7454035a1f572f6.tar.xz
cuberite-73a3c4e3be1916bdd4830e7ce7454035a1f572f6.tar.zst
cuberite-73a3c4e3be1916bdd4830e7ce7454035a1f572f6.zip
Diffstat (limited to '')
-rw-r--r--Server/Plugins/APIDump/APIDesc.lua143
-rw-r--r--Server/Plugins/APIDump/Classes/World.lua6
2 files changed, 148 insertions, 1 deletions
diff --git a/Server/Plugins/APIDump/APIDesc.lua b/Server/Plugins/APIDump/APIDesc.lua
index 2733e9462..e0d5cbd71 100644
--- a/Server/Plugins/APIDump/APIDesc.lua
+++ b/Server/Plugins/APIDump/APIDesc.lua
@@ -11038,6 +11038,149 @@ a_Player:OpenWindow(Window);
},
Inherits = "cEntity",
},
+ cBoat =
+ {
+ Desc = [[
+ This class represents a boat. This entity can be spawned by using {{cWorld#SpawnBoat_1|cWorld:SpawnBoat}}.
+ ]],
+ Functions =
+ {
+ GetMaterial =
+ {
+ Returns =
+ {
+ {
+ Name = "Material",
+ Type = "cBoat#eMaterial",
+ },
+ },
+ Notes = "Returns the material of the boat.",
+ },
+ MaterialToString =
+ {
+ IsStatic = true,
+ Params =
+ {
+ {
+ Name = "Item",
+ Type = "cItem",
+ },
+ },
+ Returns =
+ {
+ {
+ Name = "Material",
+ Type = "string",
+ },
+ },
+ Notes = "Returns the boat material as a string.",
+ },
+ ItemToMaterial =
+ {
+ IsStatic = true,
+ Params =
+ {
+ {
+ Name = "Item",
+ Type = "cItem",
+ },
+ },
+ Returns =
+ {
+ {
+ Name = "Material",
+ Type = "cBoat#eMaterial",
+ },
+ },
+ Notes = "Returns the eMaterial that should be used for a boat created from the specified item. Returns bmOak if not a boat item.",
+ },
+ MaterialToItem =
+ {
+ IsStatic = true,
+ Params =
+ {
+ {
+ Name = "Material",
+ Type = "cBoat#eMaterial",
+ },
+ },
+ Returns =
+ {
+ {
+ Name = "Item",
+ Type = "cItem",
+ },
+ },
+ Notes = "Returns the boat item of the boat material",
+ },
+ StringToMaterial =
+ {
+ IsStatic = true,
+ Params =
+ {
+ {
+ Name = "Material",
+ Type = "string",
+ },
+ },
+ Returns =
+ {
+ {
+ Name = "Material",
+ Type = "cBoat#eMaterial",
+ },
+ },
+ Notes = "Returns the boat material for the passed string. Returns oak if not valid.",
+ },
+ SetMaterial =
+ {
+ Params =
+ {
+ {
+ Name = "Material",
+ Type = "cBoat#eMaterial",
+ },
+ },
+ Notes = "Set the material of the boat.",
+ },
+ },
+ Constants =
+ {
+ bmOak =
+ {
+ Notes = "",
+ },
+ bmSpruce =
+ {
+ Notes = "",
+ },
+ bmBirch =
+ {
+ Notes = "",
+ },
+ bmJungle =
+ {
+ Notes = "",
+ },
+ bmAcacia =
+ {
+ Notes = "",
+ },
+ bmDarkOak =
+ {
+ Notes = "",
+ },
+ },
+ ConstantGroups =
+ {
+ eMaterial =
+ {
+ Include = "bm.*",
+ TextBefore = "These constans are the different wood materials of the boat.",
+ },
+ },
+ Inherits = "cEntity",
+ },
cPickup =
{
Desc = [[
diff --git a/Server/Plugins/APIDump/Classes/World.lua b/Server/Plugins/APIDump/Classes/World.lua
index 039585e6b..3ba2d82ca 100644
--- a/Server/Plugins/APIDump/Classes/World.lua
+++ b/Server/Plugins/APIDump/Classes/World.lua
@@ -2902,6 +2902,10 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
Name = "Z",
Type = "number",
},
+ {
+ Name = "Material",
+ Type = "cBoat#eMaterial",
+ },
},
Returns =
{
@@ -2910,7 +2914,7 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
Type = "number",
},
},
- Notes = "Spawns a boat at the specific coordinates. Returns the EntityID of the new boat, or {{cEntity#INVALID_ID|cEntity#INVALID_ID}} if no boat was created.",
+ Notes = "Spawns a {{cBoat|boat}} at the specific coordinates. Returns the EntityID of the new boat, or {{cEntity#INVALID_ID|cEntity#INVALID_ID}} if no boat was created.",
},
SpawnExperienceOrb =
{