diff options
Diffstat (limited to 'src/script/api/script_engine.hpp')
| -rw-r--r-- | src/script/api/script_engine.hpp | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/src/script/api/script_engine.hpp b/src/script/api/script_engine.hpp index c97707acd..20938ea66 100644 --- a/src/script/api/script_engine.hpp +++ b/src/script/api/script_engine.hpp @@ -23,15 +23,17 @@ class ScriptEngine : public ScriptObject { public: /** - * Checks whether the given engine type is valid. An engine is valid if you - * have at least one vehicle of this engine or it's currently buildable. + * Checks whether the given engine type is valid. + * An engine is valid for a company if it has at least one vehicle of this engine or it's currently buildable. + * @game Outside ScriptCompanyMode scope the function reports all engines valid, which were or will be available at some point. * @param engine_id The engine to check. * @return True if and only if the engine type is valid. */ static bool IsValidEngine(EngineID engine_id); /** - * Checks whether the given engine type is buildable by you. + * Checks whether the given engine type is buildable for a company. + * @game Outside ScriptCompanyMode scope the function checks whether the engine is currently buildable by all companies (no exclusive preview). * @param engine_id The engine to check. * @return True if and only if the engine type is buildable. */ |