@quenty/soundplayer 7.19.3 → 7.19.4-canary.11a5dcf.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [7.19.4-canary.11a5dcf.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/soundplayer@7.19.3...@quenty/soundplayer@7.19.4-canary.11a5dcf.0) (2025-05-10)
+
+
+### Features
+
+* Add even more types ([b31717d](https://github.com/Quenty/NevermoreEngine/commit/b31717d8c9f7620c457f5018a2affa760a65334a))
+
+
+
+
+
 ## [7.19.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/soundplayer@7.19.2...@quenty/soundplayer@7.19.3) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/soundplayer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/soundplayer",
-  "version": "7.19.3",
+  "version": "7.19.4-canary.11a5dcf.0",
   "description": "Sound playback helper",
   "keywords": [
     "Roblox",
@@ -25,28 +25,28 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/adorneeutils": "^3.3.3",
-    "@quenty/baseobject": "^10.8.3",
-    "@quenty/blend": "^12.18.3",
-    "@quenty/brio": "^14.17.3",
-    "@quenty/instanceutils": "^13.17.3",
-    "@quenty/loader": "^10.8.3",
-    "@quenty/maid": "^3.4.3",
-    "@quenty/numberrangeutils": "^3.1.1",
-    "@quenty/promise": "^10.10.4",
-    "@quenty/promisemaid": "^5.10.4",
-    "@quenty/randomutils": "^6.10.3",
-    "@quenty/rbxasset": "^5.8.3",
-    "@quenty/rx": "^13.17.3",
-    "@quenty/signal": "^7.10.3",
-    "@quenty/sounds": "^10.10.4",
-    "@quenty/table": "^3.7.4",
-    "@quenty/transitionmodel": "^7.19.3",
-    "@quenty/valueobject": "^13.17.3",
+    "@quenty/adorneeutils": "3.3.3",
+    "@quenty/baseobject": "10.8.4-canary.11a5dcf.0",
+    "@quenty/blend": "12.18.4-canary.11a5dcf.0",
+    "@quenty/brio": "14.17.4-canary.11a5dcf.0",
+    "@quenty/instanceutils": "13.17.4-canary.11a5dcf.0",
+    "@quenty/loader": "10.8.4-canary.11a5dcf.0",
+    "@quenty/maid": "3.4.4-canary.11a5dcf.0",
+    "@quenty/numberrangeutils": "3.1.1",
+    "@quenty/promise": "10.10.5-canary.11a5dcf.0",
+    "@quenty/promisemaid": "5.10.5-canary.11a5dcf.0",
+    "@quenty/randomutils": "6.10.4-canary.11a5dcf.0",
+    "@quenty/rbxasset": "5.8.4-canary.11a5dcf.0",
+    "@quenty/rx": "13.17.4-canary.11a5dcf.0",
+    "@quenty/signal": "7.10.4-canary.11a5dcf.0",
+    "@quenty/sounds": "10.10.5-canary.11a5dcf.0",
+    "@quenty/table": "3.7.5-canary.11a5dcf.0",
+    "@quenty/transitionmodel": "7.19.4-canary.11a5dcf.0",
+    "@quenty/valueobject": "13.17.4-canary.11a5dcf.0",
     "@quentystudios/t": "^3.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
+  "gitHead": "11a5dcf7d4c7a0bfbf3337e97d30e8346ea09d3f"
 }

package/src/Client/Loops/Layered/LayeredLoopedSoundPlayer.lua

@@ -4,13 +4,14 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local SpringTransitionModel = require("SpringTransitionModel")
-local ValueObject = require("ValueObject")
 local LoopedSoundPlayer = require("LoopedSoundPlayer")
 local Maid = require("Maid")
 local Rx = require("Rx")
-local SoundUtils = require("SoundUtils")
 local SoundLoopScheduleUtils = require("SoundLoopScheduleUtils")
+local SoundUtils = require("SoundUtils")
+local SpringTransitionModel = require("SpringTransitionModel")
+local ValueObject = require("ValueObject")
+local t = require("t")
 
 local LayeredLoopedSoundPlayer = setmetatable({}, SpringTransitionModel)
 LayeredLoopedSoundPlayer.ClassName = "LayeredLoopedSoundPlayer"
@@ -21,9 +22,9 @@ function LayeredLoopedSoundPlayer.new(soundParent)
 
 	self._layerMaid = self._maid:Add(Maid.new())
 
-	self._soundParent = self._maid:Add(ValueObject.new(nil))
-	self._soundGroup = self._maid:Add(ValueObject.new(nil))
-	self._bpm = self._maid:Add(ValueObject.new(nil))
+	self._soundParent = self._maid:Add(ValueObject.new(nil, t.optional(t.Instance)))
+	self._soundGroup = self._maid:Add(ValueObject.new(nil, t.optional(t.Instance)))
+	self._bpm = self._maid:Add(ValueObject.new(nil, t.optional(t.number)))
 	self._defaultCrossFadeTime = self._maid:Add(ValueObject.new(0.5, "number"))
 	self._volumeMultiplier = self._maid:Add(ValueObject.new(1, "number"))
 
@@ -36,32 +37,30 @@ function LayeredLoopedSoundPlayer.new(soundParent)
 	return self
 end
 
-function LayeredLoopedSoundPlayer:SetDefaultCrossFadeTime(crossFadeTime)
+function LayeredLoopedSoundPlayer:SetDefaultCrossFadeTime(crossFadeTime: ValueObject.Mountable<number>)
 	return self._defaultCrossFadeTime:Mount(crossFadeTime)
 end
 
-function LayeredLoopedSoundPlayer:SetVolumeMultiplier(volumeMultiplier)
-	self._volumeMultiplier.Value = volumeMultiplier
+function LayeredLoopedSoundPlayer:SetVolumeMultiplier(volumeMultiplier: ValueObject.Mountable<number>)
+	return self._volumeMultiplier:Mount(volumeMultiplier)
 end
 
-function LayeredLoopedSoundPlayer:SetBPM(bpm)
-	assert(type(bpm) == "number" or bpm == nil, "Bad bpm")
-
+function LayeredLoopedSoundPlayer:SetBPM(bpm: ValueObject.Mountable<number?>)
 	self._bpm.Value = bpm
 end
 
-function LayeredLoopedSoundPlayer:SetSoundParent(soundParent)
+function LayeredLoopedSoundPlayer:SetSoundParent(soundParent: Instance?)
 	assert(typeof(soundParent) == "Instance" or soundParent == nil, "Bad soundParent")
 
 	self._soundParent.Value = soundParent
 end
 
-function LayeredLoopedSoundPlayer:SetSoundGroup(soundGroup)
+function LayeredLoopedSoundPlayer:SetSoundGroup(soundGroup: SoundGroup?)
 	return self._soundGroup:Mount(soundGroup)
 end
 
-function LayeredLoopedSoundPlayer:Swap(layerId, soundId, scheduleOptions)
-	assert(type(layerId) == "string", 'Bad layerId')
+function LayeredLoopedSoundPlayer:Swap(layerId: string, soundId, scheduleOptions)
+	assert(type(layerId) == "string", "Bad layerId")
 	assert(SoundUtils.isConvertableToRbxAsset(soundId) or soundId == nil, "Bad soundId")
 	assert(SoundLoopScheduleUtils.isLoopedSchedule(scheduleOptions) or scheduleOptions == nil, "Bad scheduleOptions")
 
@@ -70,7 +69,7 @@ function LayeredLoopedSoundPlayer:Swap(layerId, soundId, scheduleOptions)
 end
 
 function LayeredLoopedSoundPlayer:SwapOnLoop(layerId, soundId, scheduleOptions)
-	assert(type(layerId) == "string", 'Bad layerId')
+	assert(type(layerId) == "string", "Bad layerId")
 	assert(SoundUtils.isConvertableToRbxAsset(soundId) or soundId == nil, "Bad soundId")
 
 	local layer = self:_getOrCreateLayer(layerId)
@@ -78,7 +77,7 @@ function LayeredLoopedSoundPlayer:SwapOnLoop(layerId, soundId, scheduleOptions)
 end
 
 function LayeredLoopedSoundPlayer:SwapToSamples(layerId, soundId, scheduleOptions)
-	assert(type(layerId) == "string", 'Bad layerId')
+	assert(type(layerId) == "string", "Bad layerId")
 	assert(SoundUtils.isConvertableToRbxAsset(soundId) or soundId == nil, "Bad soundId")
 	assert(SoundLoopScheduleUtils.isLoopedSchedule(scheduleOptions) or scheduleOptions == nil, "Bad scheduleOptions")
 
@@ -87,7 +86,7 @@ function LayeredLoopedSoundPlayer:SwapToSamples(layerId, soundId, scheduleOption
 end
 
 function LayeredLoopedSoundPlayer:SwapToChoice(layerId, soundIdList, scheduleOptions)
-	assert(type(layerId) == "string", 'Bad layerId')
+	assert(type(layerId) == "string", "Bad layerId")
 	assert(type(soundIdList) == "table", "Bad soundIdList")
 	assert(SoundLoopScheduleUtils.isLoopedSchedule(scheduleOptions) or scheduleOptions == nil, "Bad scheduleOptions")
 
@@ -96,7 +95,7 @@ function LayeredLoopedSoundPlayer:SwapToChoice(layerId, soundIdList, scheduleOpt
 end
 
 function LayeredLoopedSoundPlayer:PlayOnce(layerId, soundIdList, scheduleOptions)
-	assert(type(layerId) == "string", 'Bad layerId')
+	assert(type(layerId) == "string", "Bad layerId")
 	assert(type(soundIdList) == "table", "Bad soundIdList")
 	assert(SoundLoopScheduleUtils.isLoopedSchedule(scheduleOptions) or scheduleOptions == nil, "Bad scheduleOptions")
 
@@ -105,14 +104,14 @@ function LayeredLoopedSoundPlayer:PlayOnce(layerId, soundIdList, scheduleOptions
 end
 
 function LayeredLoopedSoundPlayer:PlayOnceOnLoop(layerId, soundId, scheduleOptions)
-	assert(type(layerId) == "string", 'Bad layerId')
+	assert(type(layerId) == "string", "Bad layerId")
 
 	local layer = self:_getOrCreateLayer(layerId)
 	layer:PlayOnceOnLoop(soundId, scheduleOptions)
 end
 
 function LayeredLoopedSoundPlayer:_getOrCreateLayer(layerId)
-	if 	self._layers[layerId] then
+	if self._layers[layerId] then
 		return self._layers[layerId]
 	end
 
@@ -140,10 +139,10 @@ function LayeredLoopedSoundPlayer:_getOrCreateLayer(layerId)
 	end))
 
 	maid:GiveTask(Rx.combineLatest({
-		visible = self:ObserveRenderStepped();
-		multiplier = self._volumeMultiplier:Observe();
+		visible = self:ObserveRenderStepped(),
+		multiplier = self._volumeMultiplier:Observe(),
 	}):Subscribe(function(state)
-		layer:SetVolumeMultiplier(state.multiplier*state.visible)
+		layer:SetVolumeMultiplier(state.multiplier * state.visible)
 	end))
 
 	self._layers[layerId] = layer
@@ -168,4 +167,4 @@ function LayeredLoopedSoundPlayer:StopAll()
 	self._layerMaid:DoCleaning()
 end
 
-return LayeredLoopedSoundPlayer
+return LayeredLoopedSoundPlayer

package/src/Client/Loops/Layered/LayeredLoopedSoundPlayer.story.lua

@@ -2,11 +2,12 @@
 	@class LayeredLoopedSoundPlayer.story
 ]]
 
-local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
+local require =
+	require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
 
-local Maid = require("Maid")
-local LayeredLoopedSoundPlayer = require("LayeredLoopedSoundPlayer")
 local Blend = require("Blend")
+local LayeredLoopedSoundPlayer = require("LayeredLoopedSoundPlayer")
+local Maid = require("Maid")
 
 return function(target)
 	local maid = Maid.new()
@@ -19,23 +20,23 @@ return function(target)
 	local function initial()
 		layeredLoopedSoundPlayer:SwapToChoice("drums", {
 			{
-				SoundId = "rbxassetid://14478151709";
-				Volume = 0.1;
-			};
+				SoundId = "rbxassetid://14478151709",
+				Volume = 0.1,
+			},
 			{
-				SoundId = "rbxassetid://14478738244";
-				Volume = 0.1;
-			}
+				SoundId = "rbxassetid://14478738244",
+				Volume = 0.1,
+			},
 		})
 		layeredLoopedSoundPlayer:SwapToChoice("rifts", {
 			{
-				SoundId = "rbxassetid://14478152812";
-				Volume = 0.2;
-			};
+				SoundId = "rbxassetid://14478152812",
+				Volume = 0.2,
+			},
 			{
-				SoundId = "rbxassetid://14478729478";
-				Volume = 0.015;
-			};
+				SoundId = "rbxassetid://14478729478",
+				Volume = 0.015,
+			},
 		})
 	end
 	initial()
