five-on-it / apps/client/electron/steam / Steamworks

Interface: Steamworks

Defined in: apps/client/electron/steam.ts:45

What the app uses of steamworks.js.

Methods

electronEnableSteamOverlay()

electronEnableSteamOverlay(disableEachFrameInvalidation?): void

Defined in: apps/client/electron/steam.ts:51

Turns the Steam overlay on for Electron's windows (before the app is ready).

Parameters

disableEachFrameInvalidation?

boolean

Returns

void

---

init()

init(appId): SteamClient

Defined in: apps/client/electron/steam.ts:47

Starts Steam's client API for the app; throws when Steam is not running.

Parameters

appId

number

Returns

SteamClient

---

restartAppIfNecessary()

restartAppIfNecessary(appId): boolean

Defined in: apps/client/electron/steam.ts:49

Whether Steam must start the app (launched outside it): then it quits.

Parameters

appId

number

Returns

boolean