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

Merge pull request #507 from AleziaKurdis/issue398

Browse source 
JS Doc update for enterEntity signal.
This commit is contained in:
kasenvr 2020-07-09 17:34:35 -04:00 committed by GitHub
commit 4b3765c9b3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -2399,7 +2399,9 @@ signals:
/**jsdoc
* Triggered when an avatar enters an entity, but only if the entity has an entity method exposed for this event.
* Triggered when an avatar enters an entity.
* Note: At the initial loading of the script, if the avatar is already present inside the entity, it might be too late
* to catch this event when the script runs, so it won't trigger. The {@link Entities.preload|preload} signal can be used to handle those cases.
* <p>See also, {@link Entities|Entity Methods} and {@link Script.addEventHandler}.</p>
* @function Entities.enterEntity
* @param {Uuid} entityID - The ID of the entity that the avatar entered.
@ -2408,7 +2410,7 @@ signals:
void enterEntity(const EntityItemID& entityItemID);
/**jsdoc
* Triggered when an avatar leaves an entity, but only if the entity has an entity method exposed for this event.
* Triggered when an avatar leaves an entity.
* <p>See also, {@link Entities|Entity Methods} and {@link Script.addEventHandler}.</p>
* @function Entities.leaveEntity
* @param {Uuid} entityID - The ID of the entity that the avatar left.