summaryrefslogtreecommitdiffstats
path: root/Server/Plugins/APIDump
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Server/Plugins/APIDump/Hooks/OnPlayerCrouched.lua18
1 files changed, 18 insertions, 0 deletions
diff --git a/Server/Plugins/APIDump/Hooks/OnPlayerCrouched.lua b/Server/Plugins/APIDump/Hooks/OnPlayerCrouched.lua
new file mode 100644
index 000000000..51b54705b
--- /dev/null
+++ b/Server/Plugins/APIDump/Hooks/OnPlayerCrouched.lua
@@ -0,0 +1,18 @@
+return
+{
+ HOOK_PLAYER_CROUCHED =
+ {
+ CalledWhen = "Player crouched in the tick being currently processed.",
+ DefaultFnName = "OnPlayerCrouched", -- also used as pagename
+ Desc = [[
+ This function is called in each server tick for each {{cPlayer|player}} that has crouched.
+ ]],
+ Params =
+ {
+ { Name = "Player", Type = "{{cPlayer}}", Notes = "The player who has crouched." },
+ },
+ Returns = [[
+ If the function returns false or no value, other plugins callbacks are called.</p>
+ ]],
+ }, -- HOOK_PLAYER_CROUCHED
+} \ No newline at end of file