summaryrefslogtreecommitdiffstats
path: root/Server/Plugins/APIDump/Hooks/OnPlayerCrouched.lua
blob: 51b54705b1e2429fbeb7079ef454f9637dc02749 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
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
}