@@ -44,117 +45,112 @@ return function(target)
 
 	local function button(props)
 		return Blend.New "TextButton" {
-			Text = props.Text;
-			AutoButtonColor = true;
-			Font = Enum.Font.FredokaOne;
-			Size = UDim2.new(0, 100, 0, 30);
-
-			Blend.New "UICorner" {
+			Text = props.Text,
+			AutoButtonColor = true,
+			Font = Enum.Font.FredokaOne,
+			Size = UDim2.new(0, 100, 0, 30),
 
-			};
+			Blend.New "UICorner" {},
 
 			[Blend.OnEvent "Activated"] = function()
-				props.OnActivated();
-			end;
-		};
+				props.OnActivated()
+			end,
+		}
 	end
 
 	maid:GiveTask(Blend.mount(target, {
 		Blend.New "Frame" {
-			Name = "ButtonContainer";
-			BackgroundTransparency = 1;
-			Position = UDim2.new(0.5, 0, 0, 5);
-			AnchorPoint = Vector2.new(0.5, 0);
-			Size = UDim2.new(1, 0, 0, 30);
+			Name = "ButtonContainer",
+			BackgroundTransparency = 1,
+			Position = UDim2.new(0.5, 0, 0, 5),
+			AnchorPoint = Vector2.new(0.5, 0),
+			Size = UDim2.new(1, 0, 0, 30),
 
 			Blend.New "UIListLayout" {
-				FillDirection = Enum.FillDirection.Horizontal;
-				Padding = UDim.new(0, 5);
-				HorizontalAlignment = Enum.HorizontalAlignment.Center;
-			};
+				FillDirection = Enum.FillDirection.Horizontal,
+				Padding = UDim.new(0, 5),
+				HorizontalAlignment = Enum.HorizontalAlignment.Center,
+			},
 
 			button({
-				Text = "Toggle";
+				Text = "Toggle",
 				OnActivated = function()
 					layeredLoopedSoundPlayer:Toggle()
-				end;
-			});
+				end,
+			}),
 
 			button({
-				Text = "Reset";
+				Text = "Reset",
 				OnActivated = function()
 					initial()
-				end;
-			});
+				end,
+			}),
 
 			button({
-				Text = "Combat equip";
+				Text = "Combat equip",
 				OnActivated = function()
 					layeredLoopedSoundPlayer:SwapToChoice("drums", {
-						"rbxassetid://14478154829";
-						"rbxassetid://14478714545";
-						"rbxassetid://14478772830";
-						"rbxassetid://14478897865";
+						"rbxassetid://14478154829",
+						"rbxassetid://14478714545",
+						"rbxassetid://14478772830",
+						"rbxassetid://14478897865",
 					})
 					layeredLoopedSoundPlayer:PlayOnceOnLoop("rifts", nil)
-				end;
-			});
+				end,
+			}),
 
 			button({
-				Text = "On target lock";
+				Text = "On target lock",
 				OnActivated = function()
 					layeredLoopedSoundPlayer:SwapToChoice("drums", {
 						{
-							SoundId = "rbxassetid://14478150956";
-							Volume = 0.1;
-						};
+							SoundId = "rbxassetid://14478150956",
+							Volume = 0.1,
+						},
 						{
-							SoundId = "rbxassetid://14478721669";
-							Volume = 0.2;
-						};
-						"rbxassetid://14478154829";
-						"rbxassetid://14478764914";
+							SoundId = "rbxassetid://14478721669",
+							Volume = 0.2,
+						},
+						"rbxassetid://14478154829",
+						"rbxassetid://14478764914",
 					})
 
 					layeredLoopedSoundPlayer:SwapToChoice("rifts", {
-						"rbxassetid://14478145963";
-						"rbxassetid://14478156714";
+						"rbxassetid://14478145963",
+						"rbxassetid://14478156714",
 						{
-							SoundId = "rbxassetid://14478777472";
-							Volume = 0.1;
-						};
+							SoundId = "rbxassetid://14478777472",
+							Volume = 0.1,
+						},
 						{
-							SoundId = "rbxassetid://14478793045";
-							Volume = 0.1;
-						};
+							SoundId = "rbxassetid://14478793045",
+							Volume = 0.1,
+						},
 					})
