Move hooks docs to their own section

This commit is contained in:
peelz
2022-08-03 21:34:42 -04:00
parent 1bb7843811
commit 897466d295
6 changed files with 88 additions and 30 deletions

View File

@@ -1,7 +1,7 @@
-- luacheck: ignore 111
--[[--
Hooks are basically functions that get called when events happen in-game, like chat messages.
The Hook API allow you to listen to game events and modify the behavior/logic of the game.
]]
-- @code Hook
-- @pragma nostrip
@@ -50,6 +50,13 @@ function Hook.Call(eventName, parameters) end
-- end, Hook.HookMethodType.After)
function Hook.HookMethod(className, methodName, callback) end
--- Hooks
-- @summary
-- Hooks are functions that get called when events happen in-game, e.g. chat messages.
--
-- These can be used with `Hook.Add` and `Hook.Call`.
-- @section hook
--- Game's fixed update rate, gets called normally 60 times a second.
-- @realm shared
function think() end
@@ -248,4 +255,4 @@ function human.CPRSuccess(animController) end
--- Called after the CPR skill check fails.
-- @realm shared
function human.CPRFailed(animController) end
function human.CPRFailed(animController) end