@quenty/sounds 4.1.0 → 4.2.1-canary.256.3cf0683.0

package/CHANGELOG.md

@@ -3,6 +3,29 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.2.1-canary.256.3cf0683.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@4.2.0...@quenty/sounds@4.2.1-canary.256.3cf0683.0) (2022-03-27)
+
+
+### Bug Fixes
+
+* Add initial package-locks to packages without them ([4ff9578](https://github.com/Quenty/NevermoreEngine/commit/4ff9578522d02d38d71a1c58d865a203a1c214f5))
+* Sounds can be played back from parents, and we can create sounds without playing them ([49e8863](https://github.com/Quenty/NevermoreEngine/commit/49e8863450ff5fc23333ae23a8c25bc93954ecbd))
+
+
+
+
+
+# [4.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@4.1.0...@quenty/sounds@4.2.0) (2022-03-20)
+
+
+### Bug Fixes
+
+* Allow way to play a sound in a parent ([8ba20b1](https://github.com/Quenty/NevermoreEngine/commit/8ba20b1813a06697018504f40f862088956a2017))
+
+
+
+
+
 # [4.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@4.0.0...@quenty/sounds@4.1.0) (2022-03-10)
 
 **Note:** Version bump only for package @quenty/sounds

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/sounds",
-  "version": "4.1.0",
+  "version": "4.2.1-canary.256.3cf0683.0",
   "description": "Utility functions involving sounds and their state",
   "keywords": [
     "Roblox",
@@ -26,11 +26,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^4.0.0",
-    "@quenty/promise": "^4.1.0"
+    "@quenty/loader": "4.0.1-canary.256.3cf0683.0",
+    "@quenty/promise": "4.1.1-canary.256.3cf0683.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "0797de955876b050fb24875de0423453e268b2ce"
+  "gitHead": "3cf06830affe1e6a6ca452a87969520cd941ccaa"
 }

package/src/Shared/SoundUtils.lua

@@ -8,9 +8,13 @@
 	@class SoundUtils
 ]=]
 
+local require = require(script.Parent.loader).load(script)
+
 local SoundService = game:GetService("SoundService")
 local RunService = game:GetService("RunService")
 
+local SoundPromiseUtils = require("SoundPromiseUtils")
+
 local SoundUtils = {}
 
 --[=[
@@ -27,7 +31,27 @@ local SoundUtils = {}
 	@param id string | number
 	@return Sound
 ]=]
-function SoundUtils.playFromId(id)
+function SoundUtils.playFromId(id: string | number): Sound
+	local soundId = SoundUtils.toRbxAssetId(id)
+	assert(type(soundId) == "string", "Bad id")
+
+	local sound = SoundUtils.createSoundFromId(id)
+
+	if RunService:IsClient() then
+		SoundService:PlayLocalSound(sound)
+	else
+		sound:Play()
+	end
+
+	SoundUtils.removeAfterTimeLength(sound)
+
+	return sound
+end
+
+--[=[
+	Creates a new sound object from the given id
+]=]
+function SoundUtils.createSoundFromId(id: string | number): Sound
 	local soundId = SoundUtils.toRbxAssetId(id)
 	assert(type(soundId) == "string", "Bad id")
 
@@ -37,19 +61,45 @@ function SoundUtils.playFromId(id)
 	sound.Volume = 0.25
 	sound.Archivable = false
 
-	if RunService:IsClient() then
+	return sound
+end
+
+--[=[
+	Plays back a template given asset id in the parent
+]=]
+function SoundUtils.playFromIdInParent(id: string | number, parent: Instance): Sound
+	assert(typeof(parent) == "Instance", "Bad parent")
+
+	local sound = SoundUtils.createSoundFromId(id)
+	sound.Parent = parent
+
+	if not RunService:IsRunning() then
 		SoundService:PlayLocalSound(sound)
 	else
 		sound:Play()
 	end
 
-	task.delay(sound.TimeLength + 0.05, function()
-		sound:Destroy()
-	end)
+	SoundUtils.removeAfterTimeLength(sound)
 
 	return sound
 end
 
+--[=[
+	Loads the sound and then cleans up the sound after load.
+
+	@param sound Sound
+]=]
+function SoundUtils.removeAfterTimeLength(sound: Sound)
+	-- TODO: clean up on destroying
+	SoundPromiseUtils.promiseLoaded(sound):Then(function()
+		task.delay(sound.TimeLength + 0.05, function()
+			sound:Destroy()
+		end)
+	end, function()
+		sound:Destroy()
+	end)
+end
+
 --[=[
 	Plays back a template given the templateName.
 
@@ -61,7 +111,7 @@ end
 	@param templateName string
 	@return Sound
 ]=]
-function SoundUtils.playTemplate(templates, templateName)
+function SoundUtils.playTemplate(templates, templateName: string)
 	assert(type(templates) == "table", "Bad templates")
 	assert(type(templateName) == "string", "Bad templateName")
 
@@ -70,19 +120,17 @@ function SoundUtils.playTemplate(templates, templateName)
 
 	SoundService:PlayLocalSound(sound)
 
-	task.delay(sound.TimeLength + 0.05, function()
-		sound:Destroy()
-	end)
+	SoundUtils.removeAfterTimeLength(sound)
 
 	return sound
 end
 
 --[=[
 	Converts a string or number to a string for playback.
-	@param id string | number
-	@return string
+	@param id string? | number
+	@return string?
 ]=]
-function SoundUtils.toRbxAssetId(id)
+function SoundUtils.toRbxAssetId(id: string? | number): string
 	if type(id) == "number" then
 		return ("rbxassetid://%d"):format(id)
 	else
@@ -102,16 +150,14 @@ end
 	@param parent Instance
 	@return Sound
 ]=]
-function SoundUtils.playTemplateInParent(templates, templateName, parent)
+function SoundUtils.playTemplateInParent(templates, templateName: string, parent: Instance)
 	local sound = templates:Clone(templateName)
 	sound.Archivable = false
 	sound.Parent = parent
 
 	sound:Play()
 
-	task.delay(sound.TimeLength + 0.05, function()
-		sound:Destroy()
-	end)
+	SoundUtils.removeAfterTimeLength(sound)
 
 	return sound
 end