summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-10-14 21:45:47 +0200
committermadmaxoft <github@xoft.cz>2013-10-14 21:45:47 +0200
commita632f1d579298b2e0222b5f8ce6608c9b062dac4 (patch)
tree4b8c20036a57fcd7bc13dcec3300d2fce67fea6b /MCServer/Plugins
parentAPIDump: Documented HOOK_HOPPER_PUSHING_ITEM. (diff)
downloadcuberite-a632f1d579298b2e0222b5f8ce6608c9b062dac4.tar
cuberite-a632f1d579298b2e0222b5f8ce6608c9b062dac4.tar.gz
cuberite-a632f1d579298b2e0222b5f8ce6608c9b062dac4.tar.bz2
cuberite-a632f1d579298b2e0222b5f8ce6608c9b062dac4.tar.lz
cuberite-a632f1d579298b2e0222b5f8ce6608c9b062dac4.tar.xz
cuberite-a632f1d579298b2e0222b5f8ce6608c9b062dac4.tar.zst
cuberite-a632f1d579298b2e0222b5f8ce6608c9b062dac4.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua27
1 files changed, 27 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 69fcd6eb1..4ea95b4da 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2559,6 +2559,33 @@ end;
]],
}, -- HOOK_HOPPER_PUSHING_ITEM
+ HOOK_KILLING =
+ {
+ CalledWhen = "A player or a mob is dying.",
+ DefaultFnName = "OnKilling", -- also used as pagename
+ Desc = [[
+ This hook is called whenever a {{cPawn|pawn}}'s (a player's or a mob's) health reaches zero. This
+ means that the pawn is about to be killed, unless a plugin "revives" them by setting their health
+ back to a positive value.</p>
+ <p>
+ FIXME: There is no HOOK_KILLED notification hook yet; this is deliberate because HOOK_KILLED has
+ been recently renamed to HOOK_KILLING, and plugins need to be updated. Once updated, the HOOK_KILLED
+ notification will be implemented.
+ ]],
+ Params =
+ {
+ { Name = "Victim", Type = "{{cPawn}}", Notes = "The player or mob that is about to be killed" },
+ { Name = "Killer", Type = "{{cEntity}}", Notes = "The entity that has caused the victim to lose the last point of health. May be nil for environment damage" },
+ },
+ Returns = [[
+ If the function returns false or no value, MCServer calls other plugins with this event. If the
+ function returns true, no other plugin is called for this event.</p>
+ <p>
+ In either case, the victim's health is then re-checked and if it is greater than zero, the victim is
+ "revived" with that health amount. If the health is less or equal to zero, the victim is killed.
+ ]],
+ }, -- HOOK_KILLING
+
}, -- Hooks[]