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

Clarify jdocs

Browse source
This commit is contained in:
luiscuenca 2019-10-04 13:47:20 -07:00
parent 3a9c829c95
commit 07080f0138
No known key found for this signature in database
GPG key ID: 2387ECD129A6961D
1 changed files with 7 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
interface/src/avatar/MyAvatar.h
View file

@ -272,12 +272,13 @@ class MyAvatar : public Avatar {
* the value.</p>
* @property {number} analogPlusSprintSpeed - The sprint (run) speed of your avatar for the "AnalogPlus" control scheme.
* @property {MyAvatar.SitStandModelType} userRecenterModel - Controls avatar leaning and recentering behavior.
* @property {number} isInSittingState - <code>true</code> if, while in HMD, your avatar is determined to be sitting
* (avatar leaning is disabled, recenntering is enabled), <code>false</code> if your avatar is determined to be standing
* (avatar leaning is enabled, and avatar recenters if it leans too far). If <code>userRecenterModel == 2</code>
* (i.e., auto) the property value automatically updates as the user sits or stands, unless
* <code>isSitStandStateLocked == true</code>. Setting the property value overrides the current siting / standing state,
* which is updated when the user next sits or stands unless <code>isSitStandStateLocked == true</code>.
* @property {number} isInSittingState - <code>true</code> if the user wearing the HMD is determined to be sitting
* (avatar leaning is disabled, recenntering is enabled), <code>false</code> if the user wearing the HMD is
* determined to be standing (avatar leaning is enabled, and avatar recenters if it leans too far).
* If <code>userRecenterModel == 2</code> (i.e., auto) the property value automatically updates as the user sits
* or stands, unless <code>isSitStandStateLocked == true</code>. Setting the property value overrides the current
* siting / standing state, which is updated when the user next sits or stands unless
* <code>isSitStandStateLocked == true</code>.
* @property {boolean} isSitStandStateLocked - <code>true</code> to lock the avatar sitting/standing state, i.e., use this
* to disable automatically changing state.
* @property {boolean} allowTeleporting - <code>true</code> if teleporting is enabled in the Interface settings,