diff options
author | Tycho Bickerstaff <work.tycho@gmail.com> | 2013-12-31 17:32:08 +0100 |
---|---|---|
committer | Tycho Bickerstaff <work.tycho@gmail.com> | 2013-12-31 17:32:08 +0100 |
commit | 7694a0788c796cb08539dcdc3ed4bf9eee3babbf (patch) | |
tree | 78873e56309a8eb45b47de6a2d775763568a5a4e /MCServer/Plugins/APIDump/Hooks/OnPlayerFished.lua | |
parent | fogot to add promise classes (diff) | |
parent | Merge pull request #484 from worktycho/cmake-fixes (diff) | |
download | cuberite-7694a0788c796cb08539dcdc3ed4bf9eee3babbf.tar cuberite-7694a0788c796cb08539dcdc3ed4bf9eee3babbf.tar.gz cuberite-7694a0788c796cb08539dcdc3ed4bf9eee3babbf.tar.bz2 cuberite-7694a0788c796cb08539dcdc3ed4bf9eee3babbf.tar.lz cuberite-7694a0788c796cb08539dcdc3ed4bf9eee3babbf.tar.xz cuberite-7694a0788c796cb08539dcdc3ed4bf9eee3babbf.tar.zst cuberite-7694a0788c796cb08539dcdc3ed4bf9eee3babbf.zip |
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks/OnPlayerFished.lua')
-rw-r--r-- | MCServer/Plugins/APIDump/Hooks/OnPlayerFished.lua | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerFished.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerFished.lua new file mode 100644 index 000000000..4e093f4ae --- /dev/null +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerFished.lua @@ -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 +}; |