-				end;
-			});
+				end,
+			}),
 
 			button({
-				Text = "On low health";
+				Text = "On low health",
 				OnActivated = function()
 					layeredLoopedSoundPlayer:SwapToChoice("drums", {
-						"rbxassetid://14478746326";
-						"rbxassetid://14478767498";
-						"rbxassetid://14478797936"; -- record scratch
+						"rbxassetid://14478746326",
+						"rbxassetid://14478767498",
+						"rbxassetid://14478797936", -- record scratch
 					})
-
-				end;
-			});
-
+				end,
+			}),
 
 			button({
-				Text = "Target drop";
+				Text = "Target drop",
 				OnActivated = function()
 					layeredLoopedSoundPlayer:PlayOnceOnLoop("rifts", "rbxassetid://14478158396")
-				end;
-			});
-		}
+				end,
+			}),
+		},
 	}))
 
-
 	return function()
 		maid:DoCleaning()
 	end
-end
+end

package/src/Client/Loops/LoopedSoundPlayer.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class LoopedSoundPlayer
 ]=]
@@ -25,13 +26,31 @@ local LoopedSoundPlayer = setmetatable({}, SpringTransitionModel)
 LoopedSoundPlayer.ClassName = "LoopedSoundPlayer"
 LoopedSoundPlayer.__index = LoopedSoundPlayer
 
