@quenty/screenshothudservice 7.18.2-canary.547.ba47c62.0 → 7.18.3-canary.550.afa1b3b.0

package/CHANGELOG.md

@@ -3,7 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [7.18.2-canary.547.ba47c62.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/screenshothudservice@7.18.0...@quenty/screenshothudservice@7.18.2-canary.547.ba47c62.0) (2025-04-07)
+## [7.18.3-canary.550.afa1b3b.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/screenshothudservice@7.18.2...@quenty/screenshothudservice@7.18.3-canary.550.afa1b3b.0) (2025-04-10)
+
+**Note:** Version bump only for package @quenty/screenshothudservice
+
+
+
+
+
+## [7.18.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/screenshothudservice@7.18.0...@quenty/screenshothudservice@7.18.2) (2025-04-07)
 
 
 ### Bug Fixes

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2024 James Onnen (Quenty)
+Copyright (c) 2014-2025 James Onnen (Quenty)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/screenshothudservice",
-  "version": "7.18.2-canary.547.ba47c62.0",
+  "version": "7.18.3-canary.550.afa1b3b.0",
   "description": "Provides centralized API surface for screenshot hud API",
   "keywords": [
     "Roblox",
@@ -25,20 +25,20 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "10.8.2-canary.547.ba47c62.0",
-    "@quenty/brio": "14.17.2-canary.547.ba47c62.0",
-    "@quenty/instanceutils": "13.17.2-canary.547.ba47c62.0",
-    "@quenty/loader": "10.8.2-canary.547.ba47c62.0",
-    "@quenty/maid": "3.4.2-canary.547.ba47c62.0",
-    "@quenty/promise": "10.10.3-canary.547.ba47c62.0",
-    "@quenty/rx": "13.17.2-canary.547.ba47c62.0",
-    "@quenty/servicebag": "11.11.3-canary.547.ba47c62.0",
-    "@quenty/signal": "7.10.2-canary.547.ba47c62.0",
-    "@quenty/statestack": "14.18.2-canary.547.ba47c62.0",
-    "@quenty/valueobject": "13.17.2-canary.547.ba47c62.0"
+    "@quenty/baseobject": "10.8.3-canary.550.afa1b3b.0",
+    "@quenty/brio": "14.17.3-canary.550.afa1b3b.0",
+    "@quenty/instanceutils": "13.17.3-canary.550.afa1b3b.0",
+    "@quenty/loader": "10.8.3-canary.550.afa1b3b.0",
+    "@quenty/maid": "3.4.3-canary.550.afa1b3b.0",
+    "@quenty/promise": "10.10.4-canary.550.afa1b3b.0",
+    "@quenty/rx": "13.17.3-canary.550.afa1b3b.0",
+    "@quenty/servicebag": "11.11.4-canary.550.afa1b3b.0",
+    "@quenty/signal": "7.10.3-canary.550.afa1b3b.0",
+    "@quenty/statestack": "14.18.3-canary.550.afa1b3b.0",
+    "@quenty/valueobject": "13.17.3-canary.550.afa1b3b.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "ba47c62e32170bf74377b0c658c60b84306dc294"
+  "gitHead": "afa1b3b99b862698c3ab46009497bd507150867c"
 }

package/src/Client/ScreenshotHudModel.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class ScreenshotHudModel
 ]=]
@@ -7,36 +8,45 @@ local require = require(script.Parent.loader).load(script)
 local BaseObject = require("BaseObject")
 local ValueObject = require("ValueObject")
 local Signal = require("Signal")
+local _Observable = require("Observable")
 
 local ScreenshotHudModel = setmetatable({}, BaseObject)
 ScreenshotHudModel.ClassName = "ScreenshotHudModel"
 ScreenshotHudModel.__index = ScreenshotHudModel
 
