@quenty/guivisiblemanager 4.2.0 → 4.3.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/guivisiblemanager@4.2.1...@quenty/guivisiblemanager@4.3.0) (2022-01-17)
+
+**Note:** Version bump only for package @quenty/guivisiblemanager
+
+
+
+
+
+## [4.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/guivisiblemanager@4.2.0...@quenty/guivisiblemanager@4.2.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/guivisiblemanager
+
+
+
+
+
 # [4.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/guivisiblemanager@4.1.0...@quenty/guivisiblemanager@4.2.0) (2022-01-07)
 
 **Note:** Version bump only for package @quenty/guivisiblemanager

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/guivisiblemanager",
-  "version": "4.2.0",
+  "version": "4.3.0",
   "description": "Help manage the visibility of GUIs while only constructing the Gui while visible",
   "keywords": [
     "Roblox",
@@ -25,13 +25,13 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^3.4.0",
+    "@quenty/baseobject": "^3.5.0",
     "@quenty/cancellabledelay": "^2.2.0",
-    "@quenty/loader": "^3.3.0",
-    "@quenty/maid": "^2.0.2"
+    "@quenty/loader": "^3.4.0",
+    "@quenty/maid": "^2.1.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5a3f3fb6c908fd3874f5ceacc70b404780275119"
+  "gitHead": "c094ba8f4e128cdff08919d89de226d3d65247ce"
 }

package/src/Client/GuiVisibleManager.lua

@@ -1,5 +1,7 @@
 --[=[
 	Help manage the visibility of GUIs while only constructing the Gui while visible
+
+	@client
 	@class GuiVisibleManager
 ]=]
 
@@ -15,8 +17,13 @@ local GuiVisibleManager = setmetatable({}, BaseObject)
 GuiVisibleManager.ClassName = "GuiVisibleManager"
 GuiVisibleManager.__index = GuiVisibleManager
 
--- @param promiseNewPane Returns a promise for a new pane.
--- @param[opt=1] maxHideTime
+--[=[
+	Constructs a new GuiVisibleManager.
+
+	@param promiseNewPane Promise<TPane> -- Returns a promise for a new pane.
+	@param maxHideTime number? -- Optional hide time
+	@return GuiVisibleManager
+]=]
 function GuiVisibleManager.new(promiseNewPane, maxHideTime)
 	local self = setmetatable(BaseObject.new(), GuiVisibleManager)
 
@@ -38,11 +45,20 @@ function GuiVisibleManager.new(promiseNewPane, maxHideTime)
 	return self
 end
 
-
+--[=[
+	Returns whether the Gui is visible.
+	@return boolean
+]=]
 function GuiVisibleManager:IsVisible()
 	return self._paneVisible.Value
 end
 
+--[=[
+	Binds visiblity to the bool value being true. There could be other ways
+	that the Gui is shown if this is not set.
+
+	@param boolValue BoolValue
+]=]
 function GuiVisibleManager:BindToBoolValue(boolValue)
 	assert(boolValue, "Must have boolValue")
 	assert(not self._boundBoolValue, "Already bound")
@@ -62,6 +78,11 @@ function GuiVisibleManager:BindToBoolValue(boolValue)
 	end
 end
 
+--[=[
+	Creates a handle that will force the gui to be rendered. Clean up the task
+	to stop the showing.
+	@return MaidTask
+]=]
 function GuiVisibleManager:CreateShowHandle()
 	assert(self._showHandles, "Not initialized yet")
 
@@ -139,5 +160,4 @@ function GuiVisibleManager:_handleNewPane(maid, pane)
 	updateVisible()
 end
 
-
 return GuiVisibleManager