History

Remainder of Entities methods' JSDoc

David Rowe committed 7 years ago

Commit 0945bda1 parent 72fdbc04 files · +297 −168Browse files

Showing the changes to libraries/script-engine/src/ScriptEngine.cpp (1 of 4 files). Show all

Unified · Split

libraries/script-engine/src/ScriptEngine.cpp+3−0
@@ -2200,6 +2200,7 @@ void ScriptEngine::loadEntityScript(const EntityItemID& entityID, const QString& · 2199 unmodified lines
2200 * lifetime: 300 // Delete after 5 minutes.2200 * lifetime: 300 // Delete after 5 minutes.
2201 * });2201 * });
2202 */2202 */
2203// The JSDoc is for the callEntityScriptMethod() call in this method.
2203// since all of these operations can be asynch we will always do the actual work in the response handler2204// since all of these operations can be asynch we will always do the actual work in the response handler
2204// for the download2205// for the download
2205void ScriptEngine::entityScriptContentAvailable(const EntityItemID& entityID, const QString& scriptOrURL, const QString& contents, bool isURL, bool success , const QString& status) {2206void ScriptEngine::entityScriptContentAvailable(const EntityItemID& entityID, const QString& scriptOrURL, const QString& contents, bool isURL, bool success , const QString& status) {
@@ -2384,8 +2385,10 @@ void ScriptEngine::entityScriptContentAvailable(const EntityItemID& entityID, co · 178 unmodified lines
2384 * <p>Note: Can only be connected to via <code>this.unoad = function () { ... }</code> in the entity script.</p>2385 * <p>Note: Can only be connected to via <code>this.unoad = function () { ... }</code> in the entity script.</p>
2385 * <table><tr><th>Available in:</th><td>Client Entity Scripts</td><td>Server Entity Scripts</td></tr></table>2386 * <table><tr><th>Available in:</th><td>Client Entity Scripts</td><td>Server Entity Scripts</td></tr></table>
2386 * @function Entities.unload2387 * @function Entities.unload
2388 * @param {Uuid} entityID - The ID of the entity that the script is running in.
2387 * @returns {Signal}2389 * @returns {Signal}
2388 */2390 */
2391// The JSDoc is for the callEntityScriptMethod() call in this method.
2389void ScriptEngine::unloadEntityScript(const EntityItemID& entityID, bool shouldRemoveFromMap) {2392void ScriptEngine::unloadEntityScript(const EntityItemID& entityID, bool shouldRemoveFromMap) {
2390 if (QThread::currentThread() != thread()) {2393 if (QThread::currentThread() != thread()) {
2391#ifdef THREAD_DEBUGGING2394#ifdef THREAD_DEBUGGING