-function LoopedSoundPlayer.new(soundId, soundParent: Instance?)
-	assert(SoundUtils.isConvertableToRbxAsset(soundId) or soundId == nil, "Bad soundId")
-
-	local self = setmetatable(SpringTransitionModel.new(), LoopedSoundPlayer)
-
-	self._currentSoundLooped = self._maid:Add(Signal.new())
-	self._currentSoundLoopedAfterDelay = self._maid:Add(Signal.new())
+export type LoopedSoundPlayer = typeof(setmetatable(
+	{} :: {
+		_currentSoundLooped: Signal.Signal<()>,
+		_currentSoundLoopedAfterDelay: Signal.Signal<()>,
+		_bpm: ValueObject.ValueObject<number?>,
+		_soundParent: ValueObject.ValueObject<Instance?>,
+		_soundGroup: ValueObject.ValueObject<SoundGroup?>,
+		_crossFadeTime: ValueObject.ValueObject<number>,
+		_volumeMultiplier: ValueObject.ValueObject<number>,
+		_doSyncSoundPlayback: ValueObject.ValueObject<boolean>,
+		_currentActiveSound: ValueObject.ValueObject<Sound?>,
+		_currentSoundId: ValueObject.ValueObject<(string | number)?>,
+		_defaultScheduleOptions: SoundLoopScheduleUtils.SoundLoopSchedule,
+		_currentLoopSchedule: ValueObject.ValueObject<SoundLoopScheduleUtils.SoundLoopSchedule>,
+	},
+	{} :: typeof({ __index = LoopedSoundPlayer })
+)) & SpringTransitionModel.SpringTransitionModel<number>
+
+function LoopedSoundPlayer.new(soundId: (string | number)?, soundParent: Instance?)
+	assert(soundId == nil or SoundUtils.isConvertableToRbxAsset(soundId), "Bad soundId")
+
+	local self: LoopedSoundPlayer = setmetatable(SpringTransitionModel.new() :: any, LoopedSoundPlayer)
+
+	self._currentSoundLooped = self._maid:Add(Signal.new() :: any)
+	self._currentSoundLoopedAfterDelay = self._maid:Add(Signal.new() :: any)
 
 	self:SetSpeed(10)
 
@@ -60,29 +79,29 @@ function LoopedSoundPlayer.new(soundId, soundParent: Instance?)
 	return self
 end
 
-function LoopedSoundPlayer:SetCrossFadeTime(crossFadeTime: number)
+function LoopedSoundPlayer.SetCrossFadeTime(self: LoopedSoundPlayer, crossFadeTime: number)
 	return self._crossFadeTime:Mount(crossFadeTime)
 end
 
-function LoopedSoundPlayer:SetVolumeMultiplier(volume: number)
+function LoopedSoundPlayer.SetVolumeMultiplier(self: LoopedSoundPlayer, volume: number)
 	self._volumeMultiplier.Value = volume
 end
 
-function LoopedSoundPlayer:SetSoundGroup(soundGroup: SoundGroup?)
+function LoopedSoundPlayer.SetSoundGroup(self: LoopedSoundPlayer, soundGroup: SoundGroup?)
 	return self._soundGroup:Mount(soundGroup)
 end
 
-function LoopedSoundPlayer:SetBPM(bpm: number?)
+function LoopedSoundPlayer.SetBPM(self: LoopedSoundPlayer, bpm: number?)
 	assert(type(bpm) == "number" or bpm == nil, "Bad bpm")
 
 	self._bpm.Value = bpm
 end
 
-function LoopedSoundPlayer:SetSoundParent(parent: Instance?)
+function LoopedSoundPlayer.SetSoundParent(self: LoopedSoundPlayer, parent: Instance?)
 	self._soundParent.Value = parent
 end
 
-function LoopedSoundPlayer:Swap(soundId, loopSchedule)
+function LoopedSoundPlayer.Swap(self: LoopedSoundPlayer, soundId, loopSchedule)
 	assert(SoundUtils.isConvertableToRbxAsset(soundId) or soundId == nil, "Bad soundId")
 	loopSchedule = self:_convertToLoopedSchedule(loopSchedule)
 
@@ -96,11 +115,11 @@ function LoopedSoundPlayer:Swap(soundId, loopSchedule)
 	self._maid._swappingTo = maid
 end
 
-function LoopedSoundPlayer:SetDoSyncSoundPlayback(doSyncSoundPlayback: boolean)
+function LoopedSoundPlayer.SetDoSyncSoundPlayback(self: LoopedSoundPlayer, doSyncSoundPlayback: boolean)
 	self._doSyncSoundPlayback.Value = doSyncSoundPlayback
 end
 
