1
0
mirror of https://github.com/OpenRCT2/OpenRCT2 synced 2025-12-10 09:32:29 +01:00

Fix #12776: Mistake in API documentation

Elapsed months after one year was mistakenly said to be 16.
Now it states the correct value at the beginning of the game and the increase every month and year.
This commit is contained in:
Sadret
2020-08-26 11:55:10 +02:00
committed by GitHub
parent 45d5e8a745
commit 2fb083f72c

View File

@@ -371,7 +371,8 @@ declare global {
*/
readonly ticksElapsed: number;
/**
* The total number of months that have elapsed. This will equate to 16 on 1st March, Year 2.
* The total number of months that have elapsed. This will equate to 0 in March, Year 1 and
* increase by 1 every month, i.e. by 8 every year.
* Note: this represents the current date and may be reset by cheats or scripts.
*/
monthsElapsed: number;