@rbxts/sound-manager 2.3.0 → 2.3.1

package/README.md

@@ -40,7 +40,7 @@ npm install @rbxts/sound-manager
 
 ### ⚡ Starting with Sound Manager
 
-Sound-Manager uses [`createSoundRegistry`]() and [`createSoundCategoryRegistry`]() to create sounds and categories.
+Sound-Manager uses [`createSoundRegistry`](https://dev-lukas0.github.io/Sound-Manager/docs/reference/create-sound-registry) and [`createSoundCategoryRegistry`](https://dev-lukas0.github.io/Sound-Manager/docs/reference/create-sound-category-registry) to create sounds and categories.
 
 ```ts
 import { createSoundRegistry } from "@rbxts/sound-manager";

package/out/core/createSoundRegistry.luau

@@ -83,6 +83,10 @@ local function createSoundRegistry(definitions)
 	local function stop(name, spatial)
 		if not spatial then
 			local sound = folder:FindFirstChild(name)
+			if not sound then
+				warn(`{name} not found! Tip: Preload the sound first before using it.`)
+				return nil
+			end
 			local _result = sound
 			if _result ~= nil then
 				_result:Stop()
@@ -122,6 +126,10 @@ local function createSoundRegistry(definitions)
 		local config = definitions[soundName]
 		if not spatial or not spatial.emitters then
 			local sound = folder:FindFirstChild(soundName)
+			if not sound then
+				warn(`{soundName} not found! Tip: Preload the sound first before using it.`)
+				return nil
+			end
 			sound.Volume = 0
 			sound:Play()
 			local step = 0.05
@@ -168,6 +176,7 @@ local function createSoundRegistry(definitions)
 		if not spatial or not spatial.emitters then
 			local sound = folder:FindFirstChild(soundName)
 			if not sound then
+				warn(`{soundName} not found! Tip: Preload the sound first before using it.`)
 				return nil
 			end
 			local startVolume = sound.Volume
@@ -218,7 +227,8 @@ local function createSoundRegistry(definitions)
 	]]
 	local function reset(sound)
 		local _sound = folder:FindFirstChild(sound)
-		if not (sound ~= 0 and sound == sound and sound ~= "" and sound) then
+		if not _sound then
+			warn(`{sound} not found! Tip: Preload the sound first before using it.`)
 			return nil
 		end
 		_sound.TimePosition = 0
@@ -245,7 +255,8 @@ local function createSoundRegistry(definitions)
 	]]
 	local function setTimePosition(sound, timePosition)
 		local _sound = folder:FindFirstChild(sound)
-		if not (sound ~= 0 and sound == sound and sound ~= "" and sound) then
+		if not _sound then
+			warn(`{sound} not found! Tip: Preload the sound first before using it.`)
 			return nil
 		end
 		_sound.TimePosition = timePosition
@@ -279,7 +290,8 @@ local function createSoundRegistry(definitions)
 		local config = definitions[sound]
 		if not spatial or spatial.emitters then
 			local _sound = folder:FindFirstChild(sound)
-			if not (sound ~= 0 and sound == sound and sound ~= "" and sound) then
+			if not _sound then
+				warn(`{sound} not found! Tip: Preload the sound first before using it.`)
 				return nil
 			end
 			_sound.Volume = volume
@@ -315,6 +327,7 @@ local function createSoundRegistry(definitions)
 		if not spatial then
 			local _sound = folder:WaitForChild(sound)
 			if not _sound then
+				warn(`{sound} not found! Tip: Preload the sound first before using it.`)
 				return nil
 			end
 			_sound.Ended:Connect(callback)
@@ -345,6 +358,9 @@ local function createSoundRegistry(definitions)
 	]]
 	local function isPlaying(sound)
 		local _sound = folder:FindFirstChild(sound)
+		if not _sound then
+			warn(`{sound} not found! Tip: Preload the sound first before using it.`)
+		end
 		if _sound.IsPlaying == true then
 			return true
 		else

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rbxts/sound-manager",
-  "version": "2.3.0",
+  "version": "2.3.1",
   "description": "A sound manager for Roblox-Typescript projects.",
   "main": "out/init.lua",
   "scripts": {