-function LoopedSoundPlayer:_setupRender()
+function LoopedSoundPlayer._setupRender(self: LoopedSoundPlayer)
 	self._maid:GiveTask(self._currentSoundId
 		:ObserveBrio(function(value)
 			return value ~= nil
@@ -117,7 +136,7 @@ function LoopedSoundPlayer:_setupRender()
 		end))
 end
 
-function LoopedSoundPlayer:_renderSoundPlayer(soundId)
+function LoopedSoundPlayer._renderSoundPlayer(self: LoopedSoundPlayer, soundId)
 	local maid = Maid.new()
 
 	local renderMaid = Maid.new()
@@ -133,7 +152,7 @@ function LoopedSoundPlayer:_renderSoundPlayer(soundId)
 		isLoaded = Rx.fromPromise(SoundPromiseUtils.promiseLoaded(soundPlayer.Sound)),
 		doSyncSoundPlayback = self._doSyncSoundPlayback:Observe(),
 		timeLength = RxInstanceUtils.observeProperty(soundPlayer.Sound, "TimeLength"),
-	}):Subscribe(function(state)
+	}):Subscribe(function(state: any)
 		local syncMaid = Maid.new()
 
 		if state.doSyncSoundPlayback then
@@ -197,7 +216,7 @@ function LoopedSoundPlayer:_renderSoundPlayer(soundId)
 	maid:GiveTask(Rx.combineLatest({
 		visible = self:ObserveRenderStepped(),
 		multiplier = self._volumeMultiplier:Observe(),
-	}):Subscribe(function(state)
+	}):Subscribe(function(state: any)
 		soundPlayer:SetVolumeMultiplier(state.multiplier * state.visible)
 	end))
 
@@ -214,7 +233,7 @@ function LoopedSoundPlayer:_renderSoundPlayer(soundId)
 	return maid
 end
 
-function LoopedSoundPlayer:_setupLoopScheduling(soundPlayer, loopSchedule)
+function LoopedSoundPlayer._setupLoopScheduling(self: LoopedSoundPlayer, soundPlayer, loopSchedule)
 	local maid = Maid.new()
 
 	if loopSchedule.maxLoops then
@@ -249,7 +268,7 @@ function LoopedSoundPlayer:_setupLoopScheduling(soundPlayer, loopSchedule)
 	return maid
 end
 
-function LoopedSoundPlayer:SwapToSamples(soundIdList, loopSchedule)
+function LoopedSoundPlayer.SwapToSamples(self: LoopedSoundPlayer, soundIdList, loopSchedule)
 	assert(type(soundIdList) == "table", "Bad soundIdList")
 	loopSchedule = self:_convertToLoopedSchedule(loopSchedule)
 
@@ -268,7 +287,7 @@ function LoopedSoundPlayer:SwapToSamples(soundIdList, loopSchedule)
 	self._maid._swappingTo = loopMaid
 end
 
-function LoopedSoundPlayer:SwapToChoice(soundIdList, loopSchedule)
+function LoopedSoundPlayer.SwapToChoice(self: LoopedSoundPlayer, soundIdList, loopSchedule)
 	assert(type(soundIdList) == "table", "Bad soundIdList")
 	loopSchedule = self:_convertToLoopedSchedule(loopSchedule)
 
@@ -286,39 +305,39 @@ function LoopedSoundPlayer:SwapToChoice(soundIdList, loopSchedule)
 	self._maid._swappingTo = loopMaid
 end
 
-function LoopedSoundPlayer:PlayOnce(soundId, loopSchedule)
+function LoopedSoundPlayer.PlayOnce(self: LoopedSoundPlayer, soundId, loopSchedule)
 	assert(SoundUtils.isConvertableToRbxAsset(soundId) or soundId == nil, "Bad soundId")
 	loopSchedule = self:_convertToLoopedSchedule(loopSchedule)
 
 	self:Swap(soundId, SoundLoopScheduleUtils.maxLoops(1, loopSchedule))
 end
 
-function LoopedSoundPlayer:SwapOnLoop(soundId, loopSchedule)
+function LoopedSoundPlayer.SwapOnLoop(self: LoopedSoundPlayer, soundId, loopSchedule)
 	assert(SoundUtils.isConvertableToRbxAsset(soundId) or soundId == nil, "Bad soundId")
 	loopSchedule = self:_convertToLoopedSchedule(loopSchedule)
 
 	self:Swap(soundId, SoundLoopScheduleUtils.onNextLoop(loopSchedule))
 end
 
-function LoopedSoundPlayer:PlayOnceOnLoop(soundId, loopSchedule)
+function LoopedSoundPlayer.PlayOnceOnLoop(self: LoopedSoundPlayer, soundId, loopSchedule)
 	assert(SoundUtils.isConvertableToRbxAsset(soundId) or soundId == nil, "Bad soundId")
 	loopSchedule = self:_convertToLoopedSchedule(loopSchedule)
 
 	self:PlayOnce(soundId, SoundLoopScheduleUtils.onNextLoop(loopSchedule))
 end
 
-function LoopedSoundPlayer:_convertToLoopedSchedule(loopSchedule)
+function LoopedSoundPlayer._convertToLoopedSchedule(self: LoopedSoundPlayer, loopSchedule)
 	assert(SoundLoopScheduleUtils.isLoopedSchedule(loopSchedule) or loopSchedule == nil, "Bad loopSchedule")
 	return loopSchedule or self._defaultScheduleOptions
 end
 
-function LoopedSoundPlayer:_scheduleFirstPlay(loopSchedule, callback)
+function LoopedSoundPlayer._scheduleFirstPlay(self: LoopedSoundPlayer, loopSchedule, callback)
 	assert(SoundLoopScheduleUtils.isLoopedSchedule(loopSchedule), "Bad loopSchedule")
 	assert(type(callback) == "function", "Bad callback")
 
 	local maid = Maid.new()
 
