Steam API JSDoc stubs

This commit is contained in:
David Rowe 2018-05-13 10:32:46 +12:00
parent 81a621890a
commit fb1f7fea90
2 changed files with 19 additions and 0 deletions

View file

@ -40,6 +40,15 @@ public:
virtual int getSteamVRBuildID() = 0;
};
/**jsdoc
* @namespace Steam
*
* @hifi-interface
* @hifi-client-entity
*
* @property {boolean} running - <em>Read-only.</em>
*/
class SteamScriptingInterface : public QObject {
Q_OBJECT
@ -49,7 +58,16 @@ public:
SteamScriptingInterface(QObject* parent, SteamClientPlugin* plugin) : QObject(parent), _plugin(plugin) {}
public slots:
/**jsdoc
* @function Steam.isRunning
* @returns {boolean}
*/
bool isRunning() const { return _plugin && _plugin->isRunning(); }
/**jsdoc
* @function Steam.openInviteOverlay
*/
void openInviteOverlay() const { if (_plugin) { _plugin->openInviteOverlay(); } }
private:

View file

@ -52,6 +52,7 @@ exports.handlers = {
'../../libraries/networking/src',
'../../libraries/octree/src',
'../../libraries/physics/src',
'../../libraries/plugins/src/plugins',
'../../libraries/pointers/src',
'../../libraries/script-engine/src',
'../../libraries/shared/src',