-function ScreenshotHudModel.new()
-	local self = setmetatable(BaseObject.new(), ScreenshotHudModel)
+export type ScreenshotHudModel = typeof(setmetatable(
+	{} :: {
+		_cameraButtonIcon: ValueObject.ValueObject<string>,
+		_cameraButtonPosition: ValueObject.ValueObject<UDim2>,
+		_closeButtonPosition: ValueObject.ValueObject<UDim2>,
+		_closeWhenScreenshotTaken: ValueObject.ValueObject<boolean>,
+		_experienceNameOverlayEnabled: ValueObject.ValueObject<boolean>,
+		_overlayFont: ValueObject.ValueObject<Enum.Font>,
+		_usernameOverlayEnabled: ValueObject.ValueObject<boolean>,
+		_visible: ValueObject.ValueObject<boolean>,
+		_cameraButtonVisible: ValueObject.ValueObject<boolean>,
+		_closeButtonVisible: ValueObject.ValueObject<boolean>,
+		_keepOpen: ValueObject.ValueObject<boolean>,
+
+		CloseRequested: Signal.Signal<()>,
+	},
+	{} :: typeof({ __index = ScreenshotHudModel })
+)) & BaseObject.BaseObject
+
+function ScreenshotHudModel.new(): ScreenshotHudModel
+	local self: ScreenshotHudModel = setmetatable(BaseObject.new() :: any, ScreenshotHudModel)
 
 	self._cameraButtonIcon = self._maid:Add(ValueObject.new("", "string"))
 
-	self._cameraButtonPosition = ValueObject.new(UDim2.new(0, 0, 0, 0))
-	self._maid:GiveTask(self._cameraButtonPosition)
-
-	self._closeButtonPosition = ValueObject.new(UDim2.new(0, 0, 0, 0))
-	self._maid:GiveTask(self._closeButtonPosition)
-
+	self._cameraButtonPosition = self._maid:Add(ValueObject.new(UDim2.new(0, 0, 0, 0)))
+	self._closeButtonPosition = self._maid:Add(ValueObject.new(UDim2.new(0, 0, 0, 0)))
 	self._closeWhenScreenshotTaken = self._maid:Add(ValueObject.new(false, "boolean"))
-
 	self._experienceNameOverlayEnabled = self._maid:Add(ValueObject.new(false, "boolean"))
-
 	self._overlayFont = self._maid:Add(ValueObject.new(Enum.Font.SourceSans))
-
 	self._usernameOverlayEnabled = self._maid:Add(ValueObject.new(false, "boolean"))
-
 	self._visible = self._maid:Add(ValueObject.new(false, "boolean"))
-
 	self._cameraButtonVisible = self._maid:Add(ValueObject.new(true, "boolean"))
-
 	self._closeButtonVisible = self._maid:Add(ValueObject.new(false, "boolean"))
-
 	self._keepOpen = self._maid:Add(ValueObject.new(true, "boolean"))
 
 	self.CloseRequested = self._maid:Add(Signal.new())
@@ -48,7 +58,7 @@ end
 	Sets whether the close button is visible
 	@param closeButtonVisible boolean
 ]=]
-function ScreenshotHudModel:SetCloseButtonVisible(closeButtonVisible)
+function ScreenshotHudModel.SetCloseButtonVisible(self: ScreenshotHudModel, closeButtonVisible: boolean): ()
 	assert(typeof(closeButtonVisible) == "boolean", "Bad closeButtonVisible")
 
 	self._closeButtonVisible.Value = closeButtonVisible
@@ -58,7 +68,7 @@ end
 	Observes close button visiblity
 	@return Observable<boolean>
 ]=]
-function ScreenshotHudModel:ObserveCloseButtonVisible()
+function ScreenshotHudModel.ObserveCloseButtonVisible(self: ScreenshotHudModel): _Observable.Observable<boolean>
 	return self._closeButtonVisible:Observe()
 end
 
@@ -66,7 +76,7 @@ end
 	Sets whether the camera button is visible
 	@param cameraButtonVisible boolean
 ]=]
-function ScreenshotHudModel:SetCameraButtonVisible(cameraButtonVisible)
+function ScreenshotHudModel.SetCameraButtonVisible(self: ScreenshotHudModel, cameraButtonVisible: boolean): ()
 	assert(typeof(cameraButtonVisible) == "boolean", "Bad cameraButtonVisible")
 
 	self._cameraButtonVisible.Value = cameraButtonVisible
@@ -76,7 +86,7 @@ end
 	Observes camera button visiblity
 	@return Observable<boolean>
 ]=]
-function ScreenshotHudModel:ObserveCameraButtonVisible()
+function ScreenshotHudModel.ObserveCameraButtonVisible(self: ScreenshotHudModel): _Observable.Observable<boolean>
 	return self._cameraButtonVisible:Observe()
 end
 
@@ -84,7 +94,7 @@ end
 	Sets whether we should try to keep the UI open
 	@param keepOpen boolean
 ]=]
