summaryrefslogblamecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks/OnPlayerFished.lua
blob: 0ad2a3af39a2bef66319a91b38a16927b9fae859 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11
12











                                                                                                                
                                                                                                                                             





                                                                                                                                               
 
return
{
	HOOK_PLAYER_FISHED =
	{
		CalledWhen = "A player gets a reward from fishing.",
		DefaultFnName = "OnPlayerFished", -- also used as pagename
		Desc = [[
			This hook gets called when a player already has his reward from fishing.
		]],
		Params =
		{
			{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player who pulled the fish in." },
			{ Name = "Reward", Type = "{{cItems}}", Notes = "The reward the player gets. It can be a fish, treasure and junk." },
		},
		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.
		]],
	}, -- HOOK_PLAYER_FISHED
};