From ad1872f8cc59162a48cdb26fdd1dc8d1f8e6f15b Mon Sep 17 00:00:00 2001 From: Alexander Harkness Date: Mon, 23 Mar 2020 12:24:31 +0000 Subject: Add missing documentation file. --- Server/Plugins/APIDump/Hooks/OnPlayerCrouched.lua | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 Server/Plugins/APIDump/Hooks/OnPlayerCrouched.lua 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.

+ ]], + }, -- HOOK_PLAYER_CROUCHED +} \ No newline at end of file -- cgit v1.2.3