Add AI/GS method to get annual expense category value

See: #425
This commit is contained in:
Jonathan G Rennison
2022-09-16 21:26:25 +01:00
parent 2ff11017dc
commit 9c255850a5
3 changed files with 44 additions and 1 deletions

View File

@@ -96,6 +96,26 @@
</div>
</div>
<h3>Company: <a href="https://docs.openttd.org/gs-api/classGSCompany.html">GSCompany Class</a> and <a href="https://docs.openttd.org/ai-api/classAICompany.html">AICompany Class</a></h3>
<div class="indent">
<h4>Additional Static Public Member Functions:</h4>
<div class="indent">
<div class="code">static bool GetAnnualExpenseValue (CompanyID company, uint32 year_offset, ExpensesType expenses_type)</div>
<div class="methodtext">Get the annual expense value for the given company.</div>
<div class="methodtext">year_offset is relative to the current year and must be either: 0, 1, or 2.</div>
</div>
<h4>Additional Enum Values:</h4>
<div class="indent">
<div class="code">ExpensesType</div>
<div>Additional value: <span class="code">EXPENSES_SHARING_COST</span></div>
<div class="methodtext">Infrastructure sharing costs.</div>
<div>Additional value: <span class="code">EXPENSES_SHARING_INC</span></div>
<div class="methodtext">Infrastructure sharing income.</div>
<div>ExpensesType is additionally available via AICompany.</div>
</div>
</div>
<h3>Inflation: GSInflation Class and AIInflation Class</h3>
<div class="indent">
<h4>Static Public Member Functions:</h4>