Steamworks v1.1.0
Open on GitHub Open in Dash

SteamID

Swift
public struct SteamID

extension SteamID: Hashable, Comparable, CustomStringConvertible, Sendable

The globally unique identifier for all Steam accounts, Steam groups, lobbies, and chat rooms.

Steamworks CSteamID. Methods and interface style to follow Steamworks, see docs there.

Topics

Properties

The universe of the SteamID.

Declaration
Swift
public var universe: Universe { get set }

The account type of the SteamID.

Declaration
Swift
public var accountType: AccountType { get set }

The account instance of the SteamID. Max 20 bits, 0xfffff.

Declaration
Swift
public var accountInstance: Int { get set }

The account ID of the SteamID.

Declaration
Swift
public var accountID: AccountID { get set }

Converts steam ID to its 64-bit representation

Declaration
Swift
public var asUInt64: UInt64 { get }

Converts the static parts of a steam ID to a 64-bit representation.

For multiseat accounts, all instances of that account will have the same static account key, so they can be grouped together by the static account key.

Declaration
Swift
public var staticAccountKey: UInt64 { get }

Queries

Is the SteamID valid?

Declaration
Swift
public var isValid: Bool { get }

Is this an anonymous game server login that will be filled in?

Declaration
Swift
public var isBlankAnonAccount: Bool { get }

Is this a game server account id? (Either persistent or anonymous)

Declaration
Swift
public var isGameServerAccount: Bool { get }

Is this a persistent (not anonymous) game server account id?

Declaration
Swift
public var isPersistentGameServerAccount: Bool { get }

Is this an anonymous game server account id?

Declaration
Swift
public var isAnonGameServerAccount: Bool { get }

Is this a content server account id?

Declaration
Swift
public var isContentServerAccount: Bool { get }

Is this a clan account id?

Declaration
Swift
public var isClanAccount: Bool { get }

Is this a chat account id?

Declaration
Swift
public var isChatAccount: Bool { get }

Is this a chat lobby account id?

Declaration
Swift
public var isLobby: Bool { get }

Is this an individual user account id?

Declaration
Swift
public var isIndividualAccount: Bool { get }

Is this an anonymous account?

Declaration
Swift
public var isAnonAccount: Bool { get }

Is this an anonymous user account? ( used to create an account or reset a password )

Declaration
Swift
public var isAnonUserAccount: Bool { get }

Is this a faked up Steam ID for a PSN friend account?

Declaration
Swift
public var isConsoleUserAccount: Bool { get }

Initializers

Create a fresh invalid SteamID.

Declaration
Swift
public init()

Create a Steam ID using the default instance.

Declaration
Swift
public init(accountID: AccountID, universe: Universe, accountType: AccountType)

Create a Steam ID with an instance.

Declaration
Swift
public init(
    accountID: AccountID, accountInstance: Int, universe: Universe,
    accountType: AccountType)

Create a Steam ID from a 64-bit representation

Declaration
Swift
public init(_ steamID: UInt64)

Compound Setters

Set parameters for steam ID

Declaration
Swift
public mutating func set(
    accountID: AccountID, universe: Universe, accountType: AccountType)

Set parameters for steam ID

Declaration
Swift
public mutating func instancedSet(
    accountID: AccountID, accountInstance: Int, universe: Universe,
    accountType: AccountType)

Initialize a steam ID from its 52 bit parts and universe/type

Declaration
Swift
public mutating func fullSet(
    identifier: UInt64, universe: Universe, accountType: AccountType)

Initialize a steam ID from its 64-bit representation

Declaration
Swift
public mutating func setFromUInt64(_ steamID: UInt64)

Clear all fields, leaving an invalid ID.

Declaration
Swift
public mutating func clear()

Create an anonymous game server login to be filled in by the AM

Declaration
Swift
public mutating func createBlankAnonLogon(universe: Universe)

Create an anonymous game server login to be filled in by the AM

Declaration
Swift
public mutating func createBlankAnonUserLogon(universe: Universe)

Well-known Steam IDs

Generic invalid SteamID

Declaration
Swift
public static let `nil`: SteamID

This steamID comes from a user game connection to an out of date GS that hasnt implemented the protocol to provide its steamID

Declaration
Swift
public static let outOfDateGS: SteamID

This steamID comes from a user game connection to an sv_lan GS

Declaration
Swift
public static let lanModeGS: SteamID

This steamID can come from a user game connection to a GS that has just booted but hasnt yet even initialized its steam3 component and started logging on.

Declaration
Swift
public static let notInitYetGS: SteamID

This steamID can come from a user game connection to a GS that isn’t using the steam authentication system but still wants to support the “Join Game” option in the friends list

Declaration
Swift
public static let nonSteamGS: SteamID

Conformances

Following steam, ordering is defined on the raw 64-bit numeric value, for whatever good that does.

Declaration
Swift
public static func < (lhs: SteamID, rhs: SteamID) -> Bool

A human-readable description of the Steam ID

Declaration
Swift
public var description: String { get }