From 9a353232950b328678ac457bd5afddfb81ade4de Mon Sep 17 00:00:00 2001 From: Kalila L Date: Fri, 18 Sep 2020 16:27:42 -0400 Subject: [PATCH 1/7] Update entities API docs to show entity properties at top. --- libraries/entities/src/EntityScriptingInterface.h | 5 ++++- tools/jsdoc/plugins/hifiJSONExport.js | 2 +- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/libraries/entities/src/EntityScriptingInterface.h b/libraries/entities/src/EntityScriptingInterface.h index dae0922f4a..1375f53030 100644 --- a/libraries/entities/src/EntityScriptingInterface.h +++ b/libraries/entities/src/EntityScriptingInterface.h @@ -4,6 +4,7 @@ // // Created by Brad Hefta-Gaub on 12/6/13. // Copyright 2013 High Fidelity, Inc. +// Copyright 2020 Vircadia contributors. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html @@ -110,9 +111,11 @@ public: * displayed and so knows about. For assignment client scripts, the entities available are those that are "seen" by the * {@link EntityViewer}. For entity server scripts, all entities are available.

* - *

Entity Types

+ *

Entity Types & Properties

* *

For a list of the entity types that you can use, see {@link Entities.EntityType|Entity Types}.

+ * + *

While each entity type has properties that are specific to it, there are properties that are universal to all entity types, see {@link Entities.EntityProperties|Entity Properties}.

* *

Entity Methods

