aboutsummaryrefslogtreecommitdiff
path: root/gamemode/core/clienteffects/sv_effects.lua
diff options
context:
space:
mode:
authorAlexander Pickering <alexandermpickering@gmail.com>2017-11-08 15:51:26 -0500
committerAlexander Pickering <alexandermpickering@gmail.com>2017-11-08 15:51:26 -0500
commit2252904b8147419c551ad2653a20627281d0531f (patch)
treec1d76a132fa085940dd33d8af99c08dd9da04675 /gamemode/core/clienteffects/sv_effects.lua
parent07593f0c983ac6b16161829b20ea6fde887fa7e9 (diff)
downloadartery-2252904b8147419c551ad2653a20627281d0531f.tar.gz
artery-2252904b8147419c551ad2653a20627281d0531f.tar.bz2
artery-2252904b8147419c551ad2653a20627281d0531f.zip
Finished LDoc comments
Diffstat (limited to 'gamemode/core/clienteffects/sv_effects.lua')
-rw-r--r--gamemode/core/clienteffects/sv_effects.lua8
1 files changed, 8 insertions, 0 deletions
diff --git a/gamemode/core/clienteffects/sv_effects.lua b/gamemode/core/clienteffects/sv_effects.lua
index cc3039f..d364068 100644
--- a/gamemode/core/clienteffects/sv_effects.lua
+++ b/gamemode/core/clienteffects/sv_effects.lua
@@ -1,6 +1,14 @@
+---A way to apply effects on players.
+-- Also see cl_effects.lua
+--@module sv_effects.lua
local ed = {}
+---Apply an effect to the player.
+-- Send a message to a player, saying they should have an effects
+--@tparam player ply The player to apply the effect to
+--@tparam string name The name of the effect to apply
+--@tparam string data Data to send for the effect (can be "")
function ed.SendEffect(ply,name,data)
net.Start("art_clienteffect")
local dlen = #data