@quenty/buttonhighlightmodel 14.11.1 → 14.12.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.
 
+# [14.12.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/buttonhighlightmodel@14.11.1...@quenty/buttonhighlightmodel@14.12.0) (2024-11-06)
+
+
+### Bug Fixes
+
+* Include dependency ([2a0752d](https://github.com/Quenty/NevermoreEngine/commit/2a0752d3c9abb23d2c2fcefef1502bbb5906dc25))
+* Mouse scrolling scrolling check ([2742ac4](https://github.com/Quenty/NevermoreEngine/commit/2742ac4a10cf1e852d381231e72153c941e03f88))
+
+
+
+
+
 ## [14.11.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/buttonhighlightmodel@14.11.0...@quenty/buttonhighlightmodel@14.11.1) (2024-11-04)
 
 **Note:** Version bump only for package @quenty/buttonhighlightmodel

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/buttonhighlightmodel",
-  "version": "14.11.1",
+  "version": "14.12.0",
   "description": "Contains model information for the current button",
   "keywords": [
     "Roblox",
@@ -28,15 +28,16 @@
   "dependencies": {
     "@quenty/acceltween": "^2.5.0",
     "@quenty/baseobject": "^10.7.1",
-    "@quenty/blend": "^12.11.1",
+    "@quenty/blend": "^12.12.0",
     "@quenty/loader": "^10.7.1",
     "@quenty/maid": "^3.4.0",
-    "@quenty/rx": "^13.11.1",
+    "@quenty/rectutils": "^1.1.0",
+    "@quenty/rx": "^13.12.0",
     "@quenty/steputils": "^3.5.2",
-    "@quenty/valueobject": "^13.11.1"
+    "@quenty/valueobject": "^13.12.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "01c43a0ddd3c5e0cb2d9027313dbfa9852eedef1"
+  "gitHead": "00e6f71716216dd6ecbc8505ad898a1ab7f72756"
 }

package/src/Client/ButtonHighlightModel.lua

@@ -42,6 +42,8 @@ local Maid = require("Maid")
 local Rx = require("Rx")
 local StepUtils = require("StepUtils")
 local ValueObject = require("ValueObject")
+local RectUtils = require("RectUtils")
+local RxInstanceUtils = require("RxInstanceUtils")
 
 local ButtonHighlightModel = setmetatable({}, BaseObject)
 ButtonHighlightModel.ClassName = "ButtonHighlightModel"
@@ -68,6 +70,11 @@ function ButtonHighlightModel.new(button, onUpdate)
 	self._isKeyDown = self._maid:Add(ValueObject.new(false, "boolean"))
 	self._isHighlighted = self._maid:Add(ValueObject.new(false, "boolean"))
 
+	-- Mouse state
+	self._isMouseOverBasedUponMouseMovement = self._maid:Add(ValueObject.new(false, "boolean"))
+	self._isMouseOverScrollingCheck = self._maid:Add(ValueObject.new(false, "boolean"))
+	self._lastMousePositionForScrollingCheck = self._maid:Add(ValueObject.new(nil))
+
 --[=[
 	@prop InteractionEnabledChanged Signal<boolean>
 	@readonly
@@ -153,7 +160,8 @@ function ButtonHighlightModel:SetButton(button: Instance)
 	if button then
 		maid:GiveTask(button.InputEnded:Connect(function(inputObject)
 			if inputObject.UserInputType == Enum.UserInputType.MouseMovement then
-				self._isMouseOver.Value = false
+				self._lastMousePositionForScrollingCheck.Value = inputObject.Position
+				self._isMouseOverBasedUponMouseMovement.Value = false
 			end
 
 			if inputObject.UserInputType == Enum.UserInputType.MouseButton1 then
@@ -175,7 +183,9 @@ function ButtonHighlightModel:SetButton(button: Instance)
 
 		maid:GiveTask(button.InputBegan:Connect(function(inputObject)
 			if inputObject.UserInputType == Enum.UserInputType.MouseMovement then
-				self._isMouseOver.Value = true
+				self._isMouseOverBasedUponMouseMovement.Value = true
+				self._isMouseOverScrollingCheck.Value = true
+				self._lastMousePositionForScrollingCheck.Value = inputObject.Position
 			end
 
 			if inputObject.UserInputType == Enum.UserInputType.MouseButton1 then
@@ -186,6 +196,25 @@ function ButtonHighlightModel:SetButton(button: Instance)
 				self:_trackTouch(inputObject)
 			end
 		end))
+
+		-- Track until something indicates removal
+		maid:GiveTask(self._isMouseOverBasedUponMouseMovement:ObserveBrio(function(mouseOver)
+			return mouseOver
+		end):Subscribe(function(brio)
+			if brio:IsDead() then
+				return
+			end
+
+			self:_trackIfButtonMovedOutFromMouse(brio:ToMaid(), button)
+		end))
+
+		-- We have to track as long as the mouse hasn't moved
+		maid:GiveTask(Rx.combineLatest({
+			isMouseOverFromInput = self._isMouseOverBasedUponMouseMovement:Observe();
+			isMouseOverScrollingCheck = self._isMouseOverScrollingCheck:Observe();
+		}):Subscribe(function(state)
+			self._isMouseOver.Value = state.isMouseOverFromInput and state.isMouseOverScrollingCheck
+		end))
 	end
 
 	self._maid._buttonMaid = maid
@@ -197,6 +226,44 @@ function ButtonHighlightModel:SetButton(button: Instance)
 	end
 end
 
+function ButtonHighlightModel:_trackIfButtonMovedOutFromMouse(maid, button)
+	maid:GiveTask(button.InputChanged:Connect(function(inputObject)
+		if inputObject.UserInputType == Enum.UserInputType.MouseMovement then
+			self._lastMousePositionForScrollingCheck.Value = inputObject.Position
+		end
+	end))
+
+	maid:GiveTask(Rx.combineLatest({
+		mousePosition = self._lastMousePositionForScrollingCheck:Observe();
+		absolutePosition = RxInstanceUtils.observeProperty(button, "AbsolutePosition");
+		absoluteSize = RxInstanceUtils.observeProperty(button, "AbsoluteSize");
+	}):Pipe({
+		Rx.map(function(state)
+			if not state.mousePosition then
+				return true
+			end
+
+			local area = Rect.new(state.absolutePosition, state.absolutePosition + state.absoluteSize)
+
+			if RectUtils.contains(area, Vector2.new(state.mousePosition.x, state.mousePosition.y)) then
+				return true
+			end
+
+			-- TODO: check rounded corners and rotated guis
+
+			return false
+		end)
+	}):Subscribe(function(state)
+		self._isMouseOverScrollingCheck.Value = state
+	end))
+
+	maid:GiveTask(function()
+		self._isMouseOverScrollingCheck.Value = false
+		self._lastMousePositionForScrollingCheck.Value = nil
+	end)
+
+end
+
 --[=[
 	Gets if the button is pressed
 	@return boolean