-function ScreenshotHudModel:SetKeepOpen(keepOpen)
+function ScreenshotHudModel.SetKeepOpen(self: ScreenshotHudModel, keepOpen: boolean): ()
 	assert(typeof(keepOpen) == "boolean", "Bad keepOpen")
 
 	self._keepOpen.Value = keepOpen
@@ -94,7 +104,7 @@ end
 	Gets whether we should try to keep the UI open
 	@return boolean
 ]=]
-function ScreenshotHudModel:GetKeepOpen()
+function ScreenshotHudModel.GetKeepOpen(self: ScreenshotHudModel): boolean
 	return self._keepOpen.Value
 end
 
@@ -103,7 +113,7 @@ end
 
 	@param visible boolean
 ]=]
-function ScreenshotHudModel:SetVisible(visible: boolean)
+function ScreenshotHudModel.SetVisible(self: ScreenshotHudModel, visible: boolean): ()
 	assert(type(visible) == "boolean", "Bad visible")
 
 	self._visible.Value = visible
@@ -113,7 +123,7 @@ end
 	Sets the close button's position
 	@param position UDim2 | nil
 ]=]
-function ScreenshotHudModel:SetCloseButtonPosition(position)
+function ScreenshotHudModel.SetCloseButtonPosition(self: ScreenshotHudModel, position: UDim2 | nil): ()
 	assert(typeof(position) == "UDim2" or position == nil, "Bad position")
 
 	self._closeButtonPosition.Value = position or UDim2.new(0, 0, 0, 0)
@@ -123,7 +133,7 @@ end
 	Observes the close button's position
 	@return Observable<UDim2>
 ]=]
-function ScreenshotHudModel:ObserveCloseButtonPosition()
+function ScreenshotHudModel.ObserveCloseButtonPosition(self: ScreenshotHudModel): _Observable.Observable<UDim2>
 	return self._closeButtonPosition:Observe()
 end
 
@@ -131,7 +141,7 @@ end
 	Sets the camera button's position
 	@param position UDim2 | nil
 ]=]
-function ScreenshotHudModel:SetCameraButtonPosition(position)
+function ScreenshotHudModel.SetCameraButtonPosition(self: ScreenshotHudModel, position: UDim2 | nil): ()
 	assert(typeof(position) == "UDim2" or position == nil, "Bad position")
 
 	self._cameraButtonPosition.Value = position or UDim2.new(0, 0, 0, 0)
@@ -141,25 +151,25 @@ end
 	Observes the camera button's position
 	@return Observable<UDim2>
 ]=]
-function ScreenshotHudModel:ObserveCameraButtonPosition()
+function ScreenshotHudModel.ObserveCameraButtonPosition(self: ScreenshotHudModel): _Observable.Observable<UDim2>
 	return self._cameraButtonPosition:Observe()
 end
 
 --[=[
 	Sets the overlay font
-	@param overlayFont Font
+	@param overlayFont Enum.Font
 ]=]
-function ScreenshotHudModel:SetOverlayFont(overlayFont)
+function ScreenshotHudModel.SetOverlayFont(self: ScreenshotHudModel, overlayFont: Enum.Font | nil): ()
 	assert(typeof(overlayFont) == "EnumItem" or overlayFont == nil, "Bad overlayFont")
 
-	self._overlayFont.Value = overlayFont
+	self._overlayFont.Value = overlayFont or Enum.Font.SourceSans
 end
 
 --[=[
 	Observes the overlay font
-	@return Observable<Font>
+	@return Observable<Enum.Font>
 ]=]
-function ScreenshotHudModel:ObserveOverlayFont()
+function ScreenshotHudModel.ObserveOverlayFont(self: ScreenshotHudModel): _Observable.Observable<Enum.Font>
 	return self._overlayFont:Observe()
 end
 
@@ -168,7 +178,7 @@ end
 
 	@param icon string?
 ]=]
-function ScreenshotHudModel:SetCameraButtonIcon(icon)
+function ScreenshotHudModel.SetCameraButtonIcon(self: ScreenshotHudModel, icon: string | nil)
 	assert(type(icon) == "string" or icon == nil, "Bad icon")
 
 	self._cameraButtonIcon.Value = icon or ""
@@ -179,7 +189,7 @@ end
 
 	@return Observable<string>
 ]=]
-function ScreenshotHudModel:ObserveCameraButtonIcon()
+function ScreenshotHudModel.ObserveCameraButtonIcon(self: ScreenshotHudModel): _Observable.Observable<string>
 	return self._cameraButtonIcon:Observe()
 end
 
