added documentation to oxen quality

master
j 2024-04-02 22:58:17 -04:00
parent 72b3c4537d
commit 00f0765ef8
1 changed files with 11 additions and 0 deletions

View File

@ -82,6 +82,17 @@ class GameFlow {
}
/**
* Describes the quality of oxen based on the amount spent on animals within the game state.
* This method assesses the oxen quality by comparing the total amount spent on animals against predefined quality levels.
*
* @returns {string} A string describing the quality of the oxen, ranging from 'Basic Quality' to 'Exceptional Quality'. Returns 'Unknown Quality' if the amount spent does not fit the expected range.
* @example
* // If the gameState.amountSpentOnAnimals is 250
* describeOxenQuality(); // returns 'Good Quality'
*/
describeOxenQuality(): string {
const spent = this.gameState.amountSpentOnAnimals;
const qualityLevels = [