diff options
author | madmaxoft <github@xoft.cz> | 2014-01-01 15:31:57 +0100 |
---|---|---|
committer | madmaxoft <github@xoft.cz> | 2014-01-01 15:31:57 +0100 |
commit | d4e29a0d183151ecdb5b9c8e710c810802c9f35b (patch) | |
tree | 75b116fe37cdb6c389339d5eccc4a4939e28df2d /MCServer/Plugins/APIDump | |
parent | Merge pull request #497 from xdot/master (diff) | |
parent | Little more documentation for OnPlayerFishing. (diff) | |
download | cuberite-d4e29a0d183151ecdb5b9c8e710c810802c9f35b.tar cuberite-d4e29a0d183151ecdb5b9c8e710c810802c9f35b.tar.gz cuberite-d4e29a0d183151ecdb5b9c8e710c810802c9f35b.tar.bz2 cuberite-d4e29a0d183151ecdb5b9c8e710c810802c9f35b.tar.lz cuberite-d4e29a0d183151ecdb5b9c8e710c810802c9f35b.tar.xz cuberite-d4e29a0d183151ecdb5b9c8e710c810802c9f35b.tar.zst cuberite-d4e29a0d183151ecdb5b9c8e710c810802c9f35b.zip |
Diffstat (limited to '')
-rw-r--r-- | MCServer/Plugins/APIDump/Hooks/OnPlayerFished.lua | 20 | ||||
-rw-r--r-- | MCServer/Plugins/APIDump/Hooks/OnPlayerFishing.lua | 21 |
2 files changed, 41 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 +}; 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 +}; |