@@ -188,7 +198,7 @@ end
 
 	@param closeWhenScreenshotTaken boolean
 ]=]
-function ScreenshotHudModel:SetCloseWhenScreenshotTaken(closeWhenScreenshotTaken: boolean)
+function ScreenshotHudModel.SetCloseWhenScreenshotTaken(self: ScreenshotHudModel, closeWhenScreenshotTaken: boolean): ()
 	assert(type(closeWhenScreenshotTaken) == "boolean", "Bad closeWhenScreenshotTaken")
 
 	self._closeWhenScreenshotTaken.Value = closeWhenScreenshotTaken
@@ -198,7 +208,7 @@ end
 	Returns whether the model will try to close if a screenshot is taken
 	@return boolean
 ]=]
-function ScreenshotHudModel:GetCloseWhenScreenshotTaken()
+function ScreenshotHudModel.GetCloseWhenScreenshotTaken(self: ScreenshotHudModel): boolean
 	return self._closeWhenScreenshotTaken.Value
 end
 
@@ -206,7 +216,7 @@ end
 	Observes whether a screenshot is taken
 	@return Observable<boolean>
 ]=]
-function ScreenshotHudModel:ObserveCloseWhenScreenshotTaken()
+function ScreenshotHudModel.ObserveCloseWhenScreenshotTaken(self: ScreenshotHudModel): _Observable.Observable<boolean>
 	return self._closeWhenScreenshotTaken:Observe()
 end
 
@@ -214,7 +224,10 @@ end
 	Sets whether to experience name overlay should be enabled
 	@param experienceNameOverlayEnabled boolean
 ]=]
-function ScreenshotHudModel:SetExperienceNameOverlayEnabled(experienceNameOverlayEnabled: boolean)
+function ScreenshotHudModel.SetExperienceNameOverlayEnabled(
+	self: ScreenshotHudModel,
+	experienceNameOverlayEnabled: boolean
+): ()
 	assert(type(experienceNameOverlayEnabled) == "boolean", "Bad experienceNameOverlayEnabled")
 
 	self._experienceNameOverlayEnabled.Value = experienceNameOverlayEnabled
@@ -224,7 +237,9 @@ end
 	Observes whether the experience name overlay is enabled
 	@return Observable<boolean>
 ]=]
-function ScreenshotHudModel:ObserveExperienceNameOverlayEnabled()
+function ScreenshotHudModel.ObserveExperienceNameOverlayEnabled(
+	self: ScreenshotHudModel
+): _Observable.Observable<boolean>
 	return self._experienceNameOverlayEnabled:Observe()
 end
 
@@ -232,7 +247,7 @@ end
 	Sets whether to username overlay should be enabled
 	@param usernameOverlayEnabled boolean
 ]=]
-function ScreenshotHudModel:SetUsernameOverlayEnabled(usernameOverlayEnabled: boolean)
+function ScreenshotHudModel.SetUsernameOverlayEnabled(self: ScreenshotHudModel, usernameOverlayEnabled: boolean): ()
 	assert(type(usernameOverlayEnabled) == "boolean", "Bad usernameOverlayEnabled")
 
 	self._usernameOverlayEnabled.Value = usernameOverlayEnabled
@@ -242,7 +257,7 @@ end
 	Observes whether the username name overlay is enabled
 	@return Observable<boolean>
 ]=]
-function ScreenshotHudModel:ObserveUsernameOverlayEnabled()
+function ScreenshotHudModel.ObserveUsernameOverlayEnabled(self: ScreenshotHudModel): _Observable.Observable<boolean>
 	return self._usernameOverlayEnabled:Observe()
 end
 
@@ -250,15 +265,15 @@ end
 	Observes whilet he model is visible
 	@return Observable<boolean>
 ]=]
-function ScreenshotHudModel:ObserveVisible()
+function ScreenshotHudModel.ObserveVisible(self: ScreenshotHudModel): _Observable.Observable<boolean>
 	return self._visible:Observe()
 end
 
-function ScreenshotHudModel:InternalNotifyVisible(isVisible)
+function ScreenshotHudModel.InternalNotifyVisible(self: ScreenshotHudModel, isVisible: boolean): ()
 	self._visible.Value = isVisible
 end
 
-function ScreenshotHudModel:InternalFireClosedRequested()
+function ScreenshotHudModel.InternalFireClosedRequested(self: ScreenshotHudModel): ()
 	self.CloseRequested:Fire()
 end