diff options
| -rw-r--r-- | Server/Plugins/APIDump/Classes/World.lua | 52 | ||||
| -rw-r--r-- | src/World.h | 4 |
2 files changed, 42 insertions, 14 deletions
diff --git a/Server/Plugins/APIDump/Classes/World.lua b/Server/Plugins/APIDump/Classes/World.lua index b86a84e71..acfa05727 100644 --- a/Server/Plugins/APIDump/Classes/World.lua +++ b/Server/Plugins/APIDump/Classes/World.lua @@ -541,28 +541,56 @@ function OnAllChunksAvailable()</pre> All return values from the callbacks are i }, DigBlock = { - Params = { + Params = { - Name = "X", - Type = "number", - }, - { - Name = "Y", - Type = "number", + { + Name = "X", + Type = "number", + }, + { + Name = "Y", + Type = "number", + }, + { + Name = "Z", + Type = "number", + }, + { + Name = "Digger", + Type = "cEntity", + IsOptional = true, + }, }, + Returns = { - Name = "Z", - Type = "number", + { + 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. The optional Digger parameter specifies the entity who dug the block, usually a player. Returns true on success, or false if the chunk is not loaded or invalid coords. See also DropBlockAsPickups() for the version that drops pickups.", }, - Returns = { + Params = { - Type = "boolean", + { + Name = "BlockPos", + Type = "Vector3i", + }, + { + Name = "Digger", + Type = "cEntity", + IsOptional = true, + }, + }, + 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. The optional Digger parameter specifies the entity who dug the block, usually a player. Returns true on success, or false if the chunk is not loaded or invalid coords. See also DropBlockAsPickups() for the version that drops pickups.", }, - 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. See also DropBlockAsPickups() for the version that drops pickups.", }, DoExplosionAt = { diff --git a/src/World.h b/src/World.h index a0e2d0dbc..2ff8fbe29 100644 --- a/src/World.h +++ b/src/World.h @@ -667,14 +667,14 @@ public: /** Replaces the specified block with air, and calls the OnBroken block handler. Wakes up the simulators. Doesn't produce pickups, use DropBlockAsPickups() for that instead. Returns true on success, false if the chunk is not loaded. */ - bool DigBlock(Vector3i a_BlockPos, const cEntity * a_Digger); + bool DigBlock(Vector3i a_BlockPos, const cEntity * a_Digger = nullptr); /** OBSOLETE, use the Vector3-based overload instead. Replaces the specified block with air, and calls the apropriate block handlers (OnBreaking(), OnBroken()). Wakes up the simulators. Doesn't produce pickups, use DropBlockAsPickups() for that instead. Returns true on success, false if the chunk is not loaded. */ - bool DigBlock(int a_X, int a_Y, int a_Z, cEntity * a_Digger) + bool DigBlock(int a_X, int a_Y, int a_Z, cEntity * a_Digger = nullptr) { return DigBlock({a_X, a_Y, a_Z}, a_Digger); } |