Mirrors/overte-HifiExperiments
3
0
Fork 0
mirror of https://github.com/HifiExperiments/overte.git synced 2025-04-14 08:16:03 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Agent JSDoc tidying

Browse source
This commit is contained in:
David Rowe 2019-02-27 09:34:05 +13:00
parent 7f1ae63439
commit 0c59f983da
1 changed files with 9 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
assignment-client/src/AgentScriptingInterface.h
View file

@ -63,21 +63,27 @@ public:
public slots:
/**jsdoc
* Set whether or not the script should emulate an avatar.
* Sets whether or not the script should emulate an avatar.
* @function Agent.setIsAvatar
* @param {boolean} isAvatar - <code>true</code> if the script should act as if an avatar, otherwise <code>false</code>.
* @example <caption>Make an assignment client script emulate an avatar.</caption>
* (function () {
* Agent.setIsAvatar(true);
* Avatar.displayName = "AC avatar";
* print("Position: " + JSON.stringify(Avatar.position)); // 0, 0, 0
* }());
*/
void setIsAvatar(bool isAvatar) const { _agent->setIsAvatar(isAvatar); }
/**jsdoc
* Check whether or not the script is emulating an avatar.
* Checks whether or not the script is emulating an avatar.
* @function Agent.isAvatar
* @returns {boolean} <code>true</code> if the script is acting as if an avatar, otherwise <code>false</code>.
*/
bool isAvatar() const { return _agent->isAvatar(); }
/**jsdoc
* Play a sound from the position and with the orientation of the emulated avatar's head. No sound is played unless
* Plays a sound from the position and with the orientation of the emulated avatar's head. No sound is played unless
* <code>isAvatar == true</code>.
* @function Agent.playAvatarSound
* @param {SoundObject} avatarSound - The sound to play.