@quenty/buttonhighlightmodel 3.2.1-canary.8533eea.0 → 3.3.1

package/CHANGELOG.md

@@ -3,12 +3,20 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [3.2.1-canary.8533eea.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/buttonhighlightmodel@3.2.0...@quenty/buttonhighlightmodel@3.2.1-canary.8533eea.0) (2021-12-18)
+## [3.3.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/buttonhighlightmodel@3.3.0...@quenty/buttonhighlightmodel@3.3.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/buttonhighlightmodel
+
+
+
+
+
+# [3.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/buttonhighlightmodel@3.2.0...@quenty/buttonhighlightmodel@3.3.0) (2021-12-18)
 
 
 ### Features
 
-* ButtonHighlightModel can act as a model for Blend ([1aa7796](https://github.com/Quenty/NevermoreEngine/commit/1aa7796ca4f3b0397966dfd605545219172e1339))
+* ButtonHighlightModel can act as a model for Blend ([d881413](https://github.com/Quenty/NevermoreEngine/commit/d88141307fe27a2976d9f93a70badab8b612df5e))
 
 
 

package/README.md

@@ -1,10 +1,10 @@
 ## ButtonHighlightModel
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
@@ -13,21 +13,9 @@
 
 Contains model information for the current button
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ButtonHighlightModel">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/buttonhighlightmodel --save
 ```
-
-## Usage
-Usage is designed to be simple.
-
-### `ButtonHighlightModel.new(button, onUpdate)`
-
-### `ButtonHighlightModel:IsInteractionEnabled()`
-
-### `ButtonHighlightModel:SetKeyDown(isKeyDown)`
-
-### `ButtonHighlightModel:SetInteractionEnabled(interactionEnabled)`
-
-### `ButtonHighlightModel:SetIsChoosen(isChoosen)`
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/buttonhighlightmodel",
-  "version": "3.2.1-canary.8533eea.0",
+  "version": "3.3.1",
   "description": "Contains model information for the current button",
   "keywords": [
     "Roblox",
@@ -26,15 +26,15 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/acceltween": "2.0.0",
-    "@quenty/baseobject": "3.2.0",
-    "@quenty/loader": "3.1.1",
-    "@quenty/maid": "2.0.1",
-    "@quenty/rx": "3.4.1-canary.8533eea.0",
-    "@quenty/steputils": "3.0.0"
+    "@quenty/acceltween": "^2.0.1",
+    "@quenty/baseobject": "^3.2.1",
+    "@quenty/loader": "^3.1.2",
+    "@quenty/maid": "^2.0.2",
+    "@quenty/rx": "^3.5.1",
+    "@quenty/steputils": "^3.0.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8533eeade3bf6835c0295785c1c326b9abee3222"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Client/ButtonHighlightModel.lua

@@ -1,6 +1,7 @@
---- Contains model information for the current button
--- @classmod ButtonHighlightModel
--- @author Quenty
+--[=[
+	Contains model information for the current button
+	@class ButtonHighlightModel
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -15,22 +16,40 @@ local ButtonHighlightModel = setmetatable({}, BaseObject)
 ButtonHighlightModel.ClassName = "ButtonHighlightModel"
 ButtonHighlightModel.__index = ButtonHighlightModel
 
+--[=[
+	A model that dictates the current state of a button.
+	@param button GuiBase
+	@param onUpdate function?
+	@return ButtonHighlightModel
+]=]
 function ButtonHighlightModel.new(button, onUpdate)
 	local self = setmetatable(BaseObject.new(assert(button, "Bad button")), ButtonHighlightModel)
 
 	self._onUpdate = onUpdate
 
-	-- Readonly
+--[=[
+	@prop InteractionEnabled BoolValue
+	@readonly
+	@within ButtonHighlightModel
+]=]
 	self.InteractionEnabled = Instance.new("BoolValue")
 	self.InteractionEnabled.Value = true
 	self._maid:GiveTask(self.InteractionEnabled)
 
-	-- readonly
+--[=[
+	@prop IsSelected BoolValue
+	@readonly
+	@within ButtonHighlightModel
+]=]
 	self.IsSelected = Instance.new("BoolValue")
 	self.IsSelected.Value = false
 	self._maid:GiveTask(self.IsSelected)
 
-	-- readonly
+--[=[
+	@prop IsMouseOrTouchOver BoolValue
+	@readonly
+	@within ButtonHighlightModel
+]=]
 	self.IsMouseOrTouchOver = Instance.new("BoolValue")
 	self.IsMouseOrTouchOver.Value = false
 	self._maid:GiveTask(self.IsMouseOrTouchOver)
@@ -43,7 +62,11 @@ function ButtonHighlightModel.new(button, onUpdate)
 	self._numFingerDown.Value = 0
 	self._maid:GiveTask(self._numFingerDown)
 
-	-- readonly
+--[=[
+	@prop IsChoosen BoolValue
+	@readonly
+	@within ButtonHighlightModel
+]=]
 	self.IsChoosen = Instance.new("BoolValue")
 	self.IsChoosen.Value = false
 	self._maid:GiveTask(self.IsChoosen)
@@ -56,12 +79,20 @@ function ButtonHighlightModel.new(button, onUpdate)
 	self._isMouseOver.Value = false
 	self._maid:GiveTask(self._isMouseOver)
 
-	-- readonly
+--[=[
+	@prop IsHighlighted BoolValue
+	@readonly
+	@within ButtonHighlightModel
+]=]
 	self.IsHighlighted = Instance.new("BoolValue")
 	self.IsHighlighted.Value = false
 	self._maid:GiveTask(self.IsHighlighted)
 
-	-- readonly
+--[=[
+	@prop IsPressed BoolValue
+	@readonly
+	@within ButtonHighlightModel
+]=]
 	self.IsPressed = Instance.new("BoolValue")
 	self.IsPressed.Value = false
 	self._maid:GiveTask(self.IsPressed)
@@ -162,6 +193,10 @@ function ButtonHighlightModel.new(button, onUpdate)
 	return self
 end
 
+--[=[
+	Observes how pressed down the button is
+	@return Observable<number>
+]=]
 function ButtonHighlightModel:ObservePercentPressed()
 	return Blend.AccelTween(Blend.toPropertyObservable(self.IsPressed)
 		:Pipe({
@@ -171,6 +206,10 @@ function ButtonHighlightModel:ObservePercentPressed()
 		}), 200)
 end
 
+--[=[
+	Observes how highlighted the button is
+	@return Observable<number>
+]=]
 function ButtonHighlightModel:ObservePercentHiglighted()
 	return Blend.AccelTween(Blend.toPropertyObservable(self.IsHighlighted)
 		:Pipe({
@@ -180,6 +219,10 @@ function ButtonHighlightModel:ObservePercentHiglighted()
 		}), 200)
 end
 
+--[=[
+	Observes how choosen the button is
+	@return Observable<number>
+]=]
 function ButtonHighlightModel:ObservePercentChoosen()
 	return Blend.AccelTween(Blend.toPropertyObservable(self.IsChoosen)
 		:Pipe({
@@ -189,20 +232,36 @@ function ButtonHighlightModel:ObservePercentChoosen()
 		}), 200)
 end
 
+--[=[
+	Observes interaction enabled
+	@return booloean
+]=]
 function ButtonHighlightModel:IsInteractionEnabled()
 	return self.InteractionEnabled.Value
 end
 
+--[=[
+	Sets whether a key is down
+	@param isKeyDown boolean
+]=]
 function ButtonHighlightModel:SetKeyDown(isKeyDown)
 	self._isKeyDown.Value = isKeyDown
 end
 
+--[=[
+	Sets whether interaction is enabled
+	@param interactionEnabled boolean
+]=]
 function ButtonHighlightModel:SetInteractionEnabled(interactionEnabled)
 	assert(type(interactionEnabled) == "boolean", "Bad interactionEnabled")
 
 	self.InteractionEnabled.Value = interactionEnabled
 end
 
+--[=[
+	Sets whether the model is choosen
+	@param isChoosen boolean
+]=]
 function ButtonHighlightModel:SetIsChoosen(isChoosen)
 	assert(type(isChoosen) == "boolean", "Bad isChoosen")