diff --git a/libraries/entities/src/EntityScriptingInterface.h b/libraries/entities/src/EntityScriptingInterface.h index e0f14b47e7..dae0922f4a 100644 --- a/libraries/entities/src/EntityScriptingInterface.h +++ b/libraries/entities/src/EntityScriptingInterface.h @@ -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. *

See also, {@link Entities|Entity Methods} and {@link Script.addEventHandler}.

* @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. *

See also, {@link Entities|Entity Methods} and {@link Script.addEventHandler}.

* @function Entities.leaveEntity * @param {Uuid} entityID - The ID of the entity that the avatar left.