@quenty/highlight 10.21.0 → 10.21.2-canary.547.11ae689.0

package/CHANGELOG.md

@@ -3,6 +3,29 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [10.21.2-canary.547.11ae689.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/highlight@10.21.0...@quenty/highlight@10.21.2-canary.547.11ae689.0) (2025-04-07)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+* Bump package versions for republishing ([ba47c62](https://github.com/Quenty/NevermoreEngine/commit/ba47c62e32170bf74377b0c658c60b84306dc294))
+
+
+
+
+
+## [10.21.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/highlight@10.21.0...@quenty/highlight@10.21.1) (2025-04-07)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [10.21.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/highlight@10.20.4...@quenty/highlight@10.21.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/highlight

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/highlight",
-  "version": "10.21.0",
+  "version": "10.21.2-canary.547.11ae689.0",
   "description": "Animated highlight system for the Roblox highlight object",
   "keywords": [
     "Roblox",
@@ -26,25 +26,25 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/basicpane": "^13.17.0",
-    "@quenty/blend": "^12.18.0",
-    "@quenty/ducktype": "^5.8.1",
-    "@quenty/enumutils": "^3.4.0",
-    "@quenty/instanceutils": "^13.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/math": "^2.7.1",
-    "@quenty/observablecollection": "^12.20.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/selectionutils": "^8.17.0",
-    "@quenty/signal": "^7.10.0",
-    "@quenty/statestack": "^14.18.0",
-    "@quenty/table": "^3.7.1",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/baseobject": "10.8.2-canary.547.11ae689.0",
+    "@quenty/basicpane": "13.17.2-canary.547.11ae689.0",
+    "@quenty/blend": "12.18.2-canary.547.11ae689.0",
+    "@quenty/ducktype": "5.8.3-canary.547.11ae689.0",
+    "@quenty/enumutils": "3.4.2-canary.547.11ae689.0",
+    "@quenty/instanceutils": "13.17.2-canary.547.11ae689.0",
+    "@quenty/loader": "10.8.2-canary.547.11ae689.0",
+    "@quenty/maid": "3.4.2-canary.547.11ae689.0",
+    "@quenty/math": "2.7.3-canary.547.11ae689.0",
+    "@quenty/observablecollection": "12.20.2-canary.547.11ae689.0",
+    "@quenty/rx": "13.17.2-canary.547.11ae689.0",
+    "@quenty/selectionutils": "8.17.2-canary.547.11ae689.0",
+    "@quenty/signal": "7.10.2-canary.547.11ae689.0",
+    "@quenty/statestack": "14.18.2-canary.547.11ae689.0",
+    "@quenty/table": "3.7.3-canary.547.11ae689.0",
+    "@quenty/valueobject": "13.17.2-canary.547.11ae689.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "11ae6894c9c40c596e521dc1d2a71977af63752f"
 }

package/src/Client/AnimatedHighlight.lua

@@ -51,7 +51,13 @@ function AnimatedHighlight.new()
 	return self
 end
 
-function AnimatedHighlight.isAnimatedHighlight(value)
+--[=[
+	Returns true if it's an animated highlight
+
+	@param value any
+	@return boolean
+]=]
+function AnimatedHighlight.isAnimatedHighlight(value: any): boolean
 	return DuckTypeUtils.isImplementation(AnimatedHighlight, value)
 end
 
@@ -93,27 +99,27 @@ function AnimatedHighlight:SetPropertiesFrom(sourceHighlight)
 	transferSpringValue(self._percentVisible, sourceHighlight._percentVisible)
 end
 
-function AnimatedHighlight:SetTransparencySpeed(speed)
+function AnimatedHighlight:SetTransparencySpeed(speed: number)
 	assert(type(speed) == "number", "Bad speed")
 
 	self._fillTransparencySpring.Speed = speed
 	self._outlineTransparencySpring.Speed = speed
 end
 
-function AnimatedHighlight:SetColorSpeed(speed)
+function AnimatedHighlight:SetColorSpeed(speed: number)
 	assert(type(speed) == "number", "Bad speed")
 
 	self._fillColorSpring.Speed = speed
 	self._outlineColorSpring.Speed = speed
 end
 
-function AnimatedHighlight:SetSpeed(speed)
+function AnimatedHighlight:SetSpeed(speed: number)
 	assert(type(speed) == "number", "Bad speed")
 
 	self._percentVisible.Speed = speed
 end
 
-function AnimatedHighlight:Finish(doNotAnimate, callback)
+function AnimatedHighlight:Finish(doNotAnimate: boolean?, callback)
 	if self._percentVisible.p == 0 and self._percentVisible.v == 0 then
 		callback()
 		return
@@ -150,9 +156,9 @@ end
 	Sets the fill color
 
 	@param color Color3
-	@param doNotAnimate boolean | nil
+	@param doNotAnimate boolean?
 ]=]