* diff --git a/tools/jsdoc/plugins/hifiJSONExport.js b/tools/jsdoc/plugins/hifiJSONExport.js index cd14c9faad..e609b30ad5 100644 --- a/tools/jsdoc/plugins/hifiJSONExport.js +++ b/tools/jsdoc/plugins/hifiJSONExport.js @@ -13,7 +13,7 @@ exports.handlers = { return console.log(err); } - console.log("The Hifi JSDoc JSON was saved!"); + console.log("The Vircadia JSDoc JSON was saved!"); }); } }; From f6ec13704b319eea5775a74f5b0a7548c6ef93ff Mon Sep 17 00:00:00 2001 From: Kalila L Date: Fri, 18 Sep 2020 16:31:57 -0400 Subject: [PATCH 2/7] Copyright header updates. --- domain-server/src/DomainMetadata.h | 1 + domain-server/src/DomainServer.h | 1 + interface/src/Application.h | 1 + 3 files changed, 3 insertions(+) diff --git a/domain-server/src/DomainMetadata.h b/domain-server/src/DomainMetadata.h index 24dcba909d..68a012cbf6 100644 --- a/domain-server/src/DomainMetadata.h +++ b/domain-server/src/DomainMetadata.h @@ -4,6 +4,7 @@ // // Created by Zach Pomerantz on 5/25/2016. // Copyright 2016 High Fidelity, Inc. +// Copyright 2020 Vircadia contributors. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html diff --git a/domain-server/src/DomainServer.h b/domain-server/src/DomainServer.h index c27500d5ce..7a09141db6 100644 --- a/domain-server/src/DomainServer.h +++ b/domain-server/src/DomainServer.h @@ -4,6 +4,7 @@ // // Created by Stephen Birarda on 9/26/13. // Copyright 2013 High Fidelity, Inc. +// Copyright 2020 Vircadia contributors. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html diff --git a/interface/src/Application.h b/interface/src/Application.h index f42696cda0..37d4b4540a 100644 --- a/interface/src/Application.h +++ b/interface/src/Application.h @@ -4,6 +4,7 @@ // // Created by Andrzej Kapolka on 5/10/13. // Copyright 2013 High Fidelity, Inc. +// Copyright 2020 Vircadia contributors. // // Distributed under the Apache License, Version 2.0. // See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html From bcd5f242b9cd22c27ee9b72985426b162c51b3a7 Mon Sep 17 00:00:00 2001 From: Kalila L Date: Fri, 18 Sep 2020 18:52:49 -0400 Subject: [PATCH 3/7] Added type and filename doc for Script API. --- libraries/script-engine/src/ScriptEngine.h | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/libraries/script-engine/src/ScriptEngine.h b/libraries/script-engine/src/ScriptEngine.h index 15166d572f..c4c9fa97c1 100644 --- a/libraries/script-engine/src/ScriptEngine.h +++ b/libraries/script-engine/src/ScriptEngine.h @@ -118,6 +118,17 @@ public: *
  • "agent": An assignment client script.
    • * * Read-only. + * @property {string} type - The type of engine that is currently in use: + *
      + *
    • "client": The engine is an interface.
      • + *
    • "entity_client": The engine is an entity simulated in an interface.
      • + *
    • "entity_server": The engine is an entity simulated in a server.
      • + *
    • "agent": The engine is an agent.
      • + *
    • "avatar": The engine is an avatar.
      • + *
    + * Read-only. + * @property {string} filename - The filename of the script's file. + * Read-only. */ class ScriptEngine : public BaseScriptEngine, public EntitiesScriptEngineProvider { Q_OBJECT From c6b947e5f9d5426ded7c45b6b9702afab1e537e5 Mon Sep 17 00:00:00 2001 From: Kalila L Date: Sat, 19 Sep 2020 23:46:34 -0400 Subject: [PATCH 4/7] Update sandbox starter content URL --- server-console/src/main.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/server-console/src/main.js b/server-console/src/main.js index d8d6fea4bf..0877426df0 100644 --- a/server-console/src/main.js +++ b/server-console/src/main.js @@ -56,7 +56,7 @@ const menuNotificationIcon = path.join(__dirname, '../resources/tray-menu-notifi const DELETE_LOG_FILES_OLDER_THAN_X_SECONDS = 60 * 60 * 24 * 7; // 7 Days const LOG_FILE_REGEX = /(domain-server|ac-monitor|ac)-.*-std(out|err).txt/; -const HOME_CONTENT_URL = "http://cdn.highfidelity.com/content-sets/home-tutorial-RC40.tar.gz"; +const HOME_CONTENT_URL = "https://vircadia-content-public.s3.amazonaws.com/DomainContent/Sandbox/Basic_sandbox_no_external_links.tar.gz"; const buildInfo = GetBuildInfo(); From 88fc2136447a18f0587092c19a1777957ace091e Mon Sep 17 00:00:00 2001 From: kasenvr <52365539+kasenvr@users.noreply.github.com> Date: Sat, 19 Sep 2020 23:53:04 -0400 Subject: [PATCH 5/7] Apply suggestions from code review Co-authored-by: David Rowe --- libraries/script-engine/src/ScriptEngine.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/libraries/script-engine/src/ScriptEngine.h b/libraries/script-engine/src/ScriptEngine.h index c4c9fa97c1..45912bc557 100644 --- a/libraries/script-engine/src/ScriptEngine.h +++ b/libraries/script-engine/src/ScriptEngine.h @@ -118,7 +118,7 @@ public: *
  • "agent": An assignment client script.
    • * * Read-only. - * @property {string} type - The type of engine that is currently in use: + * @property {string} type - The type of script engine that is running the script: *
      *
    • "client": The engine is an interface.
      • *
    • "entity_client": The engine is an entity simulated in an interface.
      • @@ -127,7 +127,7 @@ public: *
    • "avatar": The engine is an avatar.
      • *
    * Read-only. - * @property {string} filename - The filename of the script's file. + * @property {string} filename - The filename of the script file. * Read-only. */ class ScriptEngine : public BaseScriptEngine, public EntitiesScriptEngineProvider { From dcf1e41086e04da11feb159bc3d434e2a30281bc Mon Sep 17 00:00:00 2001 From: kasenvr <52365539+kasenvr@users.noreply.github.com> Date: Tue, 22 Sep 2020 23:49:07 -0400 Subject: [PATCH 6/7] Update libraries/entities/src/EntityScriptingInterface.h Co-authored-by: David Rowe --- libraries/entities/src/EntityScriptingInterface.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/libraries/entities/src/EntityScriptingInterface.h b/libraries/entities/src/EntityScriptingInterface.h index 1375f53030..a8770bbd33 100644 --- a/libraries/entities/src/EntityScriptingInterface.h +++ b/libraries/entities/src/EntityScriptingInterface.h @@ -115,7 +115,7 @@ public: * *

    For a list of the entity types that you can use, see {@link Entities.EntityType|Entity Types}.

    * - *

    While each entity type has properties that are specific to it, there are properties that are universal to all entity types, see {@link Entities.EntityProperties|Entity Properties}.

    + *

    For the properties of the different entity types, see {@link Entities.EntityProperties|Entity Properties}. Some properties are universal to all entity types, and some are specific to particular entity types.

    * *

    Entity Methods

    * From c975d1acecf03c008ea7b9b68d29f7ed63768463 Mon Sep 17 00:00:00 2001 From: kasenvr <52365539+kasenvr@users.noreply.github.com> Date: Fri, 2 Oct 2020 15:32:05 -0400 Subject: [PATCH 7/7] Update libraries/script-engine/src/ScriptEngine.h Co-authored-by: David Rowe --- libraries/script-engine/src/ScriptEngine.h | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/libraries/script-engine/src/ScriptEngine.h b/libraries/script-engine/src/ScriptEngine.h index 45912bc557..fb0fa52799 100644 --- a/libraries/script-engine/src/ScriptEngine.h +++ b/libraries/script-engine/src/ScriptEngine.h @@ -118,13 +118,13 @@ public: *
  • "agent": An assignment client script.
    • * * Read-only. - * @property {string} type - The type of script engine that is running the script: + * @property {string} type - The type of script that is running: *
      - *
    • "client": The engine is an interface.
      • - *
    • "entity_client": The engine is an entity simulated in an interface.
      • - *
    • "entity_server": The engine is an entity simulated in a server.
      • - *
    • "agent": The engine is an agent.
      • - *
    • "avatar": The engine is an avatar.
      • + *
    • "client": An Interface script.
      • + *
    • "entity_client": A client entity script.
      • + *
    • "avatar": An avatar script.
      • + *
    • "entity_server": A server entity script.
      • + *
    • "agent": An assignment client script.
      • *
    * Read-only. * @property {string} filename - The filename of the script file.