diff options
| author | Alexander Pickering <alexandermpickering@gmail.com> | 2017-11-08 15:51:26 -0500 |
|---|---|---|
| committer | Alexander Pickering <alexandermpickering@gmail.com> | 2017-11-08 15:51:26 -0500 |
| commit | 2252904b8147419c551ad2653a20627281d0531f (patch) | |
| tree | c1d76a132fa085940dd33d8af99c08dd9da04675 /gamemode/core/clienteffects/cl_effects.lua | |
| parent | 07593f0c983ac6b16161829b20ea6fde887fa7e9 (diff) | |
| download | artery-2252904b8147419c551ad2653a20627281d0531f.tar.gz artery-2252904b8147419c551ad2653a20627281d0531f.tar.bz2 artery-2252904b8147419c551ad2653a20627281d0531f.zip | |
Finished LDoc comments
Diffstat (limited to 'gamemode/core/clienteffects/cl_effects.lua')
| -rw-r--r-- | gamemode/core/clienteffects/cl_effects.lua | 8 |
1 files changed, 8 insertions, 0 deletions
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...") |