@quenty/sounds 7.0.0-canary.331.7eefa75.0 → 7.0.0

package/CHANGELOG.md

@@ -3,7 +3,91 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [7.0.0-canary.331.7eefa75.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@6.2.0...@quenty/sounds@7.0.0-canary.331.7eefa75.0) (2023-02-27)
+# [7.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@6.10.0...@quenty/sounds@7.0.0) (2023-10-11)
+
+**Note:** Version bump only for package @quenty/sounds
+
+
+
+
+
+# [6.10.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@6.9.0...@quenty/sounds@6.10.0) (2023-08-23)
+
+
+### Bug Fixes
+
+* Add missing dependencies ([324e3db](https://github.com/Quenty/NevermoreEngine/commit/324e3dbcd7ed260542eebe24889cbc6cd968d380))
+
+
+### Features
+
+* Sound plays using :Play() always since PlayLocalSound no longer works in Hoarcekat ([58eeb15](https://github.com/Quenty/NevermoreEngine/commit/58eeb15e832c5d13a4a602c87656b233862d8392))
+* Sounds can play back tables ([d33bbee](https://github.com/Quenty/NevermoreEngine/commit/d33bbeed98016b04b0958ce27df5a82f7c9cbf4e))
+
+
+
+
+
+# [6.9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@6.8.0...@quenty/sounds@6.9.0) (2023-07-28)
+
+**Note:** Version bump only for package @quenty/sounds
+
+
+
+
+
+# [6.8.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@6.7.0...@quenty/sounds@6.8.0) (2023-07-10)
+
+
+### Features
+
+* Use RbxAssetId package for SoundUtils ([097438e](https://github.com/Quenty/NevermoreEngine/commit/097438ed87e54c37212c421a58656711598dddb1))
+
+
+
+
+
+# [6.7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@6.6.0...@quenty/sounds@6.7.0) (2023-06-17)
+
+**Note:** Version bump only for package @quenty/sounds
+
+
+
+
+
+# [6.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@6.5.1...@quenty/sounds@6.6.0) (2023-04-10)
+
+**Note:** Version bump only for package @quenty/sounds
+
+
+
+
+
+## [6.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@6.5.0...@quenty/sounds@6.5.1) (2023-04-07)
+
+**Note:** Version bump only for package @quenty/sounds
+
+
+
+
+
+# [6.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@6.4.0...@quenty/sounds@6.5.0) (2023-03-31)
+
+**Note:** Version bump only for package @quenty/sounds
+
+
+
+
+
+# [6.4.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@6.3.0...@quenty/sounds@6.4.0) (2023-03-05)
+
+**Note:** Version bump only for package @quenty/sounds
+
+
+
+
+
+# [6.3.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@6.2.0...@quenty/sounds@6.3.0) (2023-02-27)
 
 **Note:** Version bump only for package @quenty/sounds
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2022 Quenty
+Copyright (c) 2014-2023 James Onnen (Quenty)
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/sounds",
-  "version": "7.0.0-canary.331.7eefa75.0",
+  "version": "7.0.0",
   "description": "Utility functions involving sounds and their state",
   "keywords": [
     "Roblox",
@@ -26,11 +26,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "6.1.0",
-    "@quenty/promise": "7.0.0-canary.331.7eefa75.0"
+    "@quenty/loader": "^7.0.0",
+    "@quenty/maid": "^2.6.0",
+    "@quenty/promise": "^7.0.0",
+    "@quenty/promisemaid": "^2.0.0",
+    "@quenty/rbxasset": "^2.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "7eefa756f8bd892b1210349a8133d6d56992dffb"
+  "gitHead": "fdeae46099587019ec5fc15317dc673aed379400"
 }

package/src/Shared/SoundPromiseUtils.lua

@@ -7,6 +7,8 @@ local require = require(script.Parent.loader).load(script)
 
 local Promise = require("Promise")
 local PromiseUtils = require("PromiseUtils")
+local PromiseMaidUtils = require("PromiseMaidUtils")
+local Maid = require("Maid")
 
 local SoundPromiseUtils = {}
 
@@ -21,22 +23,44 @@ function SoundPromiseUtils.promiseLoaded(sound)
 	end
 
 	local promise = Promise.new()
+	local maid = Maid.new()
 
-	local conn
+	maid:GiveTask(sound:GetPropertyChangedSignal("IsLoaded"):Connect(function()
+		if sound.IsLoaded then
+			promise:Resolve()
+		end
+	end))
 
-	conn = sound.Loaded:Connect(function()
+	maid:GiveTask(sound.Loaded:Connect(function()
 		if sound.IsLoaded then
 			promise:Resolve()
 		end
-	end)
+	end))
 
 	promise:Finally(function()
-		conn:Disconnect()
+		maid:DoCleaning()
 	end)
 
 	return promise
 end
 
+function SoundPromiseUtils.promisePlayed(sound)
+	return SoundPromiseUtils.promiseLoaded(sound):Then(function()
+		return PromiseUtils.delayed(sound.TimeLength)
+	end)
+end
+
+function SoundPromiseUtils.promiseLooped(sound)
+	local promise = Promise.new()
+
+	PromiseMaidUtils.whilePromise(promise, function(maid)
+		maid:GiveTask(sound.DidLoop:Connect(function()
+			promise:Resolve()
+		end))
+	end)
+
+	return promise
+end
 --[=[
 	Promises that all sounds are loaded
 	@param sounds { Sound }

package/src/Shared/SoundUtils.lua

@@ -14,6 +14,7 @@ local SoundService = game:GetService("SoundService")
 local RunService = game:GetService("RunService")
 
 local SoundPromiseUtils = require("SoundPromiseUtils")
+local RbxAssetUtils = require("RbxAssetUtils")
 
 local SoundUtils = {}
 
@@ -28,13 +29,9 @@ local SoundUtils = {}
 	The sound will be automatically cleaned up after the sound is played.
 	:::
 
-	@param id string | number
 	@return Sound
 ]=]
-function SoundUtils.playFromId(id: string | number): Sound
-	local soundId = SoundUtils.toRbxAssetId(id)
-	assert(type(soundId) == "string", "Bad id")
-
+function SoundUtils.playFromId(id: string | number | table): Sound
 	local sound = SoundUtils.createSoundFromId(id)
 
 	if RunService:IsClient() then
@@ -51,34 +48,52 @@ end
 --[=[
 	Creates a new sound object from the given id
 ]=]
-function SoundUtils.createSoundFromId(id: string | number): Sound
+function SoundUtils.createSoundFromId(id: string | number | table): Sound
 	local soundId = SoundUtils.toRbxAssetId(id)
 	assert(type(soundId) == "string", "Bad id")
 
 	local sound = Instance.new("Sound")
+	sound.Archivable = false
+
+	SoundUtils.applyPropertiesFromId(sound, id)
+
+	return sound
+end
+
+function SoundUtils.applyPropertiesFromId(sound, id)
+	local soundId = SoundUtils.toRbxAssetId(id)
 	sound.Name = ("Sound_%s"):format(soundId)
 	sound.SoundId = soundId
 	sound.RollOffMode = Enum.RollOffMode.InverseTapered
 	sound.Volume = 0.25
-	sound.Archivable = false
 
-	return sound
+	if type(id) == "table" then
+		for property, value in pairs(id) do
+			if property ~= "Parent" and property ~= "RollOffMinDistance" then
+				sound[property] = value
+			end
+		end
+
+		if id.RollOffMinDistance then
+			sound.RollOffMinDistance = id.RollOffMinDistance
+		end
+
+		if id.Parent then
+			sound.Parent = id.Parent
+		end
+	end
 end
 
 --[=[
 	Plays back a template given asset id in the parent
 ]=]
-function SoundUtils.playFromIdInParent(id: string | number, parent: Instance): Sound
+function SoundUtils.playFromIdInParent(id: string | number | table, 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
+	sound:Play()
 
 	SoundUtils.removeAfterTimeLength(sound)
 
@@ -128,14 +143,25 @@ end
 
 --[=[
 	Converts a string or number to a string for playback.
+
+	@function toRbxAssetId
 	@param id string? | number
 	@return string?
+	@within SoundUtils
 ]=]
-function SoundUtils.toRbxAssetId(id: string? | number): string
-	if type(id) == "number" then
-		return ("rbxassetid://%d"):format(id)
+function SoundUtils.toRbxAssetId(soundId)
+	if type(soundId) == "table" then
+		return RbxAssetUtils.toRbxAssetId(soundId.SoundId)
+	else
+		return RbxAssetUtils.toRbxAssetId(soundId)
+	end
+end
+
+function SoundUtils.isConvertableToRbxAsset(soundId)
+	if type(soundId) == "table" then
+		return RbxAssetUtils.isConvertableToRbxAsset(soundId.SoundId)
 	else
-		return id
+		return RbxAssetUtils.isConvertableToRbxAsset(soundId)
 	end
 end