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/client/cl_inventory.lua | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'gamemode/client') 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 -- cgit v1.2.3-70-g09d2