@quenty/guivisiblemanager 8.0.1 → 8.1.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [8.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/guivisiblemanager@8.0.1...@quenty/guivisiblemanager@8.1.0) (2023-02-21)
+
+
+### Features
+
+* Add doNotAnimate support ([e505dfc](https://github.com/Quenty/NevermoreEngine/commit/e505dfce0d9197ec8b1e2f03e69995442bf73caf))
+
+
+
+
+
 ## [8.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/guivisiblemanager@8.0.0...@quenty/guivisiblemanager@8.0.1) (2022-11-04)
 
 **Note:** Version bump only for package @quenty/guivisiblemanager

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/guivisiblemanager",
-  "version": "8.0.1",
+  "version": "8.1.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": "^6.0.1",
-    "@quenty/cancellabledelay": "^3.3.0",
-    "@quenty/loader": "^6.0.1",
+    "@quenty/baseobject": "^6.1.0",
+    "@quenty/cancellabledelay": "^3.4.0",
+    "@quenty/loader": "^6.1.0",
     "@quenty/maid": "^2.4.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8b9877c26a3fc753409a5114e56717837291279d"
+  "gitHead": "e084b0cc097ddbcb7c782b8ecbd9c2d619c49354"
 }

package/src/Client/GuiVisibleManager.lua

@@ -22,7 +22,7 @@ GuiVisibleManager.__index = GuiVisibleManager
 --[=[
 	Constructs a new GuiVisibleManager.
 
-	@param promiseNewPane Promise<TPane> -- Returns a promise for a new pane.
+	@param promiseNewPane (maid: Maid) -> Promise<TPane> -- Returns a promise for a new pane.
 	@param maxHideTime number? -- Optional hide time
 	@return GuiVisibleManager
 ]=]
@@ -32,6 +32,8 @@ function GuiVisibleManager.new(promiseNewPane, maxHideTime)
 	self._maxHideTime = maxHideTime or 1
 	self._promiseNewPane = promiseNewPane or error("No promiseNewPane")
 
+	self._nextDoNotAnimate = false
+
 	self._paneVisible = Instance.new("BoolValue")
 	self._paneVisible.Value = false
 	self._maid:GiveTask(self._paneVisible)
@@ -49,6 +51,7 @@ end
 
 --[=[
 	Returns whether the Gui is visible.
+
 	@return boolean
 ]=]
 function GuiVisibleManager:IsVisible()
@@ -83,15 +86,17 @@ end
 --[=[
 	Creates a handle that will force the gui to be rendered. Clean up the task
 	to stop the showing.
+
+	@param doNotAnimate boolean | nil
 	@return MaidTask
 ]=]
-function GuiVisibleManager:CreateShowHandle()
+function GuiVisibleManager:CreateShowHandle(doNotAnimate)
 	assert(self._showHandles, "Not initialized yet")
 
 	local key = HttpService:GenerateGUID(false)
 
 	self._showHandles[key] = true
-	self:_updatePaneVisible()
+	self:_updatePaneVisible(doNotAnimate)
 
 	return {
 		Destroy = function()
@@ -107,8 +112,12 @@ function GuiVisibleManager:CreateShowHandle()
 	};
 end
 
-function GuiVisibleManager:_updatePaneVisible()
-	self._paneVisible.Value = next(self._showHandles) ~= nil
+function GuiVisibleManager:_updatePaneVisible(doNotAnimate)
+	local nextValue = next(self._showHandles) ~= nil
+	if nextValue ~= self._paneVisible.Value then
+		self._nextDoNotAnimate = doNotAnimate
+		self._paneVisible.Value = nextValue
+	end
 end
 
 function GuiVisibleManager:_onPaneVisibleChanged()
@@ -142,11 +151,14 @@ function GuiVisibleManager:_handleNewPane(maid, pane)
 	maid:GiveTask(pane)
 
 	local function updateVisible()
+		local doNotAnimate = self._nextDoNotAnimate
+		self._nextDoNotAnimate = false
+
 		if self._paneVisible.Value then
-			pane:Show()
+			pane:Show(doNotAnimate)
 			maid._hideTask = nil
 		else
-			pane:Hide()
+			pane:Hide(doNotAnimate)
 
 			-- cleanup after a given amount of time
 			maid._hideTask = cancellableDelay(self._maxHideTime, function()