added documentation to oxen quality
parent
72b3c4537d
commit
00f0765ef8
|
@ -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 {
|
describeOxenQuality(): string {
|
||||||
const spent = this.gameState.amountSpentOnAnimals;
|
const spent = this.gameState.amountSpentOnAnimals;
|
||||||
const qualityLevels = [
|
const qualityLevels = [
|
||||||
|
|
Loading…
Reference in New Issue