@quenty/idleservice 2.2.1 → 3.0.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.
 
+# [3.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/idleservice@2.3.0...@quenty/idleservice@3.0.0) (2022-01-17)
+
+**Note:** Version bump only for package @quenty/idleservice
+
+
+
+
+
+# [2.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/idleservice@2.2.1...@quenty/idleservice@2.3.0) (2022-01-17)
+
+**Note:** Version bump only for package @quenty/idleservice
+
+
+
+
+
 ## [2.2.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/idleservice@2.2.0...@quenty/idleservice@2.2.1) (2022-01-16)
 
 **Note:** Version bump only for package @quenty/idleservice

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/idleservice",
-  "version": "2.2.1",
+  "version": "3.0.0",
   "description": "Helps track whether or not a player is idle and if so, then can show UI or other cute things.",
   "keywords": [
     "Roblox",
@@ -27,15 +27,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/humanoidtracker": "^3.7.1",
-    "@quenty/loader": "^3.3.0",
-    "@quenty/maid": "^2.0.2",
-    "@quenty/ragdoll": "^5.2.1",
-    "@quenty/servicebag": "^3.4.0",
-    "@quenty/statestack": "^3.4.1"
+    "@quenty/humanoidtracker": "^3.8.0",
+    "@quenty/loader": "^3.4.0",
+    "@quenty/maid": "^2.1.0",
+    "@quenty/ragdoll": "^5.3.0",
+    "@quenty/servicebag": "^3.5.0",
+    "@quenty/statestack": "^4.0.0",
+    "@quenty/valuebaseutils": "^3.8.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e5be9e38e7fbbaed3296c3c83bd40f8745425ac3"
+  "gitHead": "cbd40cfd2fd23c14978a3154cad9d1e3d1c78edf"
 }

package/src/Client/{IdleService.lua → IdleServiceClient.lua}

@@ -1,6 +1,8 @@
 --[=[
-	Helps track whether or not a player is idle and if so, then can show UI or other cute things
-	@class IdleService
+	Helps track whether or not a player is idle and if so, then can show UI or other cute things.
+
+	@client
+	@class IdleServiceClient
 ]=]
 
 local require = require(script.Parent.loader).load(script)
@@ -11,20 +13,29 @@ local VRService = game:GetService("VRService")
 local HumanoidTrackerService = require("HumanoidTrackerService")
 local Maid = require("Maid")
 local RagdollBindersClient = require("RagdollBindersClient")
+local RxValueBaseUtils = require("RxValueBaseUtils")
 local StateStack = require("StateStack")
 
-local IdleService = {}
+local IdleServiceClient = {}
 
 local STANDING_TIME_REQUIRED = 0.5
 
-function IdleService:Init(serviceBag)
+--[=[
+	Initializes the idle service on the client. Should be done via [ServiceBag].
+	@param serviceBag ServiceBag
+]=]
+function IdleServiceClient:Init(serviceBag)
 	assert(not self._maid, "Already initialized")
 
 	self._maid = Maid.new()
-	self._humanoidTracker = serviceBag:GetService(HumanoidTrackerService):GetHumanoidTracker()
-	self._ragdollBindersClient = serviceBag:GetService(RagdollBindersClient)
+	self._serviceBag = assert(serviceBag, "No serviceBag")
 
-	self._disabledStack = StateStack.new()
+	-- External
+	self._serviceBag:GetService(require("RagdollServiceClient"))
+	self._humanoidTracker = self._serviceBag:GetService(HumanoidTrackerService):GetHumanoidTracker()
+	self._ragdollBindersClient = self._serviceBag:GetService(RagdollBindersClient)
+
+	self._disabledStack = StateStack.new(false)
 	self._maid:GiveTask(self._disabledStack)
 
 	self._enabled = Instance.new("BoolValue")
@@ -38,7 +49,12 @@ function IdleService:Init(serviceBag)
 	self._humanoidIdle = Instance.new("BoolValue")
 	self._humanoidIdle.Value = false
 	self._maid:GiveTask(self._humanoidIdle)
+end
 