-function AnimatedHighlight:SetFillColor(color, doNotAnimate)
+function AnimatedHighlight:SetFillColor(color: Color3, doNotAnimate: boolean?)
 	assert(typeof(color) == "Color3", "Bad color")
 
 	self._fillColorSpring:SetTarget(color, doNotAnimate)
@@ -162,21 +168,28 @@ end
 	Sets the outline color
 
 	@param color Color3
-	@param doNotAnimate boolean | nil
+	@param doNotAnimate boolean?
 ]=]
-function AnimatedHighlight:SetOutlineColor(color, doNotAnimate)
+function AnimatedHighlight:SetOutlineColor(color: Color3, doNotAnimate: boolean?)
 	assert(typeof(color) == "Color3", "Bad color")
 
 	self._outlineColorSpring:SetTarget(color, doNotAnimate)
 end
 
-function AnimatedHighlight:SetAdornee(adornee)
+--[=[
+	Sets the adornee
+]=]
+function AnimatedHighlight:SetAdornee(adornee: Instance?)
 	assert(typeof(adornee) == "Instance" or adornee == nil, "Bad adornee")
 
 	self._adornee.Value = adornee
 end
 
-function AnimatedHighlight:GetAdornee()
+--[=[
+	Gets the adornee
+	@return Instance?
+]=]
+function AnimatedHighlight:GetAdornee(): Instance?
 	return self._adornee.Value
 end
 
@@ -184,9 +197,9 @@ end
 	Sets the outlineTransparency
 
 	@param outlineTransparency number
-	@param doNotAnimate boolean | nil
+	@param doNotAnimate boolean?
 ]=]
-function AnimatedHighlight:SetOutlineTransparency(outlineTransparency, doNotAnimate)
+function AnimatedHighlight:SetOutlineTransparency(outlineTransparency: number, doNotAnimate: boolean?)
 	assert(type(outlineTransparency) == "number", "Bad outlineTransparency")
 
 	self._outlineTransparencySpring.Target = outlineTransparency
@@ -200,9 +213,9 @@ end
 	Sets the fillTransparency
 
 	@param fillTransparency number
-	@param doNotAnimate boolean | nil
+	@param doNotAnimate boolean?
 ]=]
-function AnimatedHighlight:SetFillTransparency(fillTransparency, doNotAnimate)
+function AnimatedHighlight:SetFillTransparency(fillTransparency: number, doNotAnimate: boolean?)
 	assert(type(fillTransparency) == "number", "Bad fillTransparency")
 
 	self._fillTransparencySpring.Target = fillTransparency
@@ -223,13 +236,13 @@ function AnimatedHighlight:_render()
 			self._fillTransparencySpring:ObserveRenderStepped(),
 			self._percentVisible:ObserveRenderStepped(),
 			function(transparency, visible)
-				return Math.map(visible, 0, 1, 1, transparency);
+				return Math.map(visible, 0, 1, 1, transparency)
 			end);
 		OutlineTransparency = Blend.Computed(
 			self._outlineTransparencySpring:ObserveRenderStepped(),
 			self._percentVisible:ObserveRenderStepped(),
 			function(transparency, visible)
-				return Math.map(visible, 0, 1, 1, transparency);
+				return Math.map(visible, 0, 1, 1, transparency)
 			end);
 		Adornee = self._adornee;
 		Parent = self._adornee;

package/src/Client/AnimatedHighlightGroup.lua

@@ -42,25 +42,25 @@ end
 
 	@param depthMode Enum.HighlightDepthMode
 ]=]
-function AnimatedHighlightGroup:SetDefaultHighlightDepthMode(depthMode)
+function AnimatedHighlightGroup:SetDefaultHighlightDepthMode(depthMode: Enum.HighlightDepthMode)
 	assert(EnumUtils.isOfType(Enum.HighlightDepthMode, depthMode))
 
 	self._defaultValues:SetHighlightDepthMode(depthMode)
 end
 
-function AnimatedHighlightGroup:SetDefaultFillTransparency(transparency)
+function AnimatedHighlightGroup:SetDefaultFillTransparency(transparency: number)
 	assert(type(transparency) == "number", "Bad transparency")
 
 	self._defaultValues:SetFillTransparency(transparency)
 end
 
