@quenty/highlight 2.2.0 → 2.3.0

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [2.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/highlight@2.2.0...@quenty/highlight@2.3.0) (2022-11-04)
+
+
+### Features
+
+* Add ability to clone properties from a source highlight ([66dd191](https://github.com/Quenty/NevermoreEngine/commit/66dd191f103566d15982838b2ceedd16701ec991))
+* Add AnimatedHighlightGroup:HighlightWithTransferredProperties(fromAdornee, toAdornee) ([bd4f3e9](https://github.com/Quenty/NevermoreEngine/commit/bd4f3e9638433264963a0cdeb8ebf0a4ff4ca099))
+
+
+
+
+
 # [2.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/highlight@2.1.1...@quenty/highlight@2.2.0) (2022-10-23)
 
 **Note:** Version bump only for package @quenty/highlight

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/highlight",
-  "version": "2.2.0",
+  "version": "2.3.0",
   "description": "Animated highlight system for the Roblox highlight object",
   "keywords": [
     "Roblox",
@@ -28,7 +28,7 @@
   "dependencies": {
     "@quenty/baseobject": "^6.0.0",
     "@quenty/basicpane": "^7.1.0",
-    "@quenty/blend": "^6.2.0",
+    "@quenty/blend": "^6.3.0",
     "@quenty/enumutils": "^3.0.0",
     "@quenty/instanceutils": "^7.1.0",
     "@quenty/loader": "^6.0.0",
@@ -42,5 +42,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f167412233d2a0bcb7f91bdc6aa2f3c754bdbe79"
+  "gitHead": "1cf7e4838d864bdce2e5751b6c97d38bce29e9a6"
 }

package/src/Client/AnimatedHighlight.lua

@@ -58,6 +58,11 @@ function AnimatedHighlight.new()
 	return self
 end
 
+function AnimatedHighlight.isAnimatedHighlight(value)
+	return type(value) == "table" and
+		getmetatable(value) == AnimatedHighlight
+end
+
 --[=[
 	Sets the depth mode. Either can be:
 
@@ -72,6 +77,27 @@ function AnimatedHighlight:SetHighlightDepthMode(depthMode)
 	self._highlightDepthMode.Value = depthMode
 end
 
+function AnimatedHighlight:SetPropertiesFrom(sourceHighlight)
+	assert(AnimatedHighlight.isAnimatedHighlight(sourceHighlight), "Bad AnimatedHighlight")
+
+	self._highlightDepthMode.Value = sourceHighlight._highlightDepthMode.Value
+	self._fillColor.Value = sourceHighlight._fillColor.Value
+	self._outlineColor.Value = sourceHighlight._outlineColor.Value
+
+	-- well, this can't be very fast...
+	local function transferSpringValue(target, source)
+		target.Speed = source.Speed
+		target.Damper = source.Damper
+		target.Target = source.Target
+		target.Position = source.Position
+		target.Velocity = source.Velocity
+	end
+
+	transferSpringValue(self._fillTransparencySpring, sourceHighlight._fillTransparencySpring)
+	transferSpringValue(self._outlineTransparencySpring, sourceHighlight._outlineTransparencySpring)
+	transferSpringValue(self._percentVisible, sourceHighlight._percentVisible)
+end
+
 function AnimatedHighlight:SetTransparencySpeed(speed)
 	assert(type(speed) == "number", "Bad speed")
 

package/src/Client/AnimatedHighlightGroup.lua

@@ -202,6 +202,20 @@ function AnimatedHighlightGroup:_getOrCreateHighlight(adornee)
 	return highlight
 end
 
+function AnimatedHighlightGroup:HighlightWithTransferredProperties(fromAdornee, toAdornee)
+	assert(typeof(fromAdornee) == "Instance", "Bad fromAdornee")
+	assert(typeof(toAdornee) == "Instance", "Bad toAdornee")
+
+	local source = self._highlights[fromAdornee]
+	if not source then
+		return self:Highlight(toAdornee)
+	end
+
+	local target = self:Highlight(toAdornee)
+	target:SetPropertiesFrom(source)
+	return target
+end
+
 function AnimatedHighlightGroup:_removeHighlight(highlight)
 	self._maid[highlight] = nil
 end