@quenty/experiencecalculator 2.5.0 → 2.5.1

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.
 
+## [2.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/experiencecalculator@2.5.0...@quenty/experiencecalculator@2.5.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [2.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/experiencecalculator@2.4.0...@quenty/experiencecalculator@2.5.0) (2025-04-02)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/experiencecalculator",
-  "version": "2.5.0",
+  "version": "2.5.1",
   "description": "Calculate experience on an exponential curve and perform relevant calculations Uses formulas from stackoverflow.com/questions/6954874/php-game-formula-to-calculate-a-level-based-on-exp",
   "keywords": [
     "Roblox",
@@ -28,5 +28,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/ExperienceUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Calculate experience on an exponential curve and perform relevant calculations.
 
@@ -17,18 +18,23 @@
 
 local ExperienceUtils = {}
 
+export type ExperienceConfig = {
+	factor: number,
+	maxLevel: number,
+}
+
 --[=[
 	Creates a new experience configuration to be used
 
 	@param options ExperienceConfig
 	@return ExperienceConfig
 ]=]
-function ExperienceUtils.createExperienceConfig(options)
+function ExperienceUtils.createExperienceConfig(options: ExperienceConfig): ExperienceConfig
 	assert(type(options) == "table", "Bad options")
 
 	return {
-		factor = options.factor or 200;
-		maxLevel = options.maxLevel or math.huge;
+		factor = options.factor or 200,
+		maxLevel = options.maxLevel or math.huge,
 	}
 end
 
@@ -38,9 +44,8 @@ end
 	@param value any
 	@return boolean
 ]=]
-function ExperienceUtils.isExperienceConfig(value)
-	return type(value) == "table"
-		and type(value.factor) == "number"
+function ExperienceUtils.isExperienceConfig(value: any): boolean
+	return type(value) == "table" and type(value.factor) == "number"
 end
 
 --[=[
@@ -50,15 +55,12 @@ end
 	@param totalExperience number
 	@return number -- Level
 ]=]
-function ExperienceUtils.getLevel(config, totalExperience)
+function ExperienceUtils.getLevel(config: ExperienceConfig, totalExperience: number): number
 	assert(ExperienceUtils.isExperienceConfig(config), "Bad experience config")
 	assert(type(totalExperience) == "number", "Bad totalExperience")
 
 	local factor = config.factor
-	local level = math.floor(
-		(factor
-			+ math.sqrt(factor*factor - 4*factor*(-totalExperience)))
-		/(2*factor))
+	local level = math.floor((factor + math.sqrt(factor * factor - 4 * factor * -totalExperience)) / (2 * factor))
 	if level >= config.maxLevel then
 		return config.maxLevel
 	else
@@ -75,11 +77,11 @@ end
 	@param level number
 	@return number -- Total experience required for a level
 ]=]
-function ExperienceUtils.experienceFromLevel(config, level)
+function ExperienceUtils.experienceFromLevel(config: ExperienceConfig, level: number): number
 	assert(ExperienceUtils.isExperienceConfig(config), "Bad experience config")
 	assert(type(level) == "number", "Bad level")
 
-	return config.factor*level*(level - 1)
+	return config.factor * level * (level - 1)
 end
 
 --[=[
@@ -89,7 +91,7 @@ end
 	@param totalExperience number
 	@return number
 ]=]
-function ExperienceUtils.levelExperienceEarned(config, totalExperience)
+function ExperienceUtils.levelExperienceEarned(config: ExperienceConfig, totalExperience: number): number
 	assert(ExperienceUtils.isExperienceConfig(config), "Bad experience config")
 	assert(type(totalExperience) == "number", "Bad totalExperience")
 
@@ -114,7 +116,7 @@ end
 	@param totalExperience number
 	@return number
 ]=]
-function ExperienceUtils.levelExperienceLeft(config, totalExperience)
+function ExperienceUtils.levelExperienceLeft(config: ExperienceConfig, totalExperience: number): number
 	assert(ExperienceUtils.isExperienceConfig(config), "Bad experience config")
 	assert(type(totalExperience) == "number", "Bad totalExperience")
 
@@ -139,7 +141,7 @@ end
 	@param totalExperience number -- Current experience of player
 	@return number -- Total required for next level
 ]=]
-function ExperienceUtils.levelExperienceRequired(config, totalExperience)
+function ExperienceUtils.levelExperienceRequired(config: ExperienceConfig, totalExperience: number): number
 	assert(ExperienceUtils.isExperienceConfig(config), "Bad experience config")
 	assert(type(totalExperience) == "number", "Bad totalExperience")
 
@@ -164,7 +166,7 @@ end
 	@param totalExperience number
 	@return number
 ]=]
-function ExperienceUtils.percentLevelComplete(config, totalExperience)
+function ExperienceUtils.percentLevelComplete(config: ExperienceConfig, totalExperience: number): number
 	assert(ExperienceUtils.isExperienceConfig(config), "Bad experience config")
 	assert(type(totalExperience) == "number", "Bad totalExperience")