diff options
Diffstat (limited to 'Server/Plugins/APIDump')
| -rw-r--r-- | Server/Plugins/APIDump/APIDesc.lua | 18 | ||||
| -rw-r--r-- | Server/Plugins/APIDump/Classes/BlockEntities.lua | 33 | ||||
| -rw-r--r-- | Server/Plugins/APIDump/Classes/World.lua | 24 |
3 files changed, 41 insertions, 34 deletions
diff --git a/Server/Plugins/APIDump/APIDesc.lua b/Server/Plugins/APIDump/APIDesc.lua index 6cfcb9c15..f1346ffee 100644 --- a/Server/Plugins/APIDump/APIDesc.lua +++ b/Server/Plugins/APIDump/APIDesc.lua @@ -11377,6 +11377,12 @@ a_Player:OpenWindow(Window); Type = "function", }, }, + Returns = + { + { + Type = "boolean", + }, + }, Notes = "Calls the given callback function for each player. The callback function has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cPlayer|cPlayer}})</pre>", }, ForEachWorld = @@ -11388,7 +11394,13 @@ a_Player:OpenWindow(Window); Type = "function", }, }, - Notes = "Calls the given callback function for each world. The callback function has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cWorld|cWorld}})</pre>", + Returns = + { + { + Type = "boolean", + }, + }, + Notes = "Calls the given callback function for each world. The callback function has the following signature: <pre class=\"prettyprint lang-lua\">function Callback({{cWorld|cWorld}})</pre>. Returns false if a callback aborts, otherwise true.", }, Get = { @@ -12521,7 +12533,7 @@ local CompressedString = cStringCompression.CompressStringGZIP("DataToCompress") }, { Name = "Port", - Type = "string", + Type = "number", }, { Name = "Path", @@ -12564,7 +12576,7 @@ local CompressedString = cStringCompression.CompressStringGZIP("DataToCompress") }, { Name = "Port", - Type = "string", + Type = "number", }, }, Notes = "Parses the Authority part of the URL. Parts that are not explicitly specified in the AuthPart are returned empty, the port is returned zero. If parsing fails, the function returns nil and an error message.", diff --git a/Server/Plugins/APIDump/Classes/BlockEntities.lua b/Server/Plugins/APIDump/Classes/BlockEntities.lua index fc4f6ec0b..debefda7a 100644 --- a/Server/Plugins/APIDump/Classes/BlockEntities.lua +++ b/Server/Plugins/APIDump/Classes/BlockEntities.lua @@ -806,37 +806,14 @@ World:ForEachChestInChunk(Player:GetChunkX(), Player:GetChunkZ(), Params = { { - Name = "BlockX", - Type = "number", - }, - { - Name = "BlockY", - Type = "number", - }, - { - Name = "BlockZ", - Type = "number", + Name = "BlockPos", + Type = "Vector3i", }, { Name = "BlockMeta", Type = "number", }, }, - Returns = - { - { - Name = "BlockX", - Type = "number", - }, - { - Name = "BlockY", - Type = "number", - }, - { - Name = "BlockZ", - Type = "number", - }, - }, Notes = "Adjusts the block coords to where the dropspenser items materialize", }, }, @@ -1586,11 +1563,11 @@ World:ForEachChestInChunk(Player:GetChunkX(), Player:GetChunkZ(), Type = "number", }, }, - Notes = "Returns the current pitch set for the block", + Notes = "(<b>DEPRECATED</b>) Please use cNoteEntity:GetNote. Returns the current pitch set for the block", }, IncrementPitch = { - Notes = "Adds 1 to the current pitch. Wraps around to 0 when the pitch cannot go any higher.", + Notes = "(<b>DEPRECATED</b>) Please use cNoteEntity:IncrementNote. Adds 1 to the current pitch. Wraps around to 0 when the pitch cannot go any higher.", }, MakeSound = { @@ -1605,7 +1582,7 @@ World:ForEachChestInChunk(Player:GetChunkX(), Player:GetChunkZ(), Type = "number", }, }, - Notes = "Sets a new note for the block.", + Notes = "(<b>DEPRECATED</b>) Please use cNoteEntity:SetNote. Sets a new note for the block.", }, }, Inherits = "cBlockEntity", diff --git a/Server/Plugins/APIDump/Classes/World.lua b/Server/Plugins/APIDump/Classes/World.lua index acfa05727..7f137cf72 100644 --- a/Server/Plugins/APIDump/Classes/World.lua +++ b/Server/Plugins/APIDump/Classes/World.lua @@ -2256,7 +2256,13 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i Type = "Vector3i", }, }, - Notes = "Grows a tree based at the specified coords. If there is a sapling there, grows the tree based on that sapling, otherwise chooses a tree image based on the biome.", + Returns = + { + { + Type = "boolean", + }, + }, + Notes = "Grows a tree based at the specified coords. If there is a sapling there, grows the tree based on that sapling, otherwise chooses a tree image based on the biome. Returns true if the tree was grown, false if not (invalid chunk, insufficient space)", }, GrowTreeByBiome = { @@ -2267,7 +2273,13 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i Type = "Vector3i", }, }, - Notes = "Grows a tree based at the specified coords. The tree type is picked from types available for the biome at those coords.", + Returns = + { + { + Type = "boolean", + }, + }, + Notes = "Grows a tree based at the specified coords. The tree type is picked from types available for the biome at those coords. Returns true if the tree was grown, false if not (invalid chunk, insufficient space)", }, GrowTreeFromSapling = { @@ -2278,7 +2290,13 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i Type = "Vector3i", }, }, - Notes = "Grows a tree based at the specified coords. The tree type is determined from the sapling meta. If the sapling is part of a 2x2 sapling area, grows a large tree.", + Returns = + { + { + Type = "boolean", + }, + }, + Notes = "Grows a tree based at the specified coords. The tree type is determined from the sapling meta. If the sapling is part of a 2x2 sapling area, grows a large tree. Returns true if the tree was grown, false if not (invalid chunk, insufficient space)", }, IsBlockDirectlyWatered = { |