Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-08 03:17:06 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Review Entites.cloneEntity() JSDoc and add JSDoc for new properties

Browse source
This commit is contained in:
David Rowe 2018-05-30 10:02:10 +12:00
parent a9c4eab099
commit ac0607b5ae
2 changed files with 14 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
libraries/entities/src/EntityItemProperties.cpp
View file

@ -595,6 +595,15 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const {
* @property {Entities.RenderInfo} renderInfo - Information on the cost of rendering the entity. Currently information is only
* provided for <code>Model</code> entities. <em>Read-only.</em>
*
* @property {boolean} cloneable=false - If <code>true</code> then the entity can be cloned via {@link Entities.cloneEntity}.
* @property {number} cloneLifetime=300 - The entity lifetime for clones created from this entity.
* @property {number} cloneLimit=0 - The total number of clones of this entity that can exist in the domain at any given time.
* @property {boolean} cloneDynamic=false - If <code>true</code> then clones created from this entity will have their
* <code>dynamic</code> property set to <code>true</code>.
* @property {boolean} cloneAvatarEntity=false - If <code>true</code> then clones created from this entity will be created as
* avatar entities: their <code>clientOnly</code> property will be set to <code>true</code>.
* @property {Uuid} cloneOriginID - The ID of the entity that this entity was cloned from.
*
* @property {string} itemName="" - Certifiable name of the Marketplace item.
* @property {string} itemDescription="" - Certifiable description of the Marketplace item.
* @property {string} itemCategories="" - Certifiable category of the Marketplace item.

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

@ -225,12 +225,12 @@ public slots:
bool collisionless, const glm::vec3& position, const glm::vec3& gravity);
/**jsdoc
* Request a clone of an entity. Only entities that have been marked as 'cloneable' will be able to be cloned using this method.
* A cloned entity has most of the properties of the orignal entity, and can be requested from clients that do not have rez permissions.
* The client requests a clone from the entity server, which returns back the entityID of a valid clone if the operation was allowed.
* Create a clone of an entity. A clone can be created by a client that doesn't have rez permissions in the current domain.
* The entity must have its <code>cloneable</code> property set to <code>true</code>. The clone has a modified name, other
* properties set per its clone related-properties, and its clone-related properties are set to defaults.
* @function Entities.cloneEntity
* @param {Uuid} entityIDToClone - the ID of the entity to clone
* @returns {Entities.EntityID} The ID of the newly created clone
* @param {Uuid} entityID - The ID of the entity to clone.
* @returns {Uuid} The ID of the new entity if successfully cloned, otherwise {@link Uuid|Uuid.NULL}.
*/
Q_INVOKABLE QUuid cloneEntity(QUuid entityIDToClone);