@quenty/scoredactionservice 4.8.0 → 4.9.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [4.9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/scoredactionservice@4.8.1...@quenty/scoredactionservice@4.9.0) (2022-01-17)
+
+**Note:** Version bump only for package @quenty/scoredactionservice
+
+
+
+
+
+## [4.8.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/scoredactionservice@4.8.0...@quenty/scoredactionservice@4.8.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/scoredactionservice
+
+
+
+
+
 # [4.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/scoredactionservice@4.7.0...@quenty/scoredactionservice@4.8.0) (2022-01-07)
 
 **Note:** Version bump only for package @quenty/scoredactionservice

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/scoredactionservice",
-  "version": "4.8.0",
+  "version": "4.9.0",
   "description": "Scores actions and picks the highest rated one every frame",
   "keywords": [
     "Roblox",
@@ -26,19 +26,19 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^3.4.0",
-    "@quenty/inputkeymaputils": "^3.7.0",
-    "@quenty/inputmode": "^3.7.0",
-    "@quenty/loader": "^3.3.0",
-    "@quenty/maid": "^2.0.2",
-    "@quenty/rx": "^3.7.0",
+    "@quenty/baseobject": "^3.5.0",
+    "@quenty/inputkeymaputils": "^3.8.0",
+    "@quenty/inputmode": "^3.8.0",
+    "@quenty/loader": "^3.4.0",
+    "@quenty/maid": "^2.1.0",
+    "@quenty/rx": "^3.8.0",
     "@quenty/signal": "^2.1.0",
-    "@quenty/statestack": "^3.4.0",
+    "@quenty/statestack": "^3.5.0",
     "@quenty/table": "^2.1.1",
-    "@quenty/valueobject": "^3.7.0"
+    "@quenty/valueobject": "^3.8.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5a3f3fb6c908fd3874f5ceacc70b404780275119"
+  "gitHead": "c094ba8f4e128cdff08919d89de226d3d65247ce"
 }

package/src/Client/ScoredAction.lua

@@ -1,4 +1,7 @@
 --[=[
+	An action that has a score, and may recieve priority from [ScoredActionService]
+
+	@client
 	@class ScoredAction
 ]=]
 
@@ -12,21 +15,31 @@ local ScoredAction = setmetatable({}, BaseObject)
 ScoredAction.ClassName = "ScoredAction"
 ScoredAction.__index = ScoredAction
 
+--[=[
+	Constructs a new ScoredAction. Should not be called directly. See [ScoredActionService.GetScoredAction].
+
+	@return ScoredAction
+]=]
 function ScoredAction.new()
 	local self = setmetatable(BaseObject.new(), ScoredAction)
 
-	-- @protected
 	self._score = -math.huge
-
-	-- @protected
 	self._createdTimeStamp = tick()
 
 
-	self._preferredStack = StateStack.new()
+	self._preferredStack = StateStack.new(false)
 	self._maid:GiveTask(self._preferredStack)
 
+--[=[
+	@prop PreferredChanged Signal<boolean>
+	@within ScoredAction
+]=]
 	self.PreferredChanged = self._preferredStack.Changed -- :Fire(newState)
 
+--[=[
+	@prop Removing Signal<()>
+	@within ScoredAction
+]=]
 	self.Removing = Signal.new()
 	self._maid:GiveTask(function()
 		self.Removing:Fire()
@@ -36,24 +49,43 @@ function ScoredAction.new()
 	return self
 end
 
+--[=[
+	Returns whether the action is currently preferred
+	@return boolean
+]=]
 function ScoredAction:IsPreferred()
 	return self._preferredStack:GetState()
 end
 
--- Big number is more important. At -math.huge
--- we won't ever set preferred
+--[=[
+	Sets the score
+
+	:::info
+	Big number is more important. At `-math.huge` we won't ever set preferred
+	:::
+
+	@param score number
+]=]
 function ScoredAction:SetScore(score)
 	assert(type(score) == "number", "Bad score")
 
 	self._score = score
 end
 
+--[=[
+	Retrieves the score
+	@return number
+]=]
 function ScoredAction:GetScore()
 	return self._score
 end
 
+--[=[
+	Pushes that we're preferred
+	@return MaidTask
+]=]
 function ScoredAction:PushPreferred()
-	return self._preferredStack:PushState()
+	return self._preferredStack:PushState(true)
 end
 
 return ScoredAction

package/src/Client/ScoredActionService.lua

@@ -1,5 +1,7 @@
 --[=[
-	Scores actions and picks the highest rated one every frame
+	Scores actions and picks the highest rated one every frame.
+
+	@client
 	@class ScoredActionService
 ]=]
 
@@ -15,19 +17,34 @@ local Observable = require("Observable")
 
 local ScoredActionService = {}
 
+--[=[
+	Initializes the ScoredActionService. Should be done via [ServiceBag].
+	@param _serviceBag ServiceBag
+]=]
 function ScoredActionService:Init(_serviceBag)
 	assert(not self._provider, "Already initialize")
 
+	self._maid = Maid.new()
 	self._provider = ScoredActionPickerProvider.new()
+	self._maid:GiveTask(self._provider)
 end
 
+--[=[
+	Starts the scored action service. Should be done via [ServiceBag].
+]=]
 function ScoredActionService:Start()
-	RunService.Stepped:Connect(function()
+	self._maid:GiveTask(RunService.Stepped:Connect(function()
 		-- TODO: Push to end of frame so we don't delay input by a frame?
 		self._provider:Update()
-	end)
+	end))
 end
 
+--[=[
+	Gets a new scored action to use
+
+	@param inputKeyMapList InputKeyMapList
+	@return ScoredAction
+]=]
 function ScoredActionService:GetScoredAction(inputKeyMapList)
 	assert(type(inputKeyMapList) == "table", "Bad inputKeyMapList")
 	assert(self._provider, "Not initialized")
@@ -47,8 +64,16 @@ function ScoredActionService:GetScoredAction(inputKeyMapList)
 	return scoredAction
 end
 
--- This MUTATES state of the scored action service
--- :Fire(scoredAction, inputKeyMapList)
+--[=[
+	Observes a new scored action from a scoring value.
+
+	:::warning
+	This MUTATES state of the scored action service whenever an object is emitted.
+	:::
+
+	@param scoreValue NumberValue
+	@return (source: Observable<InputKeyMapList>) -> Observable<ScoredAction>
+]=]
 function ScoredActionService:ObserveNewFromInputKeyMapList(scoreValue)
 	assert(self._provider, "Not initialized")
 	assert(typeof(scoreValue) == "Instance" and scoreValue:IsA("NumberValue"), "Bad scoreValue")