From 211b03a87082c3a99c171326afd79163274d663c Mon Sep 17 00:00:00 2001
From: madmaxoft
Date: Mon, 14 Oct 2013 16:43:39 +0200
Subject: [PATCH] APIDump: Documented HOOK_EXPLODED.
---
MCServer/Plugins/APIDump/APIDesc.lua | 43 ++++++++++++++++++++++++++++
1 file changed, 43 insertions(+)
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index e49c09ec8..0ef93b400 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2401,6 +2401,49 @@ end;
]],
}, -- HOOK_EXECUTE_COMMAND
+ HOOK_EXPLODED =
+ {
+ CalledWhen = "An explosion has happened",
+ DefaultFnName = "OnExploded", -- also used as pagename
+ Desc = [[
+ This hook is called after an explosion has been processed in a world.
+
+ See also {{OnHookExploding|HOOK_EXPLODING}} for a similar hook called before the explosion.
+
+ The explosion carries with it the type of its source - whether it's a creeper exploding, or TNT,
+ etc. It also carries the identification of the actual source. The exact type of the identification
+ depends on the source kind:
+
+ Source | SourceData Type | Notes |
+ esPrimedTNT | {{cTNTEntity}} | An exploding primed TNT entity |
+ esCreeper | {{cCreeper}} | An exploding creeper or charged creeper |
+ esBed | {{Vector3i}} | A bed exploding in the Nether or in the End. The bed coords are given. |
+ esEnderCrystal | {{Vector3i}} | An ender crystal exploding upon hit. The block coords are given. |
+ esGhastFireball | {{cGhastFireballEntity}} | A ghast fireball hitting ground or an {{cEntity|entity}}. |
+ esWitherSkullBlack | TBD | A black wither skull hitting ground or an {{cEntity|entity}}. |
+ esWitherSkullBlue | TBD | A blue wither skull hitting ground or an {{cEntity|entity}}. |
+ esWitherBirth | TBD | A wither boss being created |
+ esOther | TBD | Any other previously unspecified type. |
+ esPlugin | object | An explosion created by a plugin. The plugin may specify any kind of data. |
+
+ ]],
+ Params =
+ {
+ { Name = "World", Type = "{{cWorld}}", Notes = "The world where the explosion happened" },
+ { Name = "ExplosionSize", Type = "number", Notes = "The relative explosion size" },
+ { Name = "CanCauseFire", Type = "bool", Notes = "True if the explosion has turned random air blocks to fire (such as a ghast fireball)" },
+ { Name = "X", Type = "number", Notes = "X-coord of the explosion center" },
+ { Name = "Y", Type = "number", Notes = "Y-coord of the explosion center" },
+ { Name = "Z", Type = "number", Notes = "Z-coord of the explosion center" },
+ { Name = "Source", Type = "eExplosionSource", Notes = "Source of the explosion. See the table above." },
+ { Name = "SourceData", Type = "varies", Notes = "Additional data for the source. The exact type varies by the source. See the table above." },
+ },
+ Returns = [[
+ If the function returns false or no value, the next plugin's callback is called. If the function
+ returns true, no other callback is called for this event. There is no overridable behaviour.
+ ]],
+ }, -- HOOK_EXPLODED
+
}, -- Hooks[]