diff --git a/interface/src/avatar/MyAvatar.h b/interface/src/avatar/MyAvatar.h index 3dcbc2634d..127b0ae83c 100644 --- a/interface/src/avatar/MyAvatar.h +++ b/interface/src/avatar/MyAvatar.h @@ -272,12 +272,12 @@ class MyAvatar : public Avatar { * the value.
* @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 -true
if your avatar is sitting (avatar leaning is disabled,
- * recenntering is enabled), false
if it is standing (avatar leaning is enabled, and avatar recenters if it
- * leans too far). If userRecenterModel == 2
(i.e., auto) the property value automatically updates as the
- * user sits or stands, unless isSitStandStateLocked == true
. Setting the property value overrides the
- * current siting / standing state, which is updated when the user next sits or stands unless
- * isSitStandStateLocked == true
.
+ * @property {number} isInSittingState - true
if, while in HMD, your avatar is determined to be sitting
+ * (avatar leaning is disabled, recenntering is enabled), false
if your avatar is determined to be standing
+ * (avatar leaning is enabled, and avatar recenters if it leans too far). If userRecenterModel == 2
+ * (i.e., auto) the property value automatically updates as the user sits or stands, unless
+ * isSitStandStateLocked == true
. Setting the property value overrides the current siting / standing state,
+ * which is updated when the user next sits or stands unless isSitStandStateLocked == true
.
* @property {boolean} isSitStandStateLocked - true
to lock the avatar sitting/standing state, i.e., use this
* to disable automatically changing state.
* @property {boolean} allowTeleporting - true
if teleporting is enabled in the Interface settings,
@@ -1890,6 +1890,14 @@ public:
*/
Q_INVOKABLE void endSit(const glm::vec3& position, const glm::quat& rotation);
+ /**jsdoc
+ * Gets whether the avatar is in a seated pose. The seated pose is set by calling the
+ * MyAvatar::beginSit method.
+ * @function MyAvatar.isSeated
+ * @returns {boolean} true
if the avatar is in a seated pose.
+ */
+ Q_INVOKABLE bool isSeated() { return _characterController.getSeated(); }
+
int getOverrideJointCount() const;
bool getFlowActive() const;
bool getNetworkGraphActive() const;