From be841b4769cac98a932148bcdf6013f2dcac4ea2 Mon Sep 17 00:00:00 2001
From: "[IPSA] Chris de Claverie" <c.de-claverie@protonmail.com>
Date: Thu, 1 Oct 2020 12:38:10 +0200
Subject: Add SetBlockMeta warning in documentation (#4943)

+ Add SetBlockMeta warning in documentation

Co-authored-by: pwnOrbitals <c.de-claverie@pm.me>
---
 Server/Plugins/APIDump/APIDesc.lua           | 5 +++--
 Server/Plugins/APIDump/Classes/BlockArea.lua | 5 ++++-
 Server/Plugins/APIDump/Classes/World.lua     | 4 ++--
 3 files changed, 9 insertions(+), 5 deletions(-)

(limited to 'Server/Plugins/APIDump')

diff --git a/Server/Plugins/APIDump/APIDesc.lua b/Server/Plugins/APIDump/APIDesc.lua
index 4a61fb55c..f339aa6d1 100644
--- a/Server/Plugins/APIDump/APIDesc.lua
+++ b/Server/Plugins/APIDump/APIDesc.lua
@@ -542,6 +542,7 @@ return
 				only used as a parameter for the {{OnChunkGenerating|OnChunkGenerating}} and
 				{{OnChunkGenerated|OnChunkGenerated}} hooks and cannot be constructed on its own. Plugins can use this
 				class in both those hooks to manipulate generated chunks.
+				Calls to any setter of this class will not trigger simulator updates (lava, water, redstone).
 			]],
 			Functions =
 			{
@@ -1119,7 +1120,7 @@ return
 							Type = "EMCSBiome",
 						},
 					},
-					Notes = "Sets the biome at the specified relative coords",
+					Notes = "Sets the biome at the specified relative coords.",
 				},
 				SetBlockMeta =
 				{
@@ -1142,7 +1143,7 @@ return
 							Type = "number",
 						},
 					},
-					Notes = "Sets the block meta at the specified relative coords",
+					Notes = "Sets the block meta at the specified relative coords.",
 				},
 				SetBlockType =
 				{
diff --git a/Server/Plugins/APIDump/Classes/BlockArea.lua b/Server/Plugins/APIDump/Classes/BlockArea.lua
index f4c47d063..a826bb713 100644
--- a/Server/Plugins/APIDump/Classes/BlockArea.lua
+++ b/Server/Plugins/APIDump/Classes/BlockArea.lua
@@ -37,6 +37,9 @@ return
 				<li>Modify blocks inside cBlockArea</li>
 				<li>Write the area back to a world / save to file</li>
 			</ul></p>
+			<p>
+			Calls to any setter of this class will not trigger simulator updates (lava, water, redstone).
+			</p>
 		]],
 		Functions =
 		{
@@ -1621,7 +1624,7 @@ return
 						Type = "number",
 					},
 				},
-				Notes = "Sets the block meta at the specified absolute coords",
+				Notes = "Sets the block meta at the specified absolute coords.",
 			},
 			SetBlockSkyLight =
 			{
diff --git a/Server/Plugins/APIDump/Classes/World.lua b/Server/Plugins/APIDump/Classes/World.lua
index 62e53ace6..b86a84e71 100644
--- a/Server/Plugins/APIDump/Classes/World.lua
+++ b/Server/Plugins/APIDump/Classes/World.lua
@@ -2802,7 +2802,7 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
 							Type = "number",
 						},
 					},
-					Notes = "Sets the meta for the block at the specified coords.",
+					Notes = "Sets the meta for the block at the specified coords. Any call to SetBlockMeta will not generate a simulator update (water, lava, redstone), consider using SetBlock instead.",
 				},
 				{
 					Params =
@@ -2816,7 +2816,7 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i
 							Type = "number",
 						},
 					},
-					Notes = "Sets the meta for the block at the specified coords.",
+					Notes = "Sets the meta for the block at the specified coords. Any call to SetBlockMeta will not generate a simulator update (water, lava, redstone), consider using SetBlock instead.",
 				},
 			},
 			SetChunkAlwaysTicked =
-- 
cgit v1.2.3