summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks/OnPlayerFishing.lua
diff options
context:
space:
mode:
authorTycho Bickerstaff <work.tycho@gmail.com>2013-12-31 17:32:08 +0100
committerTycho Bickerstaff <work.tycho@gmail.com>2013-12-31 17:32:08 +0100
commit7694a0788c796cb08539dcdc3ed4bf9eee3babbf (patch)
tree78873e56309a8eb45b47de6a2d775763568a5a4e /MCServer/Plugins/APIDump/Hooks/OnPlayerFishing.lua
parentfogot to add promise classes (diff)
parentMerge pull request #484 from worktycho/cmake-fixes (diff)
downloadcuberite-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/OnPlayerFishing.lua')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnPlayerFishing.lua21
1 files changed, 21 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerFishing.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerFishing.lua
new file mode 100644
index 000000000..c5aaecd92
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerFishing.lua
@@ -0,0 +1,21 @@
+return
+{
+ HOOK_PLAYER_FISHING =
+ {
+ CalledWhen = "A player is about to get a reward from fishing.",
+ DefaultFnName = "OnPlayerFishing", -- also used as pagename
+ Desc = [[
+ This hook gets called when a player right clicks with a fishing rod while the floater is under water. The reward is already descided, but the plugin may change it.
+ ]],
+ 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. Afterwards, the
+ server gives the player his reward. If the function returns true, no other
+ callback is called for this event and the player doesn't get his reward.
+ ]],
+ }, -- HOOK_PLAYER_FISHING
+};