Mirrors/overte-HifiExperiments
3
0
Fork 0
mirror of https://github.com/HifiExperiments/overte.git synced 2025-08-10 10:59:04 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Web entity EventBridge functions JSDoc

Browse source
This commit is contained in:
David Rowe 2018-02-28 08:40:36 +13:00
parent 1fb02d15d7
commit 483688a6e1
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
libraries/entities/src/EntityScriptingInterface.h
View file

@ -1242,6 +1242,14 @@ public slots:
*/ */
Q_INVOKABLE bool wantsHandControllerPointerEvents(QUuid id); Q_INVOKABLE bool wantsHandControllerPointerEvents(QUuid id);
/**jsdoc
* Send a script event over a <code>{@link Entities.EntityType|"Web"}</code> entity's <code>EventBridge</code> to the Web
* page's scripts.
* @function Entities.emitScriptEvent
* @param {Uuid} entityID - The ID of the <code>{@link Entities.EntityType|"Web"}</code> entity.
* @param {string} message - The message to send.
* @todo This function is currently not implemented.
*/
Q_INVOKABLE void emitScriptEvent(const EntityItemID& entityID, const QVariant& message); Q_INVOKABLE void emitScriptEvent(const EntityItemID& entityID, const QVariant& message);
/**jsdoc /**jsdoc
@ -1663,6 +1671,14 @@ signals:
*/ */
void debitEnergySource(float value); void debitEnergySource(float value);
/**jsdoc
* Triggered in when a script in a <code>{@link Entities.EntityType|"Web"}</code> entity's Web page script sends an event
* over the script's <code>EventBridge</code>.
* @function Entities.webEventReceived
* @param {Uuid} entityID - The ID of the entity that event was received from.
* @param {string} message - The message received.
* @returns {Signal}
*/
void webEventReceived(const EntityItemID& entityItemID, const QVariant& message); void webEventReceived(const EntityItemID& entityItemID, const QVariant& message);
protected: protected: