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

GS: Documentation/comment fixes for ScriptAsyncMode

Browse Source
This commit is contained in:
Jonathan G Rennison
2023-05-23 22:49:48 +01:00
parent cd9930542d
commit 5428b6dd9b
2 changed files with 2 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/script/api/script_asyncmode.hpp
View File

@@ -39,11 +39,6 @@ public:
*/ */
ScriptAsyncMode(HSQUIRRELVM vm); ScriptAsyncMode(HSQUIRRELVM vm);
#else #else
/**
* Generate a text from string. You can set parameters to the instance which
* can be required for the string.
* @param string The string of the text.
*/
/** /**
* Creating instance of this class switches the build mode to Asynchronous or Non-Asynchronous (normal). * Creating instance of this class switches the build mode to Asynchronous or Non-Asynchronous (normal).
* @note When the instance is destroyed, it restores the mode that was * @note When the instance is destroyed, it restores the mode that was
@@ -54,7 +49,7 @@ public:
#endif /* DOXYGEN_API */ #endif /* DOXYGEN_API */
/** /**
* Destroying this instance reset the building mode to the mode it was * Destroying this instance resets the asynchronous mode to the mode it was
* in when the instance was created. * in when the instance was created.
*/ */
~ScriptAsyncMode(); ~ScriptAsyncMode();

2
src/script/api/script_object.cpp
View File

@@ -356,7 +356,7 @@ ScriptObject::ActiveInstance::~ActiveInstance()
/* Are we only interested in the estimate costs? */ /* Are we only interested in the estimate costs? */
bool estimate_only = GetDoCommandMode() != nullptr && !GetDoCommandMode()(); bool estimate_only = GetDoCommandMode() != nullptr && !GetDoCommandMode()();
/* Are we only interested in the estimate costs? */ /* Should the command be executed asynchronously? */
bool asynchronous = GetDoCommandAsyncMode() != nullptr && GetDoCommandAsyncMode()() && GetActiveInstance()->GetScriptType() == ST_GS; bool asynchronous = GetDoCommandAsyncMode() != nullptr && GetDoCommandAsyncMode()() && GetActiveInstance()->GetScriptType() == ST_GS;
/* Only set p2 when the command does not come from the network. */ /* Only set p2 when the command does not come from the network. */