Merge branch 'FishingHook'
This commit is contained in:
20
MCServer/Plugins/APIDump/Hooks/OnPlayerFished.lua
Normal file
20
MCServer/Plugins/APIDump/Hooks/OnPlayerFished.lua
Normal file
@@ -0,0 +1,20 @@
|
||||
return
|
||||
{
|
||||
HOOK_PLAYER_FISHED =
|
||||
{
|
||||
CalledWhen = "A player gets a reward from fishing.",
|
||||
DefaultFnName = "OnPlayerFished", -- also used as pagename
|
||||
Desc = [[
|
||||
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.
|
||||
]],
|
||||
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
|
||||
};
|
||||
Reference in New Issue
Block a user