cuberite-2a/Server/Plugins/APIDump/Hooks/OnExploding.lua

return
{
	HOOK_EXPLODING =
	{
		CalledWhen = "An explosion is about to be processed",
		DefaultFnName = "OnExploding",  -- also used as pagename
		Desc = [[
			This hook is called before an explosion has been processed in a world.</p>
			<p>
			See also {{OnExploded|HOOK_EXPLODED}} for a similar hook called after the explosion.</p>
			<p>
			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, see the {{Globals#ExplosionSource|esXXX}} constants' descriptions for details
		]],
		Params =
		{
			{ Name = "World", Type = "{{cWorld}}", Notes = "The world where the explosion happens" },
			{ Name = "ExplosionSize", Type = "number", Notes = "The relative explosion size" },
			{ Name = "CanCauseFire", Type = "bool", Notes = "True if the explosion will turn 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 {{Globals#ExplosionSource|esXXX}} constants' description." },
		},
		Returns = [[
			If the function returns false or no value, the next plugin's callback is called, and finally
			Cuberite will process the explosion - destroy blocks and push + hurt entities. If the function
			returns true, no other callback is called for this event and the explosion will not occur.</p>
			<p>
			The hook handler may return up to two more values after the initial bool. The second returned value
			overrides the CanCauseFire parameter for subsequent hook calls and the final explosion, the third
			returned value overrides the ExplosionSize parameter for subsequent hook calls and the final explosion.
		]],
	},  -- HOOK_EXPLODING
}