From 2252904b8147419c551ad2653a20627281d0531f Mon Sep 17 00:00:00 2001 From: Alexander Pickering Date: Wed, 8 Nov 2017 15:51:26 -0500 Subject: Finished LDoc comments --- gamemode/core/clienteffects/cl_effects.lua | 8 ++++++++ 1 file changed, 8 insertions(+) (limited to 'gamemode/core/clienteffects/cl_effects.lua') diff --git a/gamemode/core/clienteffects/cl_effects.lua b/gamemode/core/clienteffects/cl_effects.lua index 368c34a..db84b24 100644 --- a/gamemode/core/clienteffects/cl_effects.lua +++ b/gamemode/core/clienteffects/cl_effects.lua @@ -1,7 +1,15 @@ +---A registry of client-side effects. +-- Use this to register effects to be called with sv_effects.lua +--@module cl_effects.lua + local log = nrequire("log.lua") local er = {} --master table of effects local effects = {} +---Register an effect. +-- Registers an effect that can later be applied to the player +--@tparam string name The name of the effect +--@tparam function func The function to call when the effect is applied function er.RegisterEffect(name,func) if effects[name] ~= nil then log.warn("Effect \"" .. name .. "\" already registered, replaceing...") -- cgit v1.2.3-70-g09d2