@quenty/experiencecalculator 2.0.0 → 2.0.1

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.
 
+## [2.0.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/experiencecalculator@2.0.0...@quenty/experiencecalculator@2.0.1) (2021-12-30)
+
+**Note:** Version bump only for package @quenty/experiencecalculator
+
+
+
+
+
 # [2.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/experiencecalculator@1.2.0...@quenty/experiencecalculator@2.0.0) (2021-09-05)
 
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014 Quenty
+Copyright (c) 2014-2021 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,10 +1,10 @@
 ## ExperienceCalculator
 <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,28 +13,9 @@
 
 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
 
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/ExperienceCalculator">View docs →</a></div>
+
 ## Installation
 ```
 npm install @quenty/experiencecalculator --save
 ```
-
-## Usage
-Usage is designed to be simple.
-
-### `ExperienceCalculator.setExperienceFactor(factor)`
-
-### `ExperienceCalculator.getLevel(experience)`
-Gets the current level from experience
-
-### `ExperienceCalculator.getExperienceRequiredForNextLevel(currentLevel)`
-Given a current level, return the experience required for the next one
-
-### `ExperienceCalculator.getExperienceRequiredForLevel(level)`
-Gets experience required for a current level
-
-### `ExperienceCalculator.getExperienceForNextLevel(currentExperience)`
-Gets experience left to earn required for next level
-
-### `ExperienceCalculator.getSubExperience(currentExperience)`
-Calculates subtotal experience
-

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/experiencecalculator",
-  "version": "2.0.0",
+  "version": "2.0.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": "c06170ec47b0d4520c587ce2e6404d14b5dbb851"
+  "gitHead": "d146c77d0a8e452824de0ab0b4b03ba0370bcc1b"
 }

package/src/Shared/ExperienceCalculator.lua

@@ -1,17 +1,32 @@
---- 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
--- @module ExperienceCalculator
+--[=[
+	Calculate experience on an exponential curve and perform relevant calculations.
+
+	Uses formulas from https://stackoverflow.com/questions/6954874/php-game-formula-to-calculate-a-level-based-on-exp
+
+	@class ExperienceCalculator
+]=]
 
 local ExperienceCalculator = {}
 ExperienceCalculator._experienceFactor = 200
 
+--[=[
+	Sets the global experience factor to be used across this library.
+
+	:::tip
+	This API is global, poorly designed and will be refactored at some point.
+	:::
+
+	@param factor number
+]=]
 function ExperienceCalculator.setExperienceFactor(factor)
 	ExperienceCalculator._experienceFactor = factor
 end
 
---- Gets the current level from experience
--- @tparam number experience Current experience
--- @treturn number The level the player should be
+--[=[
+	Gets the current level from experience.
+	@param experience number -- Current experience
+	@return number -- The level the player should be
+]=]
 function ExperienceCalculator.getLevel(experience)
 	local factor = ExperienceCalculator._experienceFactor
 	return math.floor(
@@ -20,23 +35,29 @@ function ExperienceCalculator.getLevel(experience)
 		/(2*factor))
 end
 
---- Given a current level, return the experience required for the next one
--- @tparam number currentLevel The current level the player is
--- @treturn number Experience required for next level
+--[=[
+	Given a current level, return the experience required for the next one.
+	@param currentLevel number -- The current level the player is
+	@return number -- Experience required for next level
+]=]
 function ExperienceCalculator.getExperienceRequiredForNextLevel(currentLevel)
 	return ExperienceCalculator._experienceFactor*(currentLevel*(1+currentLevel))
 end
 
---- Gets experience required for a current level
--- @tparam number level
--- @treturn number total experience required for a level
+--[=[
+	Gets experience required for a current level.
+	@param level number
+	@return number -- Total experience required for a level
+]=]
 function ExperienceCalculator.getExperienceRequiredForLevel(level)
 	return ExperienceCalculator.getExperienceRequiredForNextLevel(level - 1)
 end
 
---- Gets experience left to earn required for next level
--- @tparam number currentExperience Current experience of player
--- @treturn number experience Experience points left to earn for the player
+--[=[
+	Gets experience left to earn required for next level.
+	@param currentExperience number -- Current experience of player
+	@return number -- Experience points left to earn for the player
+]=]
 function ExperienceCalculator.getExperienceForNextLevel(currentExperience)
 	if currentExperience - 1 == currentExperience then -- math.huge
 		return 0
@@ -48,13 +69,15 @@ function ExperienceCalculator.getExperienceForNextLevel(currentExperience)
 	return experienceRequired - currentExperience
 end
 
---- Calculates subtotal experience
--- @tparam number currentExperience Current experience of player
--- @treturn number Achieved of next level
--- @treturn number Total required for next level
+--[=[
+	Calculates subtotal experience.
+	@param currentExperience number -- Current experience of player
+	@return number -- Achieved of next level
+	@return number -- Total required for next level
+]=]
 function ExperienceCalculator.getSubExperience(currentExperience)
 	if currentExperience - 1 == currentExperience then -- math.huge
-		return 1, 1, 1
+		return 1, 1
 	end
 
 	local currentLevel = ExperienceCalculator.getLevel(currentExperience)