Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-16 13:56:24 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Added type and filename doc for Script API.

Browse source
This commit is contained in:
Kalila L 2020-09-18 18:52:49 -04:00
parent f6ec13704b
commit bcd5f242b9
1 changed files with 11 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
libraries/script-engine/src/ScriptEngine.h
View file

@ -118,6 +118,17 @@ public:
* <li><code>"agent"</code>: An assignment client script.</li>
* </ul>
* <em>Read-only.</em>
* @property {string} type - The type of engine that is currently in use:
* <ul>
* <li><code>"client"</code>: The engine is an interface.</li>
* <li><code>"entity_client"</code>: The engine is an entity simulated in an interface.</li>
* <li><code>"entity_server"</code>: The engine is an entity simulated in a server.</li>
* <li><code>"agent"</code>: The engine is an agent.</li>
* <li><code>"avatar"</code>: The engine is an avatar.</li>
* </ul>
* <em>Read-only.</em>
* @property {string} filename - The filename of the script's file.
* <em>Read-only.</em>
*/
class ScriptEngine : public BaseScriptEngine, public EntitiesScriptEngineProvider {
Q_OBJECT