@quenty/randomutils 6.10.2 → 6.10.3

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [6.10.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/randomutils@6.10.2...@quenty/randomutils@6.10.3) (2025-04-10)
+
+**Note:** Version bump only for package @quenty/randomutils
+
+
+
+
+
 ## [6.10.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/randomutils@6.10.0...@quenty/randomutils@6.10.2) (2025-04-07)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/randomutils",
-  "version": "6.10.2",
+  "version": "6.10.3",
   "description": "Quenty's RandomUtils, utility functions for Roblox",
   "keywords": [
     "Roblox",
@@ -29,8 +29,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/loader": "^10.8.2",
-    "@quenty/table": "^3.7.3"
+    "@quenty/loader": "^10.8.3",
+    "@quenty/table": "^3.7.4"
   },
-  "gitHead": "64def70499ec067077ee39f279936b620b217847"
+  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
 }

package/src/Shared/RandomSampler.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class RandomSampler
 ]=]
@@ -10,14 +11,23 @@ local RandomSampler = {}
 RandomSampler.ClassName = "RandomSampler"
 RandomSampler.__index = RandomSampler
 
+export type RandomSampler<T> = typeof(setmetatable(
+	{} :: {
+		_optionsList: { T },
+		_shuffledAvailableList: { T },
+		_lastSelection: T?,
+	},
+	{} :: typeof({ __index = RandomSampler })
+))
+
 --[=[
 	Constructs a new RandomSampler
 
 	@param samples { T } -- The list of samples to sample from
 	@return RandomSampler<T>
 ]=]
-function RandomSampler.new(samples)
-	local self = setmetatable({}, RandomSampler)
+function RandomSampler.new<T>(samples): RandomSampler<T>
+	local self: RandomSampler<T> = setmetatable({} :: any, RandomSampler)
 
 	self._optionsList = {}
 	self._shuffledAvailableList = {}
@@ -35,7 +45,7 @@ end
 
 	@param samples { T } -- The list of samples to sample from
 ]=]
-function RandomSampler:SetSamples<T>(samples: { T })
+function RandomSampler.SetSamples<T>(self: RandomSampler<T>, samples: { T })
 	assert(type(samples) == "table", "Bad samples")
 
 	if self._optionsList ~= samples then
@@ -51,12 +61,12 @@ end
 
 	@return T -- The sample
 ]=]
-function RandomSampler:Sample()
+function RandomSampler.Sample<T>(self: RandomSampler<T>): T
 	if #self._shuffledAvailableList == 0 then
 		self:Refill()
 	end
 
-	local selection = table.remove(self._shuffledAvailableList)
+	local selection: T = table.remove(self._shuffledAvailableList) :: any
 	self._lastSelection = selection
 
 	return selection
@@ -65,7 +75,7 @@ end
 --[=[
 	Refills the list
 ]=]
-function RandomSampler:Refill()
+function RandomSampler.Refill<T>(self: RandomSampler<T>)
 	local newList = RandomUtils.shuffledCopy(self._optionsList)
 
 	if #newList > 1 then

package/src/Shared/WeightedRandomChooser.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class WeightedRandomChooser
 ]=]
@@ -10,13 +11,23 @@ local WeightedRandomChooser = {}
 WeightedRandomChooser.ClassName = "WeightedRandomChooser"
 WeightedRandomChooser.__index = WeightedRandomChooser
 
+type WeightedRandomChooserCache<T> = { options: { T }, weights: { number }, total: number }
+
+export type WeightedRandomChooser<T> = typeof(setmetatable(
+	{} :: {
+		_optionToWeight: { [T]: number },
+		_cache: WeightedRandomChooserCache<T>?,
+	},
+	{} :: typeof({ __index = WeightedRandomChooser })
+))
+
 --[=[
 	Creates a new weighted random chooser
 
 	@return WeightedRandomChooser<T>
 ]=]
-function WeightedRandomChooser.new()
-	local self = setmetatable({}, WeightedRandomChooser)
+function WeightedRandomChooser.new<T>(): WeightedRandomChooser<T>
+	local self: WeightedRandomChooser<T> = setmetatable({} :: any, WeightedRandomChooser)
 
 	self._optionToWeight = {}
 
@@ -28,9 +39,9 @@ end
 	removes the option.
 
 	@param option T
-	@param weight number?
+	@param weight number | nil
 ]=]
-function WeightedRandomChooser:SetWeight(option, weight)
+function WeightedRandomChooser.SetWeight<T>(self: WeightedRandomChooser<T>, option: T, weight: number | nil)
 	assert(option ~= nil, "Bad option")
 	assert(type(weight) == "number" or weight == nil, "Bad weight")
 
@@ -39,7 +50,7 @@ function WeightedRandomChooser:SetWeight(option, weight)
 	end
 
 	self._cache = nil
-	self._optionToWeight[option] = weight
+	self._optionToWeight[option] = weight :: any
 end
 
 --[=[
@@ -47,7 +58,7 @@ end
 
 	@param option T
 ]=]
-function WeightedRandomChooser:Remove(option)
+function WeightedRandomChooser.Remove<T>(self: WeightedRandomChooser<T>, option: T)
 	self:SetWeight(option, nil)
 end
 
@@ -57,7 +68,7 @@ end
 	@param option T
 	@return number?
 ]=]
-function WeightedRandomChooser:GetWeight(option): number?
+function WeightedRandomChooser.GetWeight<T>(self: WeightedRandomChooser<T>, option): number?
 	return self._optionToWeight[option]
 end
 
@@ -67,9 +78,9 @@ end
 	@param option T
 	@return number?
 ]=]
-function WeightedRandomChooser:GetProbability(option): number?
+function WeightedRandomChooser.GetProbability<T>(self: WeightedRandomChooser<T>, option): number?
 	local weight = self._optionToWeight[option]
-	if weight then
+	if not weight then
 		return nil
 	end
 
@@ -83,7 +94,7 @@ end
 	@param random Random
 	@return T
 ]=]
-function WeightedRandomChooser:Choose(random: Random?)
+function WeightedRandomChooser.Choose<T>(self: WeightedRandomChooser<T>, random: Random?)
 	local data = self:_getOrCreateDataCache()
 
 	local randomNum
@@ -110,7 +121,7 @@ function WeightedRandomChooser:Choose(random: Random?)
 	return data.options[#data.options]
 end
 
-function WeightedRandomChooser:_getOrCreateDataCache()
+function WeightedRandomChooser._getOrCreateDataCache<T>(self: WeightedRandomChooser<T>): WeightedRandomChooserCache<T>
 	if self._cache then
 		return self._cache
 	end
@@ -121,16 +132,17 @@ function WeightedRandomChooser:_getOrCreateDataCache()
 	local total = 0
 	for index, key in options do
 		local weight = self._optionToWeight[key]
-		total = total + weight
+		total += weight
 		weights[index] = weight
 	end
 
-	self._cache = {
+	local cache: WeightedRandomChooserCache<T> = {
 		options = options,
 		weights = weights,
 		total = total,
 	}
-	return self._cache
+	self._cache = cache
+	return cache
 end
 
 return WeightedRandomChooser