+--[=[
+	Starts idle service on the client. Should be done via [ServiceBag].
+]=]
+function IdleServiceClient:Start()
 	self._maid:GiveTask(self._humanoidIdle.Changed:Connect(function()
 		self:_updateShowIdleUI()
 	end))
@@ -59,39 +75,63 @@ function IdleService:Init(serviceBag)
 	self:_updateShowIdleUI()
 end
 
-function IdleService:IsHumanoidIdle()
+--[=[
+	Returns whether the humanoid is idle.
+	@return boolean
+]=]
+function IdleServiceClient:IsHumanoidIdle()
 	return self._humanoidIdle.Value
 end
 
-function IdleService:DoShowIdleUI()
+--[=[
+	Returns whether UI should be shown (if the humanoid is idle)
+	@return boolean
+]=]
+function IdleServiceClient:DoShowIdleUI()
 	return self._showIdleUI.Value
 end
 
-function IdleService:GetShowIdleUIBoolValue()
+--[=[
+	Observes whether to show the the idle UI
+	@return Observable<boolean>
+]=]
+function IdleServiceClient:ObserveShowIdleUI()
+	return RxValueBaseUtils.observeValue(self._showIdleUI)
+end
+
+--[=[
+	Returns a show idle bool value.
+	@return BoolValue
+]=]
+function IdleServiceClient:GetShowIdleUIBoolValue()
 	assert(self._showIdleUI, "Not initialized")
 
 	return self._showIdleUI
 end
 
-function IdleService:PushDisable()
+--[=[
+	Pushes a disabling function that disables idle UI
+	@return boolean
+]=]
+function IdleServiceClient:PushDisable()
 	if not RunService:IsRunning() then
 		return function() end
 	end
 
 	assert(self._disabledStack, "Not initialized")
-	return self._disabledStack:PushState()
+	return self._disabledStack:PushState(true)
 end
 
-function IdleService:_setEnabled(enabled)
+function IdleServiceClient:_setEnabled(enabled)
 	assert(type(enabled) == "boolean", "Bad enabled")
 	self._enabled.Value = enabled
 end
 
-function IdleService:_updateShowIdleUI()
+function IdleServiceClient:_updateShowIdleUI()
 	self._showIdleUI.Value = self._humanoidIdle.Value and self._enabled.Value and not VRService.VREnabled
 end
 
-function IdleService:_handleAliveHumanoidChanged()
+function IdleServiceClient:_handleAliveHumanoidChanged()
 	local humanoid = self._humanoidTracker.AliveHumanoid.Value
 	if not humanoid then
 		self._maid._humanoidMaid = nil
@@ -100,14 +140,14 @@ function IdleService:_handleAliveHumanoidChanged()
 
 	local maid = Maid.new()
 
-	local lastMove = tick()
+	local lastMove = os.clock()
 
 	maid:GiveTask(function()
 		self._humanoidIdle.Value = false
 	end)
 
 	local function update()
-		if tick() - lastMove >= STANDING_TIME_REQUIRED then
+		if os.clock() - lastMove >= STANDING_TIME_REQUIRED then
 			self._humanoidIdle.Value = true
 		else
 			self._humanoidIdle.Value = false
@@ -115,17 +155,17 @@ function IdleService:_handleAliveHumanoidChanged()
 	end
 
 	maid:GiveTask(self._enabled.Changed:Connect(function()
-		lastMove = tick()
+		lastMove = os.clock()
 	end))
 
 	maid:GiveTask(RunService.Stepped:Connect(function()
 		local rootPart = humanoid.RootPart
 
 		if self._ragdollBindersClient.Ragdoll:Get(humanoid) then
-			lastMove = tick()
+			lastMove = os.clock()
 		elseif rootPart then
 			if rootPart.Velocity.magnitude > 2.5 then
-				lastMove = tick()
+				lastMove = os.clock()
 			end
 		end
 
@@ -135,4 +175,4 @@ function IdleService:_handleAliveHumanoidChanged()
 	self._maid._humanoidMaid = maid
 end
 
-return IdleService
+return IdleServiceClient