@quenty/buttonhighlightmodel 7.5.0 → 7.6.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.
 
+# [7.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/buttonhighlightmodel@7.5.0...@quenty/buttonhighlightmodel@7.6.0) (2022-12-06)
+
+
+### Features
+
+* Add HandleHighlightModel ([94ca0bd](https://github.com/Quenty/NevermoreEngine/commit/94ca0bdf3e6fedbfc25b1a557b895d05823b95b7))
+
+
+
+
+
 # [7.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/buttonhighlightmodel@7.4.0...@quenty/buttonhighlightmodel@7.5.0) (2022-12-05)
 
 **Note:** Version bump only for package @quenty/buttonhighlightmodel

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/buttonhighlightmodel",
-  "version": "7.5.0",
+  "version": "7.6.0",
   "description": "Contains model information for the current button",
   "keywords": [
     "Roblox",
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "3040397f5f4601886ca7a1f664be7019b3941618"
+  "gitHead": "d9b0d10faa443cc42a6c2ac966f2f56d124bbde5"
 }

package/src/Client/HandleHighlightModel.lua

@@ -0,0 +1,116 @@
+--[=[
+	@class HandleHighlightModel
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local UserInputService = game:GetService("UserInputService")
+
+local BaseObject = require("BaseObject")
+local Maid = require("Maid")
+local Blend = require("Blend")
+local Rx = require("Rx")
+
+local HandleHighlightModel = setmetatable({}, BaseObject)
+HandleHighlightModel.ClassName = "HandleHighlightModel"
+HandleHighlightModel.__index = HandleHighlightModel
+
+function HandleHighlightModel.new()
+	local self = setmetatable(BaseObject.new(), HandleHighlightModel)
+
+	self.IsMouseOver = Instance.new("BoolValue")
+	self.IsMouseOver.Value = false
+	self._maid:GiveTask(self.IsMouseOver)
+
+	self.IsMouseDown = Instance.new("BoolValue")
+	self.IsMouseDown.Value = false
+	self._maid:GiveTask(self.IsMouseDown)
+
+	self.IsHighlighted = Instance.new("BoolValue")
+	self.IsHighlighted.Value = false
+	self._maid:GiveTask(self.IsHighlighted)
+
+	self._maid:GiveTask(self.IsMouseDown.Changed:Connect(function()
+		self:_updateHighlighted()
+	end))
+	self._maid:GiveTask(self.IsMouseOver.Changed:Connect(function()
+		self:_updateHighlighted()
+	end))
+	self:_updateHighlighted()
+
+	return self
+end
+
+--[=[
+	Sets the handle for the highlight model.
+	@param handle
+]=]
+function HandleHighlightModel:SetHandle(handle: Instance)
+	assert(typeof(handle) == "Instance" or handle == nil, "Bad handle")
+
+	local maid = Maid.new()
+
+	if handle then
+		maid:GiveTask(handle.MouseButton1Down:Connect(function()
+			self.IsMouseDown.Value = true
+		end))
+		maid:GiveTask(handle.MouseButton1Up:Connect(function()
+			self.IsMouseDown.Value = false
+		end))
+		maid:GiveTask(handle.MouseEnter:Connect(function()
+			self.IsMouseOver.Value = true
+		end))
+		maid:GiveTask(handle.MouseLeave:Connect(function()
+			self.IsMouseOver.Value = false
+		end))
+
+		maid:GiveTask(UserInputService.InputEnded:Connect(function(inputObject)
+			if inputObject.UserInputType == Enum.UserInputType.MouseButton1 then
+				self.IsMouseDown.Value = false
+			end
+		end))
+	end
+
+	self._maid._buttonMaid = maid
+end
+
+
+--[=[
+	Observes how pressed down the button is
+	@return Observable<number>
+]=]
+function HandleHighlightModel:ObservePercentPressed()
+	return Blend.AccelTween(Blend.toPropertyObservable(self.IsMouseDown)
+		:Pipe({
+			Rx.map(function(value)
+				return value and 1 or 0
+			end);
+		}), 200)
+end
+
+--[=[
+	Observes how highlighted the button is
+	@return Observable<number>
+]=]
+function HandleHighlightModel:ObservePercentHighlighted()
+	return Blend.AccelTween(self:ObservePercentHighlightedTarget(), 200)
+end
+
+--[=[
+	Observes target for how highlighted the button is
+	@return Observable<number>
+]=]
+function HandleHighlightModel:ObservePercentHighlightedTarget()
+	return Blend.toPropertyObservable(self.IsHighlighted)
+		:Pipe({
+			Rx.map(function(value)
+				return value and 1 or 0
+			end);
+		})
+end
+
+function HandleHighlightModel:_updateHighlighted()
+	self.IsHighlighted.Value = self.IsMouseOver.Value or self.IsMouseDown.Value
+end
+
+return HandleHighlightModel