Format findableBy and audioListenerMode property values as lists

This commit is contained in:
David Rowe 2019-09-20 08:35:23 +12:00
parent d5e08d19e3
commit 19888fad03
2 changed files with 21 additions and 15 deletions

View file

@ -168,10 +168,12 @@ class MyAvatar : public Avatar {
* collision. It can be a mono or stereo 16-bit WAV file running at either 24kHz or 48kHz. The latter is down-sampled
* by the audio mixer, so all audio effectively plays back at a 24khz. 48kHz RAW files are also supported.
* @property {number} audioListenerMode=0 - Specifies the listening position when hearing spatialized audio. Must be one
* of the following property values:<br />
* <code>Myavatar.audioListenerModeHead</code><br />
* <code>Myavatar.audioListenerModeCamera</code><br />
* <code>Myavatar.audioListenerModeCustom</code>
* of the following property values:
* <ul>
* <li><code>MyAvatar.audioListenerModeHead</code></li>
* <li><code>MyAvatar.audioListenerModeCamera</code></li>
* <li><code>MyAvatar.audioListenerModeCustom</code></li>
* </ul>
* @property {number} audioListenerModeHead=0 - The audio listening position is at the avatar's head. <em>Read-only.</em>
* @property {number} audioListenerModeCamera=1 - The audio listening position is at the camera. <em>Read-only.</em>
* @property {number} audioListenerModeCustom=2 - The audio listening position is at a the position specified by set by the

View file

@ -50,12 +50,14 @@ class AccountServicesScriptingInterface : public QObject {
* <code>"Unknown user"</code>. <em>Read-only.</em>
* @property {boolean} loggedIn - <code>true</code> if the user is logged in, otherwise <code>false</code>.
* <em>Read-only.</em>
* @property {string} findableBy - The user's visibility to other users:<br />
* <code>"none"</code> - user appears offline.<br />
* <code>"friends"</code> - user is visible only to friends.<br />
* <code>"connections"</code> - user is visible to friends and connections.<br />
* <code>"all"</code> - user is visible to everyone.
* @property {string} metaverseServerURL - The metaverse server that the user is authenticated against when logged in
* @property {string} findableBy - The user's visibility to other users:
* <ul>
* <li><code>"none"</code> &mdash; user appears offline.</li>
* <li><code>"friends"</code> &mdash; user is visible only to friends.</li>
* <li><code>"connections"</code> &mdash; user is visible to friends and connections.</li>
* <li><code>"all"</code> &mdash; user is visible to everyone.</li>
* </ul>
* @property {string} metaverseServerURL - The metaverse server that the user is authenticated against when logged in
* &mdash; typically <code>"https://metaverse.highfidelity.com"</code>. <em>Read-only.</em>
*/
@ -160,11 +162,13 @@ signals:
/**jsdoc
* Triggered when the user's visibility to others changes.
* @function AccountServices.findableByChanged
* @param {string} findableBy - The user's visibility to other people:<br />
* <code>"none"</code> - user appears offline.<br />
* <code>"friends"</code> - user is visible only to friends.<br />
* <code>"connections"</code> - user is visible to friends and connections.<br />
* <code>"all"</code> - user is visible to everyone.
* @param {string} findableBy - The user's visibility to other people:
* <ul>
* <li><code>"none"</code> &mdash; user appears offline.</li>
* <li><code>"friends"</code> &mdash; user is visible only to friends.</li>
* <li><code>"connections"</code> &mdash; user is visible to friends and connections.</li>
* <li><code>"all"</code> &mdash; user is visible to everyone.</li>
* </ul>
* @returns {Signal}
* @example <caption>Report when your visiblity changes.</caption>
* AccountServices.findableByChanged.connect(function (findableBy) {