Add more info to jdocs

This commit is contained in:
luiscuenca 2019-09-20 09:51:51 -07:00
parent 365aa1bf03
commit f979c4e1ab
No known key found for this signature in database
GPG key ID: 2387ECD129A6961D

View file

@ -1750,14 +1750,16 @@ public:
void prepareAvatarEntityDataForReload(); void prepareAvatarEntityDataForReload();
/**jsdoc /**jsdoc
* Turn the avatar's head until it faces the target point within the 90/-90 degrees range. * Turn the avatar's head until it faces the target point within the 90/-90 degree range.
* Once this method is called, API calls will have full control of the head for a limited time.
* If this method is not called for two seconds, the engine will regain control of the head.
* @function MyAvatar.setHeadLookAt * @function MyAvatar.setHeadLookAt
* @param {Vec3} lookAtTarget - The target 3D point. * @param {Vec3} lookAtTarget - The target point in world coordinates.
*/ */
Q_INVOKABLE void setHeadLookAt(const glm::vec3& lookAtTarget); Q_INVOKABLE void setHeadLookAt(const glm::vec3& lookAtTarget);
/**jsdoc /**jsdoc
* Returns the current head look at target point in world coordenates. * Returns the current head look at target point in world coordinates.
* @function MyAvatar.getHeadLookAt * @function MyAvatar.getHeadLookAt
* @returns {Vec3} Default position between your avatar's eyes in world coordinates. * @returns {Vec3} Default position between your avatar's eyes in world coordinates.
*/ */