-	local observable = Rx.of(true)
+	local observable: any = Rx.of(true)
 	if loopSchedule.playOnNextLoop then
 		observable = observable:Pipe({
 			Rx.switchMap(function()
@@ -328,15 +347,15 @@ function LoopedSoundPlayer:_scheduleFirstPlay(loopSchedule, callback)
 				end
 
 				return self:_observeActiveSoundFinishLoop(waitTime)
-			end),
+			end) :: any,
 		})
 	end
 
 	if loopSchedule.initialDelay then
 		observable = observable:Pipe({
 			Rx.switchMap(function()
-				return Rx.delayed(SoundLoopScheduleUtils.getWaitTimeSeconds(loopSchedule.initialDelay))
-			end),
+				return Rx.delayed(SoundLoopScheduleUtils.getWaitTimeSeconds(loopSchedule.initialDelay)) :: any
+			end) :: any,
 		})
 	end
 
@@ -353,7 +372,7 @@ function LoopedSoundPlayer:_scheduleFirstPlay(loopSchedule, callback)
 	return maid
 end
 
-function LoopedSoundPlayer:StopAfterLoop()
+function LoopedSoundPlayer.StopAfterLoop(self: LoopedSoundPlayer)
 	local swapMaid = Maid.new()
 
 	swapMaid:GiveTask(self._currentSoundLooped:Connect(function()
@@ -365,22 +384,22 @@ function LoopedSoundPlayer:StopAfterLoop()
 	self._maid._swappingTo = swapMaid
 end
 
-function LoopedSoundPlayer:_observeActiveSoundFinishLoop(maxWaitTime)
+function LoopedSoundPlayer._observeActiveSoundFinishLoop(self: LoopedSoundPlayer, maxWaitTime)
 	local startTime = os.clock()
 
 	return self._currentActiveSound:Observe():Pipe({
-		Rx.throttleDefer();
-		Rx.switchMap(function(sound)
+		Rx.throttleDefer() :: any,
+		Rx.switchMap(function(sound): any
 			if not sound then
 				return Rx.of(true)
 			end
 
 			return Rx.combineLatest({
-				timeLength = RxInstanceUtils.observeProperty(sound, "TimeLength");
-				timePosition = RxInstanceUtils.observeProperty(sound, "TimePosition");
-				crossFadeTime = self._crossFadeTime:Observe();
+				timeLength = RxInstanceUtils.observeProperty(sound, "TimeLength"),
+				timePosition = RxInstanceUtils.observeProperty(sound, "TimePosition"),
+				crossFadeTime = self._crossFadeTime:Observe(),
 			}):Pipe({
-				Rx.switchMap(function(state)
+				Rx.switchMap(function(state: any): any
 					local timeElapsed = os.clock() - startTime
 					local timeRemaining
 					if maxWaitTime then
@@ -403,13 +422,13 @@ function LoopedSoundPlayer:_observeActiveSoundFinishLoop(maxWaitTime)
 					end
 
 					return Rx.delayed(waitTime)
-				end);
+				end) :: any,
 			})
-		end)
-	})
+		end) :: any,
+	}) :: any
 end
 
-function LoopedSoundPlayer:PromiseLoopDone()
+function LoopedSoundPlayer.PromiseLoopDone(self: LoopedSoundPlayer): Promise.Promise<()>
 	local promise = self._maid:GivePromise(Promise.new())
 
 	PromiseMaidUtils.whilePromise(promise, function(maid)
@@ -421,14 +440,13 @@ function LoopedSoundPlayer:PromiseLoopDone()
 	return promise
 end
 
-function LoopedSoundPlayer:PromiseSustain()
+function LoopedSoundPlayer.PromiseSustain(_self: LoopedSoundPlayer): Promise.Promise<()>
 	-- Never resolve (?)
 	return Promise.new()
 end
 
-
-function LoopedSoundPlayer:GetSound()
-	return self._sound
+function LoopedSoundPlayer.GetSound(self: LoopedSoundPlayer): Sound?
+	return self._currentActiveSound.Value
 end
 
-return LoopedSoundPlayer
+return LoopedSoundPlayer

package/src/Client/Loops/LoopedSoundPlayer.story.lua

@@ -2,13 +2,14 @@
 	@class LoopedSoundPlayer.story
 ]]
 
-local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
+local require =
+	require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
 
-local Maid = require("Maid")
-local LoopedSoundPlayer = require("LoopedSoundPlayer")
-local RandomUtils = require("RandomUtils")
 local Blend = require("Blend")
+local LoopedSoundPlayer = require("LoopedSoundPlayer")
 local LoopedSoundScheduleUtils = require("LoopedSoundScheduleUtils")
+local Maid = require("Maid")
+local RandomUtils = require("RandomUtils")
 
 return function(target)
 	local maid = Maid.new()
