Doc: [Script] Extend API documentation on calendar- vs economy-time

This commit is contained in:
frosch
2024-03-23 21:34:31 +01:00
committed by Peter Nelson
parent 04cc0c8125
commit dc22edc556
15 changed files with 154 additions and 89 deletions

View File

@@ -222,7 +222,8 @@ public:
* Get the current profit of a group.
* @param group_id The group to get the profit of.
* @pre IsValidGroup(group_id).
* @return The current profit the group has.
* @return The profit the vehicles in this group have made this economy-year so far.
* @see \ref ScriptEconomyTime
*/
static Money GetProfitThisYear(GroupID group_id);
@@ -230,7 +231,8 @@ public:
* Get the profit of last year of a group.
* @param group_id The group to get the profit of.
* @pre IsValidGroup(group_id).
* @return The current profit the group had last year.
* @return The profit the vehicles in this group made in the previous economy-year.
* @see \ref ScriptEconomyTime
*/
static Money GetProfitLastYear(GroupID group_id);