Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-09 15:49:24 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Revise JSDoc for new MyAvatar signals

Browse source
This commit is contained in:
David Rowe 2019-06-12 19:15:14 +12:00
parent b9e2443451
commit 93d42917b0
1 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -2190,33 +2190,35 @@ signals:
void audioListenerModeChanged(); void audioListenerModeChanged();
/**jsdoc /**jsdoc
* Notifies when the analogPlusWalkSpeed value is changed. * Triggered when the walk speed set for the "AnalogPlus" control scheme changes.
* @function MyAvatar.analogPlusWalkSpeedChanged * @function MyAvatar.analogPlusWalkSpeedChanged
* @param {float} value - the new avatar walk speed * @param {number} speed - The new walk speed set for the "AnalogPlus" control scheme.
* @returns {Signal} * @returns {Signal}
*/ */
void analogPlusWalkSpeedChanged(float value); void analogPlusWalkSpeedChanged(float value);
/**jsdoc /**jsdoc
* Notifies when the analogPlusSprintSpeed value is changed. * Triggered when the sprint (run) speed set for the "AnalogPlus" control scheme changes.
* @function MyAvatar.analogPlusSprintSpeedChanged * @function MyAvatar.analogPlusSprintSpeedChanged
* @param {float} value - the new avatar sprint speed * @param {number} speed - The new sprint speed set for the "AnalogPlus" control scheme.
* @returns {Signal} * @returns {Signal}
*/ */
void analogPlusSprintSpeedChanged(float value); void analogPlusSprintSpeedChanged(float value);
/**jsdoc /**jsdoc
* Notifies when the sprintSpeed value is changed. * Triggered when the sprint (run) speed set for the current control scheme (see
* {@link MyAvatar.getControlScheme|getControlScheme}) changes.
* @function MyAvatar.sprintSpeedChanged * @function MyAvatar.sprintSpeedChanged
* @param {float} value - the new avatar sprint speed * @param {number} speed -The new sprint speed set for the current control scheme.
* @returns {Signal} * @returns {Signal}
*/ */
void sprintSpeedChanged(float value); void sprintSpeedChanged(float value);
/**jsdoc /**jsdoc
* Notifies when the walkBackwardSpeed value is changed. * Triggered when the walk backward speed set for the current control scheme (see
* {@link MyAvatar.getControlScheme|getControlScheme}) changes.
* @function MyAvatar.walkBackwardSpeedChanged * @function MyAvatar.walkBackwardSpeedChanged
* @param {float} value - the new avatar walk backward speed * @param {number} speed - The new walk backward speed set for the current control scheme.
* @returns {Signal} * @returns {Signal}
*/ */
void walkBackwardSpeedChanged(float value); void walkBackwardSpeedChanged(float value);