2013-12-31 14:50:46 +01:00
return
{
HOOK_PLAYER_FISHED =
{
CalledWhen = "A player gets a reward from fishing." ,
DefaultFnName = "OnPlayerFished" , -- also used as pagename
Desc = [[
2014-01-01 15:15:56 +01:00
This hook gets called after a player reels in the fishing rod. This is a notification-only hook, the reward has already been decided. If a plugin needs to modify the reward, use the {{OnPlayerFishing|HOOK_PLAYER_FISHING}} hook.
2013-12-31 14:50:46 +01:00
]] ,
Params =
{
{ Name = "Player" , Type = "{{cPlayer}}" , Notes = "The player who pulled the fish in." },
2014-01-01 15:02:43 +01:00
{ Name = "Reward" , Type = "{{cItems}}" , Notes = "The reward the player gets. It can be a fish, treasure and junk." },
2013-12-31 14:50:46 +01:00
},
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
2014-01-01 15:31:57 +01:00
};