High Fidelity API Reference

Steam

• Properties • Methods • Method Details •

Description

Supported Script Types: Interface Scripts • Client Entity Scripts • Avatar Scripts

The Steam API provides facilities for working with the Steam version of Interface.

Properties

Name Type Summary
running boolean

true if Interface is running under Steam, false if it isn't. Read-only.

Methods

Name Return Value Summary
isRunning boolean

Gets whether Interface is running under Steam.
openInviteOverlay None

Opens Steam's "Choose Friends to invite" dialog if Interface is running under Steam.

Method Details

(static) isRunning( ) → {boolean}
Returns: true if Interface is running under Steam, false if it isn't.

Gets whether Interface is running under Steam.
(static) openInviteOverlay( )

Opens Steam's "Choose Friends to invite" dialog if Interface is running under Steam.

Example

Invite Steam friends to join you in High Fidelity.

if (Steam.running) {
    print("Invite Steam friends to joint you...");
    Steam.openInviteOverlay();
} else {
    print("Interface isn't running under Steam.");
}