@quenty/streamingutils 6.0.1 → 6.1.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.
 
+# [6.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/streamingutils@6.0.1...@quenty/streamingutils@6.1.0) (2022-12-27)
+
+
+### Bug Fixes
+
+* Fix StreamingUtils failing if streaming is disabled ([2c0d29a](https://github.com/Quenty/NevermoreEngine/commit/2c0d29af66d4f512528ee99cf5bc3e8a81188a96))
+
+
+
+
+
 ## [6.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/streamingutils@6.0.0...@quenty/streamingutils@6.0.1) (2022-11-04)
 
 **Note:** Version bump only for package @quenty/streamingutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/streamingutils",
-  "version": "6.0.1",
+  "version": "6.1.0",
   "description": "Provides utilities for working with Roblox's streaming system",
   "keywords": [
     "Roblox",
@@ -32,5 +32,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "8b9877c26a3fc753409a5114e56717837291279d"
+  "gitHead": "a4f99aa40c45080db30be7117cada229572f1574"
 }

package/src/Shared/StreamingUtils.lua

@@ -5,12 +5,30 @@
 
 local require = require(script.Parent.loader).load(script)
 
+local Workspace = game:GetService("Workspace")
+
 local Promise = require("Promise")
 
 local StreamingUtils = {}
 
 --[=[
-	Promises to stream the area around the player at the given position.
+	Promises to stream the area around the player at the given position. See [Player.RequestStreamAroundAsync]. Can
+	be called on both the client and the server.
+
+	```lua
+	StreamingUtils.promiseStreamAround(Players.LocalPlayer, Vector3.new(0, 10, 0), 30)
+		:Then(function()
+			print("Done streaming")
+		end)
+	```
+
+	Returns a resolved promise if streaming is not enabled as the area is guaranteed to be streamed in already.
+
+	:::warning
+	Requesting streaming around an area is not a guarantee that the content will be present when the request completes,
+	as streaming is affected by the client's network bandwidth, memory limitations, and other factors.
+	:::
+
 	@param player Player
 	@param position Vector3
 	@param timeOut number? -- Optional
@@ -21,7 +39,13 @@ function StreamingUtils.promiseStreamAround(player, position, timeOut)
 	assert(typeof(position) == "Vector3", "Bad position")
 	assert(type(timeOut) == "number" or timeOut == nil, "Bad timeOut")
 
+	-- Guaranteed to be streamed in, no need to do anything
+	if not Workspace.StreamingEnabled then
+		return Promise.resolved()
+	end
+
 	return Promise.spawn(function(resolve, reject)
+
 		local ok, err = pcall(function()
 			player:RequestStreamAroundAsync(position, timeOut)
 		end)