Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-04-11 01:42:11 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Added an hyperlink to preload in enterEntity JSdoc

Browse source 
1- Added an hyperlink to "preload" signal in enterEntity JSdoc.
2- Removed the useless 
", but only if the entity has an entity method exposed for this event." 
from "enterEntity" and "leaveEntity" JSdoc (lines 2402 and 2413)
This commit is contained in:
Alezia Kurdis 2020-07-07 23:05:24 -04:00 committed by GitHub
parent a78446dbef
commit 6c24f646bb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -2399,9 +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 'preload' signal can be used to handle those cases.
* 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.
@ -2410,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.