@rbxts/sound-manager 1.2.0 → 2.0.0

package/README.md

@@ -24,3 +24,6 @@ Sounds.preloadAll();
 
 Sounds.play("SCP096");
 ```
+
+For more Details:
+https://dev-lukas0.github.io/Sound-Manager-Docs/

package/out/core/createSoundCategoryRegistry.d.ts

@@ -0,0 +1,9 @@
+import { CategoryOptions } from "./options";
+/**
+ * Create a sound category Registry
+ * @param definitions Define the Categorys
+ */
+export declare function createSoundCategoryRegistry<T extends Record<string, CategoryOptions>>(definitions: T): {
+    loadCategory: (name: keyof T) => void;
+    playCategory: <C extends keyof T>(name: C) => void;
+};

package/out/core/createSoundCategoryRegistry.luau

@@ -0,0 +1,85 @@
+-- Compiled with roblox-ts v3.0.0
+--[[
+	*
+	 * Create a sound category Registry
+	 * @param definitions Define the Categorys
+	 
+]]
+local function createSoundCategoryRegistry(definitions)
+	local ReplicatedStorage = game:GetService("ReplicatedStorage")
+	local folder = ReplicatedStorage:FindFirstChild("Sounds")
+	if not folder then
+		folder = Instance.new("Folder")
+		folder.Name = "Sounds"
+		folder.Parent = ReplicatedStorage
+	end
+	--[[
+		*
+		     * Loads a Category
+		     * @param name Define which Sound Category should be loaded
+		     
+	]]
+	local function loadCategory(name)
+		if folder:FindFirstChild(name) then
+			return nil
+		end
+		local config = definitions[name]
+		local category = folder:FindFirstChild(config.category)
+		if not category then
+			category = Instance.new("Folder")
+			category.Name = config.category
+			category.Parent = folder
+		end
+		for sound, soundConfig in pairs(config.sounds) do
+			if category:FindFirstChild(sound) then
+				continue
+			end
+			local newSound = Instance.new("Sound")
+			newSound.Name = sound
+			newSound.SoundId = soundConfig.id
+			local _condition = soundConfig.volume
+			if _condition == nil then
+				_condition = 1
+			end
+			newSound.Volume = _condition
+			local _condition_1 = soundConfig.loop
+			if _condition_1 == nil then
+				_condition_1 = false
+			end
+			newSound.Looped = _condition_1
+			newSound.Parent = category
+		end
+	end
+	--[[
+		*
+		     * Play every Sound from a Sound Category
+		     * @param name Sound Category
+		     
+	]]
+	local function playCategory(name)
+		loadCategory(name)
+		local config = definitions[name]
+		local ReplicatedStorage = game:GetService("ReplicatedStorage")
+		local folder = ReplicatedStorage:FindFirstChild(config.category)
+		for sound in pairs(config.sounds) do
+			local _sound = folder:FindFirstChild(sound)
+			if not _sound then
+				continue
+			end
+			local _result = _sound
+			if _result ~= nil then
+				_result = _result:IsA("Sound")
+			end
+			if _result then
+				_sound:Play()
+			end
+		end
+	end
+	return {
+		loadCategory = loadCategory,
+		playCategory = playCategory,
+	}
+end
+return {
+	createSoundCategoryRegistry = createSoundCategoryRegistry,
+}

package/out/core/createSoundRegistry.d.ts

@@ -1,12 +1,21 @@
 import { SoundOptions } from "./options";
 /**
- *
+ * Create a sound Registry
  * @param definitions Define the Sounds
- * @returns
  */
 export declare function createSoundRegistry<T extends Record<string, SoundOptions>>(definitions: T): {
     play: (name: keyof T) => void;
     stop: (name: keyof T) => void;
     preloadAll: () => void;
     load: (name: keyof T) => void;
+    fadeIn: (soundName: keyof T, duration: number, volume: number) => void;
+    fadeOut: (soundName: keyof T, duration: number, targetVolume?: number) => void;
+    reset: (sound: keyof T) => void;
+    setTimePosition: (sound: keyof T, timePosition: number) => void;
+    stopAll: (reset?: true) => void;
+    preload: (sound: keyof T) => void;
+    setGlobalVolume: (volume: number) => void;
+    setVolume: (sound: keyof T, volume: number) => void;
+    resetAll: (sound: keyof T) => void;
+    onEnd: (sound: keyof T, callback: () => void) => void;
 };

package/out/core/createSoundRegistry.luau

@@ -1,9 +1,8 @@
 -- Compiled with roblox-ts v3.0.0
 --[[
 	*
-	 * 
+	 * Create a sound Registry
 	 * @param definitions Define the Sounds
-	 * @returns 
 	 
 ]]
 local function createSoundRegistry(definitions)
@@ -16,9 +15,8 @@ local function createSoundRegistry(definitions)
 	end
 	--[[
 		*
-		     * 
+		     * Loads a Sound
 		     * @param name Define which Sound should be loaded
-		     * @returns 
 		     
 	]]
 	local function load(name)
@@ -43,7 +41,7 @@ local function createSoundRegistry(definitions)
 	end
 	--[[
 		*
-		     * 
+		     * Plays a Sound
 		     * @param name Define which Sound should be played
 		     
 	]]
@@ -57,7 +55,7 @@ local function createSoundRegistry(definitions)
 	end
 	--[[
 		*
-		     * 
+		     * Stops a Sound
 		     * @param name Define which Sound should be stopped
 		     
 	]]
@@ -78,11 +76,188 @@ local function createSoundRegistry(definitions)
 			load(name)
 		end
 	end
+	--[[
+		*
+		     * Smoothly fad in a sound
+		     * @param soundName Sound Instance
+		     * @param duration Time in Seconds
+		     * @param volume Volume
+		     
+	]]
+	local function fadeIn(soundName, duration, volume)
+		local sound = folder:FindFirstChild(soundName)
+		sound.Volume = 0
+		sound:Play()
+		local step = 0.05
+		local interval = duration * step
+		task.spawn(function()
+			local vol = 0
+			while vol < volume do
+				vol += step
+				sound.Volume = math.clamp(vol, 0, volume)
+				task.wait(interval)
+			end
+		end)
+	end
+	--[[
+		*
+		     * Smoothly fade out a sound
+		     * @param soundName Sound name from Registry
+		     * @param duration Time in seconds
+		     * @param targetVolume Optional target volume (default 0)
+		     
+	]]
+	local function fadeOut(soundName, duration, targetVolume)
+		local sound = folder:FindFirstChild(soundName)
+		if not sound then
+			return nil
+		end
+		local startVolume = sound.Volume
+		local _condition = targetVolume
+		if _condition == nil then
+			_condition = 0
+		end
+		local endVolume = _condition
+		local step = 0.05
+		local interval = duration * step
+		task.spawn(function()
+			local vol = startVolume
+			while vol > endVolume do
+				vol = math.clamp(vol - step, endVolume, startVolume)
+				sound.Volume = vol
+				task.wait(interval)
+			end
+			sound.Volume = endVolume
+			if endVolume == 0 then
+				sound:Stop()
+			end
+		end)
+	end
+	--[[
+		*
+		     * Reset a Sound
+		     * @param sound Sound Instance
+		     
+	]]
+	local function reset(sound)
+		local _sound = folder:FindFirstChild(sound)
+		if not (sound ~= 0 and sound == sound and sound ~= "" and sound) then
+			return nil
+		end
+		_sound.TimePosition = 0
+	end
+	--[[
+		*
+		     * Reset every Sound
+		     * @param sound Sound Instance
+		     
+	]]
+	local function resetAll(sound)
+		for _, sound in folder:GetChildren() do
+			if sound:IsA("Sound") then
+				sound.TimePosition = 0
+			end
+		end
+	end
+	--[[
+		*
+		     * Set Time Position
+		     * @param sound Sound Instance
+		     * @param timePosition Time Position
+		     
+	]]
+	local function setTimePosition(sound, timePosition)
+		local _sound = folder:FindFirstChild(sound)
+		if not (sound ~= 0 and sound == sound and sound ~= "" and sound) then
+			return nil
+		end
+		_sound.TimePosition = timePosition
+	end
+	--[[
+		*
+		     * Stop every Sound
+		     * @param reset Define whether every Sound should also be reset?
+		     
+	]]
+	local function stopAll(reset)
+		for _, instance in folder:GetChildren() do
+			if not instance:IsA("Sound") then
+				continue
+			end
+			instance:Stop()
+			if reset then
+				instance.TimePosition = 0
+			end
+		end
+	end
+	--[[
+		*
+		     * Set Sound Volume
+		     * @param sound Sound Instance
+		     * @param volume Sound Volume
+		     
+	]]
+	local function setVolume(sound, volume)
+		local _sound = folder:FindFirstChild(sound)
+		if not (sound ~= 0 and sound == sound and sound ~= "" and sound) then
+			return nil
+		end
+		_sound.Volume = volume
+	end
+	--[[
+		*
+		     * Set the global Sound Volume
+		     * @param volume Sound Volume
+		     
+	]]
+	local function setGlobalVolume(volume)
+		for _, instance in folder:GetChildren() do
+			if not instance:IsA("Sound") then
+				continue
+			end
+			if instance:IsA("Sound") then
+				instance.Volume = volume
+			end
+		end
+	end
+	--[[
+		*
+		     * Plays Sound on Event Callback
+		     * @param name Sound Name
+		     * @param callback Callback
+		     
+	]]
+	local function onEnd(sound, callback)
+		local _sound = folder:WaitForChild(sound)
+		if not _sound then
+			return nil
+		end
+		_sound.Ended:Connect(callback)
+	end
+	--[[
+		*
+		     * Preloads a Sound
+		     * @param sound Sound Instance
+		     
+	]]
+	local function preload(sound)
+		load(sound)
+	end
 	return {
 		play = play,
 		stop = stop,
 		preloadAll = preloadAll,
 		load = load,
+		fadeIn = fadeIn,
+		fadeOut = fadeOut,
+		reset = reset,
+		setTimePosition = setTimePosition,
+		stopAll = stopAll,
+		preload = preload,
+		setGlobalVolume = setGlobalVolume,
+		setVolume = setVolume,
+		resetAll = resetAll,
+		onEnd = onEnd,
 	}
 end
 return {

package/out/core/options.d.ts

@@ -3,3 +3,13 @@ export interface SoundOptions {
     loop?: boolean;
     id: string;
 }
+interface SoundDefinition {
+    id: string;
+    volume?: number;
+    loop?: boolean;
+}
+export interface CategoryOptions {
+    category: string;
+    sounds: Record<string, SoundDefinition>;
+}
+export {};

package/out/index.d.ts

@@ -1 +1,2 @@
 export * from "./core/createSoundRegistry";
+export * from "./core/createSoundCategoryRegistry";

package/out/init.luau

@@ -4,4 +4,7 @@ local exports = {}
 for _k, _v in TS.import(script, script, "core", "createSoundRegistry") or {} do
 	exports[_k] = _v
 end
+for _k, _v in TS.import(script, script, "core", "createSoundCategoryRegistry") or {} do
+	exports[_k] = _v
+end
 return exports

package/package.json

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

package/out/core/test.d.ts

@@ -1 +0,0 @@
-export {};

package/out/core/test.luau

@@ -1,11 +0,0 @@
--- Compiled with roblox-ts v3.0.0
-local TS = _G[script]
-local createSoundRegistry = TS.import(script, script.Parent, "createSoundRegistry").createSoundRegistry
-local Sounds = createSoundRegistry({
-	Exlposion = {
-		id = "rbxassetid://1",
-		volume = 0.5,
-		loop = false,
-	},
-})
-return nil