diff options
author | STRWarrior <niels.breuker@hotmail.nl> | 2013-12-31 14:50:46 +0100 |
---|---|---|
committer | STRWarrior <niels.breuker@hotmail.nl> | 2013-12-31 14:50:46 +0100 |
commit | db935c4194b01e754a188473118055fd08e7d450 (patch) | |
tree | 78cab112c6a09b4f025e9803a32764d50639af4f /MCServer/Plugins/APIDump/Hooks | |
parent | Implented OnPlayerFishing and OnPlayerFished. (diff) | |
download | cuberite-db935c4194b01e754a188473118055fd08e7d450.tar cuberite-db935c4194b01e754a188473118055fd08e7d450.tar.gz cuberite-db935c4194b01e754a188473118055fd08e7d450.tar.bz2 cuberite-db935c4194b01e754a188473118055fd08e7d450.tar.lz cuberite-db935c4194b01e754a188473118055fd08e7d450.tar.xz cuberite-db935c4194b01e754a188473118055fd08e7d450.tar.zst cuberite-db935c4194b01e754a188473118055fd08e7d450.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..03ab5bfb9 --- /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 when a player already has his reward from fishing. + ]], + 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, tressure 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 +}
\ No newline at end of file diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerFishing.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerFishing.lua new file mode 100644 index 000000000..1989b02cd --- /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. + ]], + 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, tressure 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 +}
\ No newline at end of file |