@@ -22,7 +23,7 @@ return function(target)
 	loopedSoundPlayer:SetSoundParent(target)
 
 	local OPTIONS = {
-		"rbxassetid://14477453689";
+		"rbxassetid://14477453689",
 	}
 
 	maid:GiveTask(task.spawn(function()
@@ -36,89 +37,90 @@ return function(target)
 
 	local function button(props)
 		return Blend.New "TextButton" {
-			Text = props.Text;
-			AutoButtonColor = true;
-			Font = Enum.Font.FredokaOne;
-			Size = UDim2.new(0, 100, 0, 30);
-
-			Blend.New "UICorner" {
+			Text = props.Text,
+			AutoButtonColor = true,
+			Font = Enum.Font.FredokaOne,
+			Size = UDim2.new(0, 100, 0, 30),
 
-			};
+			Blend.New "UICorner" {},
 
 			[Blend.OnEvent "Activated"] = function()
-				props.OnActivated();
-			end;
-		};
+				props.OnActivated()
+			end,
+		}
 	end
 
 	maid:GiveTask(Blend.mount(target, {
 		Blend.New "Frame" {
-			Name = "ButtonContainer";
-			BackgroundTransparency = 1;
-			Position = UDim2.new(0.5, 0, 0, 5);
-			AnchorPoint = Vector2.new(0.5, 0);
-			Size = UDim2.new(1, 0, 0, 30);
+			Name = "ButtonContainer",
+			BackgroundTransparency = 1,
+			Position = UDim2.new(0.5, 0, 0, 5),
+			AnchorPoint = Vector2.new(0.5, 0),
+			Size = UDim2.new(1, 0, 0, 30),
 
 			Blend.New "UIListLayout" {
-				FillDirection = Enum.FillDirection.Horizontal;
-				Padding = UDim.new(0, 5);
-				HorizontalAlignment = Enum.HorizontalAlignment.Center;
-			};
+				FillDirection = Enum.FillDirection.Horizontal,
+				Padding = UDim.new(0, 5),
+				HorizontalAlignment = Enum.HorizontalAlignment.Center,
+			},
 
 			button({
-				Text = "Toggle";
+				Text = "Toggle",
 				OnActivated = function()
 					loopedSoundPlayer:Toggle()
-				end;
-			});
+				end,
+			}),
 
 			button({
-				Text = "Reset";
+				Text = "Reset",
 				OnActivated = function()
 					loopedSoundPlayer:Swap(ORIGINAL)
-				end;
-			});
+				end,
+			}),
 
 			button({
-				Text = "Swap sample";
+				Text = "Swap sample",
 				OnActivated = function()
 					loopedSoundPlayer:SwapToSamples({
-						"rbxassetid://14478670277";
-						"rbxassetid://14478671494";
-						"rbxassetid://14478672676";
+						"rbxassetid://14478670277",
+						"rbxassetid://14478671494",
+						"rbxassetid://14478672676",
 					})
-				end;
-			});
+				end,
+			}),
 
 			button({
-				Text = "Play once";
+				Text = "Play once",
 				OnActivated = function()
 					loopedSoundPlayer:PlayOnce("rbxassetid://14478764914")
-				end;
-			});
+				end,
+			}),
 
 			button({
-				Text = "Play delayed loop";
+				Text = "Play delayed loop",
 				OnActivated = function()
-					loopedSoundPlayer:Swap({
-						SoundId ="rbxassetid://6052547865";
-						Volume = 3;
-					}, LoopedSoundScheduleUtils.schedule({
-						loopDelay = NumberRange.new(0.25, 1);
-					}))
-				end;
-			});
+					loopedSoundPlayer:Swap(
+						{
+							SoundId = "rbxassetid://6052547865",
+							Volume = 3,
+						},
+						LoopedSoundScheduleUtils.schedule({
+							loopDelay = NumberRange.new(0.25, 1),
+						})
+					)
+				end,
+			}),
 
 			button({
-				Text = "Swap on loop";
+				Text = "Swap on loop",
 				OnActivated = function()
 					loopedSoundPlayer:SwapOnLoop(RandomUtils.choice(OPTIONS))
-				end;
-			});
-		}
+				end,
+			}),
+		},
 	}))
 
 	return function()
 		maid:DoCleaning()
 	end
-end
+end

package/src/Client/Loops/SimpleLoopedSoundPlayer.lua

@@ -4,11 +4,11 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local TimedTransitionModel = require("TimedTransitionModel")
+local Promise = require("Promise")
 local Rx = require("Rx")
-local SoundUtils = require("SoundUtils")
 local SoundPromiseUtils = require("SoundPromiseUtils")
-local Promise = require("Promise")
+local SoundUtils = require("SoundUtils")
+local TimedTransitionModel = require("TimedTransitionModel")
 local ValueObject = require("ValueObject")
 
 local SimpleLoopedSoundPlayer = setmetatable({}, TimedTransitionModel)
@@ -29,10 +29,10 @@ function SimpleLoopedSoundPlayer.new(soundId)
 	self._maxVolume = self.Sound.Volume
 
 	self._maid:GiveTask(Rx.combineLatest({
-		visible = self:ObserveRenderStepped();
-		multiplier = self._volumeMultiplier:Observe();
+		visible = self:ObserveRenderStepped(),
+		multiplier = self._volumeMultiplier:Observe(),
 	}):Subscribe(function(state)
-		self.Sound.Volume = state.visible*self._maxVolume*state.multiplier
+		self.Sound.Volume = state.visible * self._maxVolume * state.multiplier
 	end))
 
 	self._maid:GiveTask(self.VisibleChanged:Connect(function(isVisible)
@@ -63,5 +63,4 @@ function SimpleLoopedSoundPlayer:PromiseLoopDone()
 	return SoundPromiseUtils.promiseLooped(self.Sound)
 end
 
-
-return SimpleLoopedSoundPlayer
+return SimpleLoopedSoundPlayer

package/src/Client/Loops/SimpleLoopedSoundPlayer.story.lua

@@ -2,11 +2,12 @@
 	@class SimpleLoopedSoundPlayer.story
 ]]
 
-local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
+local require =
+	require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
 
+local Blend = require("Blend")
 local Maid = require("Maid")
 local SimpleLoopedSoundPlayer = require("SimpleLoopedSoundPlayer")
-local Blend = require("Blend")
 
 return function(target)
 	local maid = Maid.new()
