path: root/Server/Plugins/APIDump/Hooks/OnPlayerRightClickingEntity.lua

return
{
	HOOK_PLAYER_RIGHT_CLICKING_ENTITY =
	{
		CalledWhen = "A player has right-clicked an entity. Plugins may override / refuse.",
		DefaultFnName = "OnPlayerRightClickingEntity",  -- also used as pagename
		Desc = [[
			This hook is called when the {{cPlayer|player}} right-clicks an {{cEntity|entity}}. Plugins may
			override the default behavior or even cancel the default processing.
		]],
		Params =
		{
			{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player who has right-clicked the entity" },
			{ Name = "Entity", Type = "{{cEntity}} descendant", Notes = "The entity that has been right-clicked" },
		},
		Returns = [[
			If the functino returns false or no value, Cuberite calls other plugins' callbacks and finally does
			the default processing for the right-click. If the function returns true, no other callbacks are
			called and the default processing is skipped.
		]],
	},  -- HOOK_PLAYER_RIGHT_CLICKING_ENTITY
}