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

Merge pull request #789 from kasenvr/fix/apidocs-find-entities

Browse source 
Update API docs to specify entity-server-script findEntities caveat.
This commit is contained in:
kasenvr 2020-10-13 05:20:43 -04:00 committed by GitHub
commit 36a4ab8c12
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -709,6 +709,8 @@ public slots:
/**jsdoc
* Finds all domain and avatar entities that intersect a sphere.
* <p><strong>Note:</strong> Server entity scripts only find entities that have a server entity script
* running in them or a parent entity. You can apply a dummy script to entities that you want found in a search.</p>
* @function Entities.findEntities
* @param {Vec3} center - The point about which to search.
* @param {number} radius - The radius within which to search.
@ -723,6 +725,8 @@ public slots:
/**jsdoc
* Finds all domain and avatar entities whose axis-aligned boxes intersect a search axis-aligned box.
* <p><strong>Note:</strong> Server entity scripts only find entities that have a server entity script
* running in them or a parent entity. You can apply a dummy script to entities that you want found in a search.</p>
* @function Entities.findEntitiesInBox
* @param {Vec3} corner - The corner of the search AA box with minimum co-ordinate values.
* @param {Vec3} dimensions - The dimensions of the search AA box.
@ -734,6 +738,8 @@ public slots:
/**jsdoc
* Finds all domain and avatar entities whose axis-aligned boxes intersect a search frustum.
* <p><strong>Note:</strong> Server entity scripts only find entities that have a server entity script
* running in them or a parent entity. You can apply a dummy script to entities that you want found in a search.</p>
* @function Entities.findEntitiesInFrustum
* @param {ViewFrustum} frustum - The frustum to search in. The <code>position</code>, <code>orientation</code>,
* <code>projection</code>, and <code>centerRadius</code> properties must be specified. The <code>fieldOfView</code>
@ -749,6 +755,8 @@ public slots:
/**jsdoc
* Finds all domain and avatar entities of a particular type that intersect a sphere.
* <p><strong>Note:</strong> Server entity scripts only find entities that have a server entity script
* running in them or a parent entity. You can apply a dummy script to entities that you want found in a search.</p>
* @function Entities.findEntitiesByType
* @param {Entities.EntityType} entityType - The type of entity to search for.
* @param {Vec3} center - The point about which to search.
@ -764,6 +772,8 @@ public slots:
/**jsdoc
* Finds all domain and avatar entities with a particular name that intersect a sphere.
* <p><strong>Note:</strong> Server entity scripts only find entities that have a server entity script
* running in them or a parent entity. You can apply a dummy script to entities that you want found in a search.</p>
* @function Entities.findEntitiesByName
* @param {string} entityName - The name of the entity to search for.
* @param {Vec3} center - The point about which to search.