@@ -20,45 +21,43 @@ return function(target)
 
 	local function button(props)
 		return Blend.New "TextButton" {
-			Text = props.Text;
-			AutoButtonColor = true;
-			Font = Enum.Font.FredokaOne;
-			Size = UDim2.new(0, 100, 0, 30);
-
-			Blend.New "UICorner" {
+			Text = props.Text,
+			AutoButtonColor = true,
+			Font = Enum.Font.FredokaOne,
+			Size = UDim2.new(0, 100, 0, 30),
 
-			};
+			Blend.New "UICorner" {},
 
 			[Blend.OnEvent "Activated"] = function()
-				props.OnActivated();
-			end;
-		};
+				props.OnActivated()
+			end,
+		}
 	end
 
 	maid:GiveTask(Blend.mount(target, {
 		Blend.New "Frame" {
-			Name = "ButtonContainer";
-			BackgroundTransparency = 1;
-			Position = UDim2.new(0.5, 0, 0, 5);
-			AnchorPoint = Vector2.new(0.5, 0);
-			Size = UDim2.new(1, 0, 0, 30);
+			Name = "ButtonContainer",
+			BackgroundTransparency = 1,
+			Position = UDim2.new(0.5, 0, 0, 5),
+			AnchorPoint = Vector2.new(0.5, 0),
+			Size = UDim2.new(1, 0, 0, 30),
 
 			Blend.New "UIListLayout" {
-				FillDirection = Enum.FillDirection.Horizontal;
-				Padding = UDim.new(0, 5);
-				HorizontalAlignment = Enum.HorizontalAlignment.Center;
-			};
+				FillDirection = Enum.FillDirection.Horizontal,
+				Padding = UDim.new(0, 5),
+				HorizontalAlignment = Enum.HorizontalAlignment.Center,
+			},
 
 			button({
-				Text = "Toggle";
+				Text = "Toggle",
 				OnActivated = function()
 					simpleLoopedSoundPlayer:Toggle()
-				end;
-			});
-		}
+				end,
+			}),
+		},
 	}))
 
 	return function()
 		maid:DoCleaning()
 	end
-end
+end

package/src/Client/Schedule/SoundLoopScheduleUtils.lua

@@ -4,52 +4,60 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local t = require("t")
 local NumberRangeUtils = require("NumberRangeUtils")
 local Table = require("Table")
+local t = require("t")
 
 local SoundLoopScheduleUtils = {}
 
-function SoundLoopScheduleUtils.schedule(loopedSchedule)
+function SoundLoopScheduleUtils.schedule(loopedSchedule: SoundLoopSchedule): SoundLoopSchedule
 	assert(SoundLoopScheduleUtils.isLoopedSchedule(loopedSchedule))
 
 	return table.freeze(loopedSchedule)
 end
 
-function SoundLoopScheduleUtils.onNextLoop(loopedSchedule)
-assert(SoundLoopScheduleUtils.isLoopedSchedule(loopedSchedule) or loopedSchedule == nil, "Bad loopedSchedule")
+function SoundLoopScheduleUtils.onNextLoop(loopedSchedule: SoundLoopSchedule): SoundLoopSchedule
+	assert(SoundLoopScheduleUtils.isLoopedSchedule(loopedSchedule) or loopedSchedule == nil, "Bad loopedSchedule")
 
 	loopedSchedule = loopedSchedule or {}
 	return SoundLoopScheduleUtils.schedule(Table.merge(loopedSchedule, {
-		playOnNextLoop = true;
+		playOnNextLoop = true,
 	}))
 end
 
-function SoundLoopScheduleUtils.maxLoops(maxLoops, loopedSchedule)
+function SoundLoopScheduleUtils.maxLoops(maxLoops: number, loopedSchedule: SoundLoopSchedule): SoundLoopSchedule
 	assert(type(maxLoops) == "number", "Bad maxLoops")
 	assert(SoundLoopScheduleUtils.isLoopedSchedule(loopedSchedule) or loopedSchedule == nil, "Bad loopedSchedule")
 
 	loopedSchedule = loopedSchedule or {}
 	return SoundLoopScheduleUtils.schedule(Table.merge(loopedSchedule, {
-		maxLoops = maxLoops;
+		maxLoops = maxLoops,
 	}))
 end
 
-function SoundLoopScheduleUtils.default()
+function SoundLoopScheduleUtils.default(): SoundLoopSchedule
 	return SoundLoopScheduleUtils.schedule({})
 end
 
 SoundLoopScheduleUtils.isWaitTimeSeconds = t.union(t.number, t.NumberRange)
 
 SoundLoopScheduleUtils.isLoopedSchedule = t.interface({
-	playOnNextLoop = t.optional(t.boolean);
-	maxLoops = t.optional(t.number);
-	initialDelay = t.optional(SoundLoopScheduleUtils.isWaitTimeSeconds);
-	loopDelay = t.optional(SoundLoopScheduleUtils.isWaitTimeSeconds);
-	maxInitialWaitTimeForNextLoop = t.optional(SoundLoopScheduleUtils.isWaitTimeSeconds);
+	playOnNextLoop = t.optional(t.boolean),
+	maxLoops = t.optional(t.number),
+	initialDelay = t.optional(SoundLoopScheduleUtils.isWaitTimeSeconds),
+	loopDelay = t.optional(SoundLoopScheduleUtils.isWaitTimeSeconds),
+	maxInitialWaitTimeForNextLoop = t.optional(SoundLoopScheduleUtils.isWaitTimeSeconds),
 })
 
-function SoundLoopScheduleUtils.getWaitTimeSeconds(waitTime)
+export type SoundLoopSchedule = {
+	playOnNextLoop: boolean?,
+	maxLoops: number?,
+	initialDelay: number | NumberRange?,
+	loopDelay: number | NumberRange?,
+	maxInitialWaitTimeForNextLoop: number | NumberRange?,
+}
+
+function SoundLoopScheduleUtils.getWaitTimeSeconds(waitTime: number | NumberRange): number
 	assert(SoundLoopScheduleUtils.isWaitTimeSeconds(waitTime))
 
 	if type(waitTime) == "number" then
@@ -61,4 +69,4 @@ function SoundLoopScheduleUtils.getWaitTimeSeconds(waitTime)
 	end
 end
 
-return SoundLoopScheduleUtils
+return SoundLoopScheduleUtils