@quenty/contentproviderutils 6.3.0 → 6.4.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.
 
+# [6.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/contentproviderutils@6.3.0...@quenty/contentproviderutils@6.4.0) (2023-03-06)
+
+
+### Features
+
+* Add ImageLabelLoaded ([b24af97](https://github.com/Quenty/NevermoreEngine/commit/b24af97b56fb11edd8577598a44bbcacdb31e98e))
+
+
+
+
+
 # [6.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/contentproviderutils@6.2.0...@quenty/contentproviderutils@6.3.0) (2023-03-05)
 
 **Note:** Version bump only for package @quenty/contentproviderutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/contentproviderutils",
-  "version": "6.3.0",
+  "version": "6.4.0",
   "description": "Utility functions to ensure that content is preloaded (wrapping calls in promises)",
   "keywords": [
     "Roblox",
@@ -27,11 +27,16 @@
     "Quenty"
   ],
   "dependencies": {
+    "@quenty/baseobject": "^6.2.0",
+    "@quenty/instanceutils": "^7.8.0",
     "@quenty/loader": "^6.2.0",
-    "@quenty/promise": "^6.3.0"
+    "@quenty/maid": "^2.5.0",
+    "@quenty/promise": "^6.3.0",
+    "@quenty/rx": "^7.7.0",
+    "@quenty/signal": "^2.3.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e62b5eac2e5d9084ab9083f128452dd2d98b6f1a"
+  "gitHead": "ce54e6f72519719e6155643418f2496f30a55f8e"
 }

package/src/Client/ImageLabelLoaded.lua

@@ -0,0 +1,144 @@
+--[=[
+	@class ImageLabelLoaded
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local BaseObject = require("BaseObject")
+local Promise = require("Promise")
+local Signal = require("Signal")
+local Maid = require("Maid")
+local ContentProviderUtils = require("ContentProviderUtils")
+local RxInstanceUtils = require("RxInstanceUtils")
+local Rx = require("Rx")
+
+local ImageLabelLoaded = setmetatable({}, BaseObject)
+ImageLabelLoaded.ClassName = "ImageLabelLoaded"
+ImageLabelLoaded.__index = ImageLabelLoaded
+
+function ImageLabelLoaded.new()
+	local self = setmetatable(BaseObject.new(), ImageLabelLoaded)
+
+	self._isLoaded = Instance.new("BoolValue")
+	self._isLoaded.Value = false
+	self._maid:GiveTask(self._isLoaded)
+
+	self._defaultTimeout = 1
+
+	self._preloadImage = Instance.new("BoolValue")
+	self._preloadImage.Value = true
+	self._maid:GiveTask(self._preloadImage)
+
+	self.ImageChanged = Signal.new()
+	self._maid:GiveTask(self.ImageChanged)
+
+	return self
+end
+
+function ImageLabelLoaded:SetDefaultTimeout(defaultTimeout)
+	assert(type(defaultTimeout) == "number" or defaultTimeout == nil, "Bad defaultTimeout")
+
+	self._defaultTimeout = defaultTimeout
+end
+
+function ImageLabelLoaded:IsLoaded()
+	return self._isLoaded.Value
+end
+
+function ImageLabelLoaded:SetPreloadImage(preloadImage)
+	assert(type(preloadImage) == "boolean", "Bad preloadImage")
+
+	self._preloadImage.Value = preloadImage
+end
+
+function ImageLabelLoaded:PromiseLoaded(timeout)
+	assert(type(timeout) == "number" or timeout == nil, "Bad timeout")
+
+	local originalTimeout = timeout
+	timeout = timeout or self._defaultTimeout
+
+	if self._isLoaded.Value then
+		return Promise.resolved()
+	end
+
+	local promise = Promise.new()
+
+	local maid = Maid.new()
+	self._maid[promise] = maid
+
+	maid:GiveTask(self._isLoaded.Changed:Connect(function()
+		if self._isLoaded.Value then
+			promise:Resolve()
+		end
+	end))
+
+	maid:GiveTask(self.ImageChanged:Connect(function(isVisible)
+		if not isVisible then
+			promise:Reject()
+		end
+	end))
+
+	if timeout then
+		maid:GiveTask(task.delay(timeout, function()
+			if originalTimeout then
+				promise:Reject("[ImageLabelLoaded] - Failed to load image after default timeout time")
+			else
+				promise:Reject()
+			end
+		end))
+	end
+
+	promise:Finally(function()
+		self._maid[promise] = nil
+	end)
+
+	return promise
+end
+
+function ImageLabelLoaded:SetImageLabel(imageLabel)
+	assert(typeof(imageLabel) == "Instance" and imageLabel:IsA("ImageLabel") or imageLabel == nil, "Bad imageLabel")
+	if self._imageLabel == imageLabel then
+		return
+	end
+
+	local maid = Maid.new()
+
+	self._imageLabel = imageLabel
+
+	if self._imageLabel then
+		self._isLoaded.Value = self._imageLabel.IsLoaded
+
+		maid:GiveTask(self._imageLabel:GetPropertyChangedSignal("IsLoaded"):Connect(function()
+			self._isLoaded.Value = self._imageLabel.IsLoaded
+		end))
+
+		-- Setup preloading as necessary
+		maid:GiveTask(RxInstanceUtils.observeProperty(self._preloadImage, "Value"):Pipe({
+			Rx.switchMap(function(preload)
+				if preload then
+					return Rx.combineLatest({
+						isLoaded = RxInstanceUtils.observeProperty(self._isLoaded, "Value");
+						image = RxInstanceUtils.observeProperty(self._imageLabel, "Image");
+					})
+				else
+					return Rx.EMPTY
+				end
+			end);
+		}):Subscribe(function(state)
+			if not state.isLoaded and state.image ~= "" then
+				maid:GivePromise(ContentProviderUtils.promisePreload({self._imageLabel}))
+					:Then(function()
+						self._isLoaded.Value = true
+					end)
+			end
+		end))
+	else
+		self._isLoaded.Value = false
+	end
+
+	self.ImageChanged:Fire()
+
+	self._maid._imageLabelMaid = maid
+end
+
+return ImageLabelLoaded