Script API provides facilities for working with scripts.
*
* @namespace Script
@@ -64,7 +64,7 @@ public:
virtual ~ScriptManagerScriptingInterface() {
}
- /**jsdoc
+ /*@jsdoc
* Stops and unloads the current script.
* Warning: If an assignment client script, the script gets restarted after stopping.
* @function Script.stop @@ -83,7 +83,7 @@ public: // NOTE - this is intended to be a public interface for Agent scripts, and local scripts, but not for EntityScripts Q_INVOKABLE void stop(bool marshal = false) { _manager->stop(marshal); } - /**jsdoc + /*@jsdoc * Gets the context that the script is running in: Interface/avatar, client entity, server entity, or assignment client. * @function Script.getContext * @returns {string} The context that the script is running in: @@ -97,7 +97,7 @@ public: Q_INVOKABLE QString getContext() const { return _manager->getContext(); } - /**jsdoc + /*@jsdoc * Checks whether the script is running as an Interface or avatar script. * @function Script.isClientScript * @returns {boolean}true if the script is running as an Interface or avatar script, false if it
@@ -105,7 +105,7 @@ public:
*/
Q_INVOKABLE bool isClientScript() const { return _manager->isClientScript(); }
- /**jsdoc
+ /*@jsdoc
* Checks whether the application was compiled as a debug build.
* @function Script.isDebugMode
* @returns {boolean} true if the application was compiled as a debug build, false if it was
@@ -113,21 +113,21 @@ public:
*/
Q_INVOKABLE bool isDebugMode() const { return _manager->isDebugMode(); }
- /**jsdoc
+ /*@jsdoc
* Checks whether the script is running as a client entity script.
* @function Script.isEntityClientScript
* @returns {boolean} true if the script is running as a client entity script, false if it isn't.
*/
Q_INVOKABLE bool isEntityClientScript() const { return _manager->isEntityClientScript(); }
- /**jsdoc
+ /*@jsdoc
* Checks whether the script is running as a server entity script.
* @function Script.isEntityServerScript
* @returns {boolean} true if the script is running as a server entity script, false if it isn't.
*/
Q_INVOKABLE bool isEntityServerScript() const { return _manager->isEntityServerScript(); }
- /**jsdoc
+ /*@jsdoc
* Checks whether the script is running as an assignment client script.
* @function Script.isAgentScript
* @returns {boolean} true if the script is running as an assignment client script, false if it
@@ -147,7 +147,7 @@ public:
////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// NOTE - these are intended to be public interfaces available to scripts
- /**jsdoc
+ /*@jsdoc
* @function Script.formatExecption
* @param {object} exception - Exception.
* @param {boolean} inludeExtendeDetails - Include extended details.
@@ -156,7 +156,7 @@ public:
*/
Q_INVOKABLE QString formatException(const ScriptValue& exception, bool includeExtendedDetails) { return _manager->formatException(exception, includeExtendedDetails); }
- /**jsdoc
+ /*@jsdoc
* Adds a function to the list of functions called when a particular event occurs on a particular entity.
* See also, the {@link Entities} API.
* @function Script.addEventHandler @@ -180,7 +180,7 @@ public: */ Q_INVOKABLE void addEventHandler(const EntityItemID& entityID, const QString& eventName, const ScriptValue& handler) { _manager->addEventHandler(entityID, eventName, handler); } - /**jsdoc + /*@jsdoc * Removes a function from the list of functions called when an entity event occurs on a particular entity. *See also, the {@link Entities} API.
* @function Script.removeEventHandler @@ -190,7 +190,7 @@ public: */ Q_INVOKABLE void removeEventHandler(const EntityItemID& entityID, const QString& eventName, const ScriptValue& handler) { _manager->removeEventHandler(entityID, eventName, handler); } - /**jsdoc + /*@jsdoc * Starts running another script in Interface, if it isn't already running. The script is not automatically loaded next * time Interface starts. *Supported Script Types: Interface Scripts • Avatar Scripts
@@ -212,7 +212,7 @@ public: */ Q_INVOKABLE void load(const QString& loadfile) { _manager->load(loadfile); } - /**jsdoc + /*@jsdoc * Includes JavaScript from other files in the current script. If a callback is specified, the files are loaded and * included asynchronously, otherwise they are included synchronously (i.e., script execution blocks while the files are * included). @@ -224,7 +224,7 @@ public: */ Q_INVOKABLE void include(const QStringList& includeFiles, const ScriptValue& callback = ScriptValue()) { _manager->include(includeFiles, callback);}; - /**jsdoc + /*@jsdoc * Includes JavaScript from another file in the current script. If a callback is specified, the file is loaded and included * asynchronously, otherwise it is included synchronously (i.e., script execution blocks while the file is included). * @function Script.include @@ -252,7 +252,7 @@ public: //////////////////////////////////////////////////////////////////////////////////////////////////////////////////// // MODULE related methods - /**jsdoc + /*@jsdoc * Provides access to methods or objects provided in an external JavaScript or JSON file. * See {@link https://docs.overte.org/script/js-tips.html} for further details. * @function Script.require @@ -263,14 +263,14 @@ public: */ Q_INVOKABLE ScriptValue require(const QString& moduleId) { return _manager->require(moduleId); } - /**jsdoc + /*@jsdoc * @function Script.resetModuleCache * @param {boolean} [deleteScriptCache=false] - Delete script cache. * @deprecated This function is deprecated and will be removed. */ Q_INVOKABLE void resetModuleCache(bool deleteScriptCache = false) { _manager->resetModuleCache(deleteScriptCache);} - /**jsdoc + /*@jsdoc * Calls a function repeatedly, at a set interval. * @function Script.setInterval * @param {function} function - The function to call. This can be either the name of a function or an in-line definition. @@ -283,7 +283,7 @@ public: */ Q_INVOKABLE QTimer* setInterval(const ScriptValue& function, int intervalMS) { return _manager->setInterval(function, intervalMS); } - /**jsdoc + /*@jsdoc * Calls a function once, after a delay. * @function Script.setTimeout * @param {function} function - The function to call. This can be either the name of a function or an in-line definition. @@ -296,7 +296,7 @@ public: */ Q_INVOKABLE QTimer* setTimeout(const ScriptValue& function, int timeoutMS) { return _manager->setTimeout(function, timeoutMS); }; - /**jsdoc + /*@jsdoc * Stops an interval timer set by {@link Script.setInterval|setInterval}. * @function Script.clearInterval * @param {object} timer - The interval timer to stop. @@ -317,7 +317,7 @@ public: // Overloaded version is needed in case the timer has expired Q_INVOKABLE void clearInterval(QVariantMap timer) { ; } - /**jsdoc + /*@jsdoc * Stops a timeout timer set by {@link Script.setTimeout|setTimeout}. * @function Script.clearTimeout * @param {object} timer - The timeout timer to stop. @@ -335,7 +335,7 @@ public: // Overloaded version is needed in case the timer has expired Q_INVOKABLE void clearTimeout(QVariantMap timer) { ; } - /**jsdoc + /*@jsdoc * Prints a message to the program log and emits {@link Script.printedMessage}. *Alternatively, you can use {@link print} or one of the {@link console} API methods.
* @function Script.print @@ -343,7 +343,7 @@ public: */ Q_INVOKABLE void print(const QString& message) { _manager->print(message); } - /**jsdoc + /*@jsdoc * Resolves a relative path to an absolute path. The relative path is relative to the script's location. * @function Script.resolvePath * @param {string} path - The relative path to resolve. @@ -357,14 +357,14 @@ public: */ Q_INVOKABLE QUrl resolvePath(const QString& path) const { return _manager->resolvePath(path);} - /**jsdoc + /*@jsdoc * Gets the path to the resources directory for QML files. * @function Script.resourcesPath * @returns {string} The path to the resources directory for QML files. */ Q_INVOKABLE QUrl resourcesPath() const { return _manager->resourcesPath(); } - /**jsdoc + /*@jsdoc * Starts timing a section of code in order to send usage data about it to Vircadia. Shouldn't be used outside of the * standard scripts. * @function Script.beginProfileRange @@ -372,7 +372,7 @@ public: */ Q_INVOKABLE void beginProfileRange(const QString& label) const { _manager->beginProfileRange(label); } - /**jsdoc + /*@jsdoc * Finishes timing a section of code in order to send usage data about it to Vircadia. Shouldn't be used outside of * the standard scripts. * @function Script.endProfileRange @@ -383,7 +383,7 @@ public: //////////////////////////////////////////////////////////////////////////////////////////////////////////////////// // Entity Script Related methods - /**jsdoc + /*@jsdoc * Checks whether an entity has an entity script running. * @function Script.isEntityScriptRunning * @param {Uuid} entityID - The ID of the entity. @@ -391,14 +391,14 @@ public: */ Q_INVOKABLE bool isEntityScriptRunning(const EntityItemID& entityID) { return _manager->isEntityScriptRunning(entityID); } - /**jsdoc + /*@jsdoc * Manually runs the JavaScript garbage collector which reclaims memory by disposing of objects that are no longer * reachable. * @function Script.requestGarbageCollection */ Q_INVOKABLE void requestGarbageCollection() { _manager->requestGarbageCollection(); } - /**jsdoc + /*@jsdoc * Prints out current backtrace to the log. * @function Script.logBacktrace * @param {string} title - Title added to the printed out backtrace. @@ -414,7 +414,7 @@ public: */ Q_INVOKABLE void loadEntityScript(const EntityItemID& entityID, const QString& entityScript, bool forceRedownload) { _manager->loadEntityScript(entityID, entityScript, forceRedownload); } - /**jsdoc + /*@jsdoc * @function Script.unloadEntityScript * @param {Uuid} entityID - Entity ID. * @param {boolean} [shouldRemoveFromMap=false] - Should remove from map. @@ -422,14 +422,14 @@ public: */ Q_INVOKABLE void unloadEntityScript(const EntityItemID& entityID, bool shouldRemoveFromMap = false) { _manager->unloadEntityScript(entityID, shouldRemoveFromMap); } - /**jsdoc + /*@jsdoc * @function Script.unloadAllEntityScripts * @param {boolean} [blockingCall=false] - Wait for completion if call moved to another thread. * @deprecated This function is deprecated and will be removed. */ Q_INVOKABLE void unloadAllEntityScripts(bool blockingCall = false) { _manager->unloadAllEntityScripts(blockingCall); } - /**jsdoc + /*@jsdoc * Calls a method in an entity script. * @function Script.callEntityScriptMethod * @param {Uuid} entityID - The ID of the entity running the entity script. @@ -441,7 +441,7 @@ public: const QStringList& params = QStringList(), const QUuid& remoteCallerID = QUuid()) { _manager->callEntityScriptMethod(entityID, methodName, params, remoteCallerID); } - /**jsdoc + /*@jsdoc * Calls a method in an entity script. * @function Script.callEntityScriptMethod * @param {Uuid} entityID - Entity ID. @@ -451,7 +451,7 @@ public: */ Q_INVOKABLE void callEntityScriptMethod(const EntityItemID& entityID, const QString& methodName, const PointerEvent& event) { _manager->callEntityScriptMethod(entityID, methodName, event); } - /**jsdoc + /*@jsdoc * Calls a method in an entity script. * @function Script.callEntityScriptMethod * @param {Uuid} entityID - Entity ID. @@ -462,14 +462,14 @@ public: */ Q_INVOKABLE void callEntityScriptMethod(const EntityItemID& entityID, const QString& methodName, const EntityItemID& otherID, const Collision& collision) { _manager->callEntityScriptMethod(entityID, methodName, otherID, collision);} - /**jsdoc + /*@jsdoc * @function Script.generateUUID * @returns {Uuid} A new UUID. * @deprecated This function is deprecated and will be removed. Use {@link Uuid(0).generate|Uuid.generate} instead. */ Q_INVOKABLE QUuid generateUUID() { return QUuid::createUuid(); } - /**jsdoc + /*@jsdoc * Gets the URL for an asset in an external resource bucket. (The location where the bucket is hosted may change over time * but this method will return the asset's current URL.) * @function Script.getExternalPath @@ -486,7 +486,7 @@ public: */ Q_INVOKABLE QString getExternalPath(ExternalResource::Bucket bucket, const QString& path) { return _manager->getExternalPath(bucket, path); } - /**jsdoc + /*@jsdoc *Object containing memory usage statistics data.
*