@quenty/steputils 3.5.1 → 3.5.2-canary.506.9cbf2c1.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.
 
+## [3.5.2-canary.506.9cbf2c1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.5.1...@quenty/steputils@3.5.2-canary.506.9cbf2c1.0) (2024-10-08)
+
+
+### Bug Fixes
+
+* Deprecate a large set of APIs ([9cbf2c1](https://github.com/Quenty/NevermoreEngine/commit/9cbf2c15d68e45eecbfbfa9f359c1a19cfa4fd5e))
+
+
+
+
+
 ## [3.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/steputils@3.5.0...@quenty/steputils@3.5.1) (2024-10-04)
 
 **Note:** Version bump only for package @quenty/steputils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/steputils",
-  "version": "3.5.1",
+  "version": "3.5.2-canary.506.9cbf2c1.0",
   "description": "Binds animations into step, where the animation only runs as needed",
   "keywords": [
     "Roblox",
@@ -27,5 +27,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "539802fea720a92f81ad48d6d5579605d8844d0a"
+  "gitHead": "9cbf2c15d68e45eecbfbfa9f359c1a19cfa4fd5e"
 }

package/src/Shared/StepUtils.lua

@@ -43,13 +43,9 @@ end
 	Yields until the frame deferral is done
 ]=]
 function StepUtils.deferWait()
-	local signal = Instance.new("BindableEvent")
-	task.defer(function()
-		signal:Fire()
-		signal:Destroy()
-	end)
-
-	signal.Event:Wait()
+	local current = coroutine.running()
+	task.defer(task.spawn, current)
+	coroutine.yield()
 end
 
 --[=[
@@ -158,26 +154,44 @@ end
 		part.CFrame = CFrame.new(0, 0, )
 	end))
 	```
+
+	:::tip
+	use `RunService.Stepped:Once()` instead
+	:::
+
+	@deprecated 3.5.2
 	@param func function -- Function to call
 	@return function -- Call this function to cancel call
 ]=]
 function StepUtils.onceAtStepped(func)
-	return StepUtils.onceAtEvent(RunService.Stepped, func)
+	local conn = RunService.Stepped:Once(func)
+	return function()
+		conn:Disconnect()
+	end
 end
 
 --[=[
 	Invokes the function once at renderstepped, unless the cancel callback is called.
 
+	:::tip
+	use `RunService.RenderStepped:Once()` instead
+	:::
+
+	@deprecated 3.5.2
 	@param func function -- Function to call
 	@return function -- Call this function to cancel call
 ]=]
 function StepUtils.onceAtRenderStepped(func)
-	return StepUtils.onceAtEvent(RunService.RenderStepped, func)
+	local conn = RunService.RenderStepped:Once(func)
+	return function()
+		conn:Disconnect()
+	end
 end
 
 --[=[
 	Invokes the function once at the given event, unless the cancel callback is called.
 
+	@deprecated 3.5.2
 	@param event Signal | RBXScriptSignal
 	@param func function -- Function to call
 	@return function -- Call this function to cancel call