summaryrefslogblamecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua
blob: 8e503658c65646c066db011551d5688f427f8c21 (plain) (tree)






















                                                                                                                                            
return
{
	HOOK_PLAYER_DESTROYED =
	{
		CalledWhen = "A player is about to get destroyed.",
		DefaultFnName = "OnPlayerDestroyed",  -- also used as pagename
		Desc = [[
			This function is called when a {{cPlayer|player}} is about to get destroyed. But the player isn't already destroyed.
		]],
		Params =
		{
			{ Name = "Player", Type = "{{cPlayer}}", Notes = "The destroyed player" },
		},
		Returns = [[
			It's only for notification. Can't be returned.
		]],
	},  -- HOOK_PLAYER_DESTROYED
}