@quenty/sounds 3.5.0 → 3.6.0-canary.241.a4e8214.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.6.0-canary.241.a4e8214.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@3.5.1...@quenty/sounds@3.6.0-canary.241.a4e8214.0) (2022-01-03)
+
+**Note:** Version bump only for package @quenty/sounds
+
+
+
+
+
+## [3.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@3.5.0...@quenty/sounds@3.5.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/sounds
+
+
+
+
+
 # [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/sounds@3.4.0...@quenty/sounds@3.5.0) (2021-12-18)
 
 **Note:** Version bump only for package @quenty/sounds

package/README.md

@@ -1,10 +1,10 @@
 ## SoundPromiseUtils
 <div align="center">
-  <a href="http://quenty.github.io/api/">
-    <img src="https://img.shields.io/badge/docs-website-green.svg" alt="Documentation" />
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
   </a>
   <a href="https://discord.gg/mhtGUS8">
-    <img src="https://img.shields.io/badge/discord-nevermore-blue.svg" alt="Discord" />
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
   </a>
   <a href="https://github.com/Quenty/NevermoreEngine/actions">
     <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
@@ -13,15 +13,9 @@
 
 Utility functions involving sounds and their state
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/SoundUtils">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/soundpromiseutils --save
-```
-
-## Usage
-Usage is designed to be simple.
-
-### `SoundPromiseUtils.promiseLoaded(sound)`
-
-### `SoundPromiseUtils.promiseAllSoundsLoaded(sounds)`
-
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/sounds",
-  "version": "3.5.0",
+  "version": "3.6.0-canary.241.a4e8214.0",
   "description": "Utility functions involving sounds and their state",
   "keywords": [
     "Roblox",
@@ -26,11 +26,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^3.1.1",
-    "@quenty/promise": "^3.3.0"
+    "@quenty/loader": "3.2.0-canary.241.a4e8214.0",
+    "@quenty/promise": "3.4.0-canary.241.a4e8214.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6eb398e9fb81191f0815885f807ab0cb3bb9bad1"
+  "gitHead": "a4e821471f35998d63f38a4f4a578e07b4e79035"
 }

package/src/Shared/SoundPromiseUtils.lua

@@ -1,6 +1,7 @@
---- Utility functions involving sounds and their state
--- @module SoundPromiseUtils
--- @author Quenty
+--[=[
+	Utility functions involving sounds and their state
+	@class SoundPromiseUtils
+]=]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -9,6 +10,11 @@ local PromiseUtils = require("PromiseUtils")
 
 local SoundPromiseUtils = {}
 
+--[=[
+	Promises that a sound is loaded
+	@param sound Sound
+	@return Promise
+]=]
 function SoundPromiseUtils.promiseLoaded(sound)
 	if sound.IsLoaded then
 		return Promise.resolved()
@@ -31,6 +37,11 @@ function SoundPromiseUtils.promiseLoaded(sound)
 	return promise
 end
 
+--[=[
+	Promises that all sounds are loaded
+	@param sounds { Sound }
+	@return Promise
+]=]
 function SoundPromiseUtils.promiseAllSoundsLoaded(sounds)
 	local promises = {}
 	for _, sound in pairs(sounds) do

package/src/Shared/SoundUtils.lua

@@ -1,11 +1,28 @@
---- Helps play sounds on the client
--- @module SoundUtils
--- @author Quenty
+--[=[
+	Helps plays back sounds in the Roblox engine.
+
+	```lua
+	SoundUtils.playFromId("rbxassetid://4255432837") -- Plays a wooshing sound
+	```
+
+	@class SoundUtils
+]=]
 
 local SoundService = game:GetService("SoundService")
 
 local SoundUtils = {}
 
+--[=[
+	Plays back a template given the templateName.
+
+	:::tip
+	The sound will be automatically cleaned up after the sound is played.
+	:::
+
+	@param templates TemplateProvider
+	@param templateName string
+	@return Sound
+]=]
 function SoundUtils.playTemplate(templates, templateName)
 	assert(type(templates) == "table", "Bad templates")
 	assert(type(templateName) == "string", "Bad templateName")
@@ -22,6 +39,20 @@ function SoundUtils.playTemplate(templates, templateName)
 	return sound
 end
 
+--[=[
+	Plays back a template given asset id.
+
+	```lua
+	SoundUtils.playFromId("rbxassetid://4255432837") -- Plays a wooshing sound
+	```
+
+	:::tip
+	The sound will be automatically cleaned up after the sound is played.
+	:::
+
+	@param id string | number
+	@return Sound
+]=]
 function SoundUtils.playFromId(id)
 	local soundId = SoundUtils.toRbxAssetId(id)
 	assert(type(soundId) == "string", "Bad id")
@@ -41,6 +72,11 @@ function SoundUtils.playFromId(id)
 	return sound
 end
 
+--[=[
+	Converts a string or number to a string for playback.
+	@param id string | number
+	@return string
+]=]
 function SoundUtils.toRbxAssetId(id)
 	if type(id) == "number" then
 		return ("rbxassetid://%d"):format(id)
@@ -49,6 +85,18 @@ function SoundUtils.toRbxAssetId(id)
 	end
 end
 
+--[=[
+	Plays back a sound template in a specific parent.
+
+	:::tip
+	The sound will be automatically cleaned up after the sound is played.
+	:::
+
+	@param templates TemplateProvider
+	@param templateName string
+	@param parent Instance
+	@return Sound
+]=]
 function SoundUtils.playTemplateInParent(templates, templateName, parent)
 	local sound = templates:Clone(templateName)
 	sound.Archivable = false
@@ -63,5 +111,4 @@ function SoundUtils.playTemplateInParent(templates, templateName, parent)
 	return sound
 end
 
-
 return SoundUtils