From f709f74aeb566fc0edf95e32f3914f007b2383d4 Mon Sep 17 00:00:00 2001
From: Lukas Pioch <lukas@zgow.de>
Date: Mon, 1 May 2017 12:59:18 +0200
Subject: APIDoc: Removed non-existent functions and added missing return types

---
 Server/Plugins/APIDump/Classes/BlockEntities.lua | 17 ------
 Server/Plugins/APIDump/Classes/World.lua         | 70 +++++++++++-------------
 2 files changed, 33 insertions(+), 54 deletions(-)

(limited to 'Server/Plugins/APIDump/Classes')

diff --git a/Server/Plugins/APIDump/Classes/BlockEntities.lua b/Server/Plugins/APIDump/Classes/BlockEntities.lua
index da47c4acc..bae9030c4 100644
--- a/Server/Plugins/APIDump/Classes/BlockEntities.lua
+++ b/Server/Plugins/APIDump/Classes/BlockEntities.lua
@@ -622,12 +622,6 @@ World:ForEachChestInChunk(Player:GetChunkX(), Player:GetChunkZ(),
 						Type = "string",
 					},
 				},
-				Returns =
-				{
-					{
-						Type = "string",
-					},
-				},
 				Notes = "Sets the command",
 			},
 		},
@@ -760,17 +754,6 @@ World:ForEachChestInChunk(Player:GetChunkX(), Player:GetChunkZ(),
 				},
 				Notes = "Adjusts the block coords to where the dropspenser items materialize",
 			},
-			SetRedstonePower =
-			{
-				Params =
-				{
-					{
-						Name = "IsPowered",
-						Type = "boolean",
-					},
-				},
-				Notes = "Sets the redstone status of the dropspenser. If the redstone power goes from off to on, the dropspenser will be activated",
-			},
 		},
 		Constants =
 		{
diff --git a/Server/Plugins/APIDump/Classes/World.lua b/Server/Plugins/APIDump/Classes/World.lua
index aa430027b..1b4434181 100644
--- a/Server/Plugins/APIDump/Classes/World.lua
+++ b/Server/Plugins/APIDump/Classes/World.lua
@@ -433,7 +433,13 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
 						Type = "number",
 					},
 				},
-				Notes = "Replaces the specified block with air, without dropping the usual pickups for the block. Wakes up the simulators for the block and its neighbors.",
+				Returns =
+				{
+					{
+						Type = "boolean",
+					},
+				},
+				Notes = "Replaces the specified block with air, without dropping the usual pickups for the block. Wakes up the simulators for the block and its neighbors. Returns true on success, or false if the chunk is not loaded or invalid coords.",
 			},
 			DoExplosionAt =
 			{
@@ -1424,6 +1430,12 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
 						Type = "eWeather",
 					},
 				},
+				Returns =
+				{
+					{
+						Type = "number",
+					},
+				},
 				Notes = "Returns the default weather interval for the specific weather type. Returns -1 for any unknown weather.",
 			},
 			GetDimension =
@@ -2272,41 +2284,6 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
 			{
 				Notes = "Queues all chunks to be saved in the world storage thread",
 			},
-			QueueSetBlock =
-			{
-				Params =
-				{
-					{
-						Name = "BlockX",
-						Type = "number",
-					},
-					{
-						Name = "BlockY",
-						Type = "number",
-					},
-					{
-						Name = "BlockZ",
-						Type = "number",
-					},
-					{
-						Name = "BlockType",
-						Type = "number",
-					},
-					{
-						Name = "BlockMeta",
-						Type = "number",
-					},
-					{
-						Name = "TickDelay",
-						Type = "number",
-					},
-				},
-				Notes = [[
-					Queues the block to be set to the specified blocktype and meta after the specified amount of game
-					ticks. Uses SetBlock() for the actual setting, so simulators are woken up and block entities are
-					handled correctly.
-				]],
-			},
 			QueueTask =
 			{
 				Params =
@@ -2850,7 +2827,13 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
 						Type = "boolean",
 					},
 				},
-				Notes = "Opens or closes a trapdoor at the specific coordinates.",
+				Returns =
+				{
+					{
+						Type = "boolean",
+					},
+				},
+				Notes = "Opens or closes a trapdoor at the specific coordinates. Returns true on success, false if there is no trapdoor or it's already in the requested state.",
 			},
 			SetWeather =
 			{
@@ -3167,6 +3150,13 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
 						Type = "number",
 					},
 				},
+				Returns =
+				{
+					{
+						Name = "EntityID",
+						Type = "number",
+					},
+				},
 				Notes = "Spawns a {{cTNTEntity|primed TNT entity}} at the specified coords, with the given fuse ticks. The entity gets a random speed multiplied by the InitialVelocityCoeff, 1 being the default value.",
 			},
 			TryGetHeight =
@@ -3261,6 +3251,12 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
 			VillagersShouldHarvestCrops =
 			{
 				Notes = "Returns true if villagers can harvest crops.",
+				Returns =
+				{
+					{
+						Type = "boolean",
+					},
+				},
 			},
 			WakeUpSimulators =
 			{
-- 
cgit v1.2.3