aboutsummaryrefslogtreecommitdiff
path: root/gamemode/client
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/client
parent07593f0c983ac6b16161829b20ea6fde887fa7e9 (diff)
downloadartery-2252904b8147419c551ad2653a20627281d0531f.tar.gz
artery-2252904b8147419c551ad2653a20627281d0531f.tar.bz2
artery-2252904b8147419c551ad2653a20627281d0531f.zip
Finished LDoc comments
Diffstat (limited to 'gamemode/client')
-rw-r--r--gamemode/client/cl_inventory.lua11
1 files changed, 8 insertions, 3 deletions
diff --git a/gamemode/client/cl_inventory.lua b/gamemode/client/cl_inventory.lua
index 2135fc4..105f1b3 100644
--- a/gamemode/client/cl_inventory.lua
+++ b/gamemode/client/cl_inventory.lua
@@ -1,6 +1,7 @@
---[[
- Displays the inventory, for more information see /gamemode/shared/inventory.lua
-]]
+---Functions for hiding and showing inventory panels.
+-- Deals with most the the things needed for inventory panels
+--@module cl_inventory.lua
+
--[[
Reserved inventory id's
1 - Equipment
@@ -100,6 +101,8 @@ local function BuildInventory()
CreateSheetTree(clt.known_inventories,initalsheet)
end
+---Shows the player's inventory.
+-- If the player's inventory hasn't been built yet, builds the inventory, then displays it.
function inv.ShowInventory()
--print("qframe is ", qframe)
if not qframe then BuildInventory()
@@ -119,6 +122,8 @@ function inv.ShowInventory()
end,{})
end
+---Hides the players inventory.
+-- If the player's inventory is already hidden, does nothing
function inv.HideInventory()
droppanel:Remove()
state.invopen = false