1
0
Fork 0

Add missing documentation file.

This commit is contained in:
Alexander Harkness 2020-03-23 12:24:31 +00:00
parent 0a68994f48
commit ad1872f8cc
1 changed files with 18 additions and 0 deletions

View File

@ -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
}