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

JS Doc update for enterEntity

Browse source 
JS Doc update for enterEntity:
Triggered when an avatar enters an entity, but only if the entity has an entity method exposed for this event. 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 'preload' signal can be used to handle those cases.

To solve issue #398
This commit is contained in:
Alezia Kurdis 2020-07-04 23:15:10 -04:00 committed by GitHub
parent dcf19d3a70
commit a78446dbef
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
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, but only if the entity has an entity method exposed for this event.
* 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 '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.