From dac97826f7d0c9b9135c1a08c4d5f16b61494bd1 Mon Sep 17 00:00:00 2001
From: Mattes D
Date: Wed, 26 Aug 2015 10:58:51 +0200
Subject: Renamed output directory to Server
---
Server/Plugins/APIDump/Hooks/OnTakeDamage.lua | 31 +++++++++++++++++++++++++++
1 file changed, 31 insertions(+)
create mode 100644 Server/Plugins/APIDump/Hooks/OnTakeDamage.lua
(limited to 'Server/Plugins/APIDump/Hooks/OnTakeDamage.lua')
diff --git a/Server/Plugins/APIDump/Hooks/OnTakeDamage.lua b/Server/Plugins/APIDump/Hooks/OnTakeDamage.lua
new file mode 100644
index 000000000..608126f2b
--- /dev/null
+++ b/Server/Plugins/APIDump/Hooks/OnTakeDamage.lua
@@ -0,0 +1,31 @@
+return
+{
+ HOOK_TAKE_DAMAGE =
+ {
+ CalledWhen = "An {{cEntity|entity}} is taking any kind of damage",
+ DefaultFnName = "OnTakeDamage", -- also used as pagename
+ Desc = [[
+ This hook is called when any {{cEntity}} descendant, such as a {{cPlayer|player}} or a
+ {{cMonster|mob}}, takes any kind of damage. The plugins may modify the amount of damage or effects
+ with this hook by editting the {{TakeDamageInfo}} object passed.
+
+ This hook is called after the final damage is calculated, including all the possible weapon
+ {{cEnchantments|enchantments}}, armor protection and potion effects.
+ ]],
+ Params =
+ {
+ { Name = "Receiver", Type = "{{cEntity}} descendant", Notes = "The entity taking damage" },
+ { Name = "TDI", Type = "{{TakeDamageInfo}}", Notes = "The damage type, cause and effects. Plugins may modify this object to alter the final damage applied." },
+ },
+ Returns = [[
+ If the function returns false or no value, other plugins' callbacks are called and then the server
+ applies the final values from the TDI object to Receiver. If the function returns true, no other
+ callbacks are called, and no damage nor effects are applied.
+ ]],
+ }, -- HOOK_TAKE_DAMAGE
+}
+
+
+
+
+
--
cgit v1.2.3