dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

GS: Add GSAsyncMode(bool) class to set async mode of script DoCommands

Browse Source 
In asynchronous mode, don't wait for result of executed command,
just fire-and-forget, and return estimated cost/result
This commit is contained in:
Jonathan G Rennison
2023-05-23 20:52:08 +01:00
parent df6c35a48a
commit cd9930542d
9 changed files with 214 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/script-additions.html
View File

@@ -29,6 +29,7 @@
<li><a href="#road">Road: GSRoad and AIRoad</a></li>
<li><a href="#company">Company: GSCompany and AICompany</a></li>
<li><a href="#inflation">Inflation: GSInflation and AIInflation</a></li>
<li><a href="#asyncmode">Command Asynchronous Mode: GSAsyncMode</a></li>
</ul>
<h3 id="date">Date: <a href="https://docs.openttd.org/gs-api/classGSDate.html">GSDate Class</a> and <a href="https://docs.openttd.org/ai-api/classAIDate.html">AIDate Class</a></h3>
@@ -149,5 +150,24 @@
<div class="methodtext">The inflation factor is a fixed point value (16 bits).</div>
</div>
</div>
<h3 id="asyncmode">Command Asynchronous Mode: GSAsyncMode Class</h3>
<div class="indent">
<h4>Public Constructor:</h4>
<div class="indent">
<div class="code">GSAsyncMode (bool asynchronous)</div>
<div class="methodtext">Creating an instance of this class switches the asynchronous execution mode for commands.</div>
<div class="methodtext">
A value of true sets the mode to Asynchronous, the commands you execute are queued for later execution, and the script
is not delayed waiting for the command result. The estimated result is returned to the script.
The actual cost and whether the command succeeded when the command is eventually executed may differ from what was returned to the script.
</div>
<div class="methodtext">
A value of false sets the mode to Non-Asynchronous, this is the normal mode of executing commands.
</div>
<div class="methodtext">The original mode is stored and recovered from when ever the instance is destroyed.</div>
<div class="methodtext">Use in a similar way to the <a href="https://docs.openttd.org/gs-api/classGSTestMode.html">GSTestMode class</a>.</div>
</div>
</div>
</body>
</html>