Steamworks v1.1.0
Open on GitHub Open in Dash

SteamAPI

Swift
public final class SteamAPI: SteamBaseAPI, Sendable

An instance of the Steamworks user API

Create and retain one of these to access and use the Steamworks APIs.

Steamworks ref: steam_api.h

Topics

Lifecycle

Initialize the Steamworks API.

Calls SteamAPI_RestartAppIfNecessary() and SteamAPI_Init().

If you installed a hook with installCEGHooks(initCEG:termCEG:) then the hook is called before SteamAPI_Init().

If you set fakeAppIdTxtFile to true then the system behaves as though you have a steam_appid.txt file in the correct location containing your appID:

  1. SteamAPI_RestartAppIfNecessary() never returns true;
  2. SteamAPI_Init() uses the passed-in App ID. …so it’s a development assist to stop you having to manage the text file.

The Steamworks API is shut down when this object goes out of scope.

Declaration
Swift
public init?(appID: AppID, fakeAppIdTxtFile: Bool = false)
Return Value

nil if the Steam API connection failed or app restart is necessary.

Calls SteamAPI_IsSteamRunning().

Declaration
Swift
public var isSteamRunning: Bool { get }

Interfaces

Access the Steamworks ISteamApps interface

Declaration
Swift
public let apps: SteamApps

Access the Steamworks ISteamFriends interface

Declaration
Swift
public let friends: SteamFriends

Access the Steamworks ISteamGameSearch interface

Declaration
Swift
public let gameSearch: SteamGameSearch

Access the Steamworks ISteamHTMLSurface interface

Declaration
Swift
public let htmlSurface: SteamHTMLSurface

Access the Steamworks ISteamInput interface

Declaration
Swift
public let input: SteamInput

Access the Steamworks ISteamMatchmaking interface

Declaration
Swift
public let matchmaking: SteamMatchmaking

Access the Steamworks ISteamMatchmakingServers interface

Declaration
Swift
public let matchmakingServers: SteamMatchmakingServers

Access the Steamworks ISteamMusic interface

Declaration
Swift
public let music: SteamMusic

Access the Steamworks ISteamMusicRemote interface

Declaration
Swift
public let musicRemote: SteamMusicRemote

Access the Steamworks ISteamParentalSettings interface

Declaration
Swift
public let parentalSettings: SteamParentalSettings

Access the Steamworks ISteamParties interface

Declaration
Swift
public let parties: SteamParties

Access the Steamworks ISteamRemotePlay interface

Declaration
Swift
public let remotePlay: SteamRemotePlay

Access the Steamworks ISteamRemoteStorage interface

Declaration
Swift
public let remoteStorage: SteamRemoteStorage

Access the Steamworks ISteamScreenshots interface

Declaration
Swift
public let screenshots: SteamScreenshots

Access the Steamworks ISteamTimeline interface

Declaration
Swift
public let timeline: SteamTimeline

Access the Steamworks ISteamUser interface

Declaration
Swift
public let user: SteamUser

Access the Steamworks ISteamUserStats interface

Declaration
Swift
public let userStats: SteamUserStats

Access the Steamworks ISteamVideo interface

Declaration
Swift
public let video: SteamVideo

CEG

Initialize Steam DRM hooks.

You can call the hooks manually or pass them in here to let the library call them at the right time around SteamAPI_Init() and SteamAPI_Term().

Call this before actually creating a SteamAPI or SteamGameServerAPI.

Declaration
Swift
public static func installCEGHooks(
    initCEG: @escaping () -> Bool, termCEG: @escaping () -> Void)