History

Merge remote-tracking branch 'hifi/master' into merge-hifi-master

# Conflicts: # CMakeLists.txt # README.md # cmake/externals/glad32es/CMakeLists.txt # cmake/externals/glad41/CMakeLists.txt # cmake/externals/glad45/CMakeLists.txt # cmake/externals/polyvox/CMakeLists.txt # cmake/externals/quazip/CMakeLists.txt # cmake/externals/vhacd/CMakeLists.txt # cmake/init.cmake # cmake/ports/hifi-deps/CONTROL # cmake/ports/sdl2/CONTROL # cmake/ports/sdl2/disable-hidapi-for-uwp.patch # cmake/ports/sdl2/enable-winrt-cmake.patch # cmake/ports/sdl2/fix-arm64-headers.patch # cmake/ports/sdl2/fix-x86-windows.patch # cmake/ports/sdl2/portfile.cmake # cmake/ports/sdl2/vcpkg-cmake-wrapper.cmake # cmake/ports/tbb/portfile.cmake # hifi_vcpkg.py # interface/src/avatar/MyAvatar.h # libraries/avatars-renderer/src/avatars-renderer/Avatar.h # libraries/avatars/src/AvatarData.h # libraries/entities-renderer/src/RenderableEntityItem.h # libraries/entities/src/EntityItem.cpp # libraries/entities/src/EntityItem.h # libraries/fbx/src/GLTFSerializer.cpp # libraries/graphics-scripting/src/graphics-scripting/Forward.h # libraries/networking/src/AddressManager.cpp # libraries/networking/src/DomainHandler.h # libraries/procedural/src/procedural/ProceduralMaterialCache.cpp # libraries/render-utils/src/HighlightEffect.cpp # libraries/render-utils/src/MeshPartPayload.cpp # libraries/render-utils/src/Model.cpp # libraries/render-utils/src/RenderShadowTask.cpp # libraries/script-engine/src/WebSocketClass.cpp

David Rowe committed 6 years ago

Commit ffeb37e2 parents e3d4856 c6cde9f403 files · +26813 −7254Browse files

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

Unified · Split

libraries/script-engine/src/ScriptEngine.h+10−14
@@ -320,13 +320,13 @@ public: · 319 unmodified lines
320 // NOTE - these are intended to be public interfaces available to scripts320 // NOTE - these are intended to be public interfaces available to scripts
321 321
322 /**jsdoc322 /**jsdoc
323 * Adds a function to the list of functions called when an entity event occurs on a particular entity.323 * Adds a function to the list of functions called when a particular event occurs on a particular entity.
324 * <p>See also, the {@link Entities} API.</p>324 * <p>See also, the {@link Entities} API.</p>
325 * @function Script.addEventHandler325 * @function Script.addEventHandler
326 * @param {Uuid} entityID - The ID of the entity.326 * @param {Uuid} entityID - The ID of the entity.
327 * @param {Script.EntityEvent} eventName - The name of the entity event.327 * @param {Script.EntityEvent} eventName - The name of the event.
328 * @param {function} handler - The function to call when the entity event occurs on the entity. It can be either the name 328 * @param {Script~entityEventCallback|Script~pointerEventCallback|Script~collisionEventCallback} handler - The function to
329 * of a function or an in-line definition.329 * call when the event occurs on the entity. It can be either the name of a function or an in-line definition.
330 * @example <caption>Report when a mouse press occurs on a particular entity.</caption>330 * @example <caption>Report when a mouse press occurs on a particular entity.</caption>
331 * var entityID = Entities.addEntity({331 * var entityID = Entities.addEntity({
332 * type: "Box",332 * type: "Box",
@@ -499,17 +499,11 @@ public: · 166 unmodified lines
499 Q_INVOKABLE void clearTimeout(QObject* timer) { stopTimer(reinterpret_cast<QTimer*>(timer)); }499 Q_INVOKABLE void clearTimeout(QObject* timer) { stopTimer(reinterpret_cast<QTimer*>(timer)); }
500 500
501 /**jsdoc501 /**jsdoc
502 * Prints a message to the program log.502 * Prints a message to the program log and emits {@link Script.printedMessage}.
503 * <p>Alternatively, you can use {@link print}, {@link console.log}, or one of the other {@link console} methods.</p>503 * <p>Alternatively, you can use {@link print} or one of the {@link console} API methods.</p>
504 * @function Script.print504 * @function Script.print
505 * @param {string} message - The message to print.505 * @param {string} message - The message to print.
506 */506 */
507 /**jsdoc
508 * Prints a message to the program log.
509 * <p>This is an alias of {@link Script.print}.</p>
510 * @function print
511 * @param {string} message - The message to print.
512 */
513 Q_INVOKABLE void print(const QString& message);507 Q_INVOKABLE void print(const QString& message);
514 508
515 /**jsdoc509 /**jsdoc
@@ -763,7 +757,8 @@ signals: · 247 unmodified lines
763 757
764 /**jsdoc758 /**jsdoc
765 * Triggered when the script prints a message to the program log via {@link print}, {@link Script.print}, 759 * Triggered when the script prints a message to the program log via {@link print}, {@link Script.print},
766 * {@link console.log}, or {@link console.debug}.760 * {@link console.log}, {@link console.debug}, {@link console.group}, {@link console.groupEnd}, {@link console.time}, or
761 * {@link console.timeEnd}.
767 * @function Script.printedMessage762 * @function Script.printedMessage
768 * @param {string} message - The message.763 * @param {string} message - The message.
769 * @param {string} scriptName - The name of the script that generated the message.764 * @param {string} scriptName - The name of the script that generated the message.
@@ -772,7 +767,8 @@ signals: · 2 unmodified lines
772 void printedMessage(const QString& message, const QString& scriptName);767 void printedMessage(const QString& message, const QString& scriptName);
773 768
774 /**jsdoc769 /**jsdoc
775 * Triggered when the script generates an error or {@link console.error} is called.770 * Triggered when the script generates an error, {@link console.error} or {@link console.exception} is called, or
771 * {@link console.assert} is called and fails.
776 * @function Script.errorMessage772 * @function Script.errorMessage
777 * @param {string} message - The error message.773 * @param {string} message - The error message.
778 * @param {string} scriptName - The name of the script that generated the error message.774 * @param {string} scriptName - The name of the script that generated the error message.