-function AnimatedHighlightGroup:SetDefaultOutlineTransparency(outlineTransparency)
+function AnimatedHighlightGroup:SetDefaultOutlineTransparency(outlineTransparency: number)
 	assert(type(outlineTransparency) == "number", "Bad outlineTransparency")
 
 	self._defaultValues:SetOutlineTransparency(outlineTransparency)
 end
 
-function AnimatedHighlightGroup:SetDefaultFillColor(color)
+function AnimatedHighlightGroup:SetDefaultFillColor(color: Color3)
 	assert(typeof(color) == "Color3", "Bad color")
 
 	self._defaultValues:SetFillColor(color)
@@ -70,19 +70,19 @@ function AnimatedHighlightGroup:GetDefaultFillColor()
 	return self._defaultValues:GetFillColor()
 end
 
-function AnimatedHighlightGroup:SetDefaultOutlineColor(color)
+function AnimatedHighlightGroup:SetDefaultOutlineColor(color: Color3)
 	assert(typeof(color) == "Color3", "Bad color")
 
 	self._defaultValues:SetOutlineColor(color)
 end
 
-function AnimatedHighlightGroup:SetDefaultTransparencySpeed(speed)
+function AnimatedHighlightGroup:SetDefaultTransparencySpeed(speed: number)
 	assert(type(speed) == "number", "Bad speed")
 
 	self._defaultValues:SetTransparencySpeed(speed)
 end
 
-function AnimatedHighlightGroup:SetDefaultSpeed(speed)
+function AnimatedHighlightGroup:SetDefaultSpeed(speed: number)
 	assert(type(speed) == "number", "Bad speed")
 
 	self._defaultValues:SetSpeed(speed)
@@ -99,7 +99,7 @@ end
 	@param observeScore number
 	@return AnimatedHighlightModel
 ]=]
-function AnimatedHighlightGroup:Highlight(adornee, observeScore)
+function AnimatedHighlightGroup:Highlight(adornee: Instance, observeScore)
 	observeScore = observeScore or Rx.of(0)
 
 	if type(observeScore) == "number" then
@@ -112,7 +112,7 @@ function AnimatedHighlightGroup:Highlight(adornee, observeScore)
 	return self:_getOrCreateHighlightStackHandle(adornee, observeScore)
 end
 
-function AnimatedHighlightGroup:_setDefaultValues(highlight, doNotAnimate)
+function AnimatedHighlightGroup:_setDefaultValues(highlight, doNotAnimate: boolean?)
 	highlight:SetHighlightDepthMode(self._defaultValues.HighlightDepthMode.Value)
 	highlight:SetTransparencySpeed(self._defaultValues.TransparencySpeed.Value)
 	highlight:SetSpeed(self._defaultValues.Speed.Value)

package/src/Client/HighlightServiceClient.lua

@@ -8,6 +8,7 @@ local require = require(script.Parent.loader).load(script)
 
 local AnimatedHighlightGroup = require("AnimatedHighlightGroup")
 local Maid = require("Maid")
+local _ServiceBag = require("ServiceBag")
 
 local HighlightServiceClient = {}
 HighlightServiceClient.ServiceName = "HighlightServiceClient"
@@ -17,7 +18,7 @@ HighlightServiceClient.ServiceName = "HighlightServiceClient"
 
 	@param serviceBag ServiceBag
 ]=]
-function HighlightServiceClient:Init(serviceBag)
+function HighlightServiceClient:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
@@ -39,7 +40,7 @@ end
 	Highlights an instance at the given priority
 
 	@param adornee Instance
-	@param observeScore Observable<number> | number | nil
+	@param observeScore Observable<number> | number?
 	@return AnimatedHighlightModel
 ]=]
 function HighlightServiceClient:Highlight(adornee, observeScore)

package/src/Client/Stack/AnimatedHighlightModel.lua

@@ -49,14 +49,14 @@ end
 	@param value any
 	@return boolean
 ]=]
-function AnimatedHighlightModel.isAnimatedHighlightModel(value)
+function AnimatedHighlightModel.isAnimatedHighlightModel(value: any): boolean
 	return DuckTypeUtils.isImplementation(AnimatedHighlightModel, value)
 end
 
 --[=[
 	@param depthMode HighlightDepthMode
 ]=]
-function AnimatedHighlightModel:SetHighlightDepthMode(depthMode)
+function AnimatedHighlightModel:SetHighlightDepthMode(depthMode: Enum.HighlightDepthMode?)
 	assert(EnumUtils.isOfType(Enum.HighlightDepthMode, depthMode) or depthMode == nil, "Bad depthMode")
 
 	self.HighlightDepthMode.Value = depthMode
@@ -65,9 +65,9 @@ end
 --[=[
 	Sets the transparency speed
 
-	@param speed number | nil
+	@param speed number?
 ]=]
-function AnimatedHighlightModel:SetTransparencySpeed(speed)
+function AnimatedHighlightModel:SetTransparencySpeed(speed: number?)
 	assert(type(speed) == "number" or speed == nil, "Bad speed")
 
 	self.TransparencySpeed:SetValue(speed)
@@ -76,21 +76,20 @@ end
 --[=[
 	Sets the color speed
 
-	@param speed number | nil
+	@param speed number?
 ]=]
-function AnimatedHighlightModel:SetColorSpeed(speed)
+function AnimatedHighlightModel:SetColorSpeed(speed: number?)
 	assert(type(speed) == "number" or speed == nil, "Bad speed")
 
 	self.ColorSpeed:SetValue(speed)
 end
 
-
 --[=[
 	Sets the visiblity speed speed
 
-	@param speed number | nil
+	@param speed number?
 ]=]
-function AnimatedHighlightModel:SetSpeed(speed)
+function AnimatedHighlightModel:SetSpeed(speed: number?)
 	assert(type(speed) == "number" or speed == nil, "Bad speed")
 
 	self.Speed:SetValue(speed)
@@ -99,10 +98,10 @@ end
 --[=[
 	Sets fill color
 
-	@param color Color3 | nil
-	@param doNotAnimate boolean | nil
+	@param color Color3?
+	@param doNotAnimate boolean?
 ]=]
-function AnimatedHighlightModel:SetFillColor(color, doNotAnimate)
+function AnimatedHighlightModel:SetFillColor(color: Color3?, doNotAnimate: boolean?)
 	assert(typeof(color) == "Color3" or color == nil, "Bad color")
 
 	self.FillColor:SetValue(color, doNotAnimate)
@@ -111,19 +110,19 @@ end
 --[=[
 	Gets the fill color
 
-	@return Color3 | nil
+	@return Color3?
 ]=]
-function AnimatedHighlightModel:GetFillColor()
+function AnimatedHighlightModel:GetFillColor(): Color3?
 	return self.FillColor.Value
 end
 
 --[=[
 	Sets the outline color
 
-	@param color Color3 | nil
-	@param doNotAnimate boolean | nil
+	@param color Color3?
+	@param doNotAnimate boolean?
 ]=]
-function AnimatedHighlightModel:SetOutlineColor(color, doNotAnimate)
+function AnimatedHighlightModel:SetOutlineColor(color: Color3?, doNotAnimate: boolean?)
 	assert(typeof(color) == "Color3" or color == nil, "Bad color")
 
 	self.OutlineColor:SetValue(color, doNotAnimate)
@@ -132,7 +131,7 @@ end
 --[=[
 	Gets the outline color
 
-	@return Color3 | nil
+	@return Color3?
 ]=]
 function AnimatedHighlightModel:GetOutlineColor()
 	return self.OutlineColor.Value
@@ -142,9 +141,9 @@ end
 	Sets the outline transparency
 
 	@param outlineTransparency number
-	@param doNotAnimate boolean | nil
+	@param doNotAnimate boolean?
 ]=]
-function AnimatedHighlightModel:SetOutlineTransparency(outlineTransparency, doNotAnimate)
+function AnimatedHighlightModel:SetOutlineTransparency(outlineTransparency: number?, doNotAnimate: boolean?)
 	assert(type(outlineTransparency) == "number" or outlineTransparency == nil, "Bad outlineTransparency")
 
 	self.OutlineTransparency:SetValue(outlineTransparency, doNotAnimate)
@@ -154,9 +153,9 @@ end
 	Sets the fill transparency
 
 	@param fillTransparency number
-	@param doNotAnimate boolean | nil
+	@param doNotAnimate boolean?
 ]=]
-function AnimatedHighlightModel:SetFillTransparency(fillTransparency, doNotAnimate)
+function AnimatedHighlightModel:SetFillTransparency(fillTransparency: number?, doNotAnimate: boolean?)
 	assert(type(fillTransparency) == "number" or fillTransparency == nil, "Bad fillTransparency")
 
 	self.FillTransparency:SetValue(fillTransparency, doNotAnimate)