Steamworks v1.1.0
Open on GitHub Open in Dash

GameID

Swift
public struct GameID

extension GameID: Hashable, Comparable, CustomStringConvertible, Sendable

Steamworks CGameID - encapsulates an appID/modID pair

Topics

Properties

The ModID of the GameID, max 32 bits (no typedef for this?)

Declaration
Swift
public var modID: Int { get set }

The AppID of the GameID - note for manual construction this is only a 24-bit value.

Declaration
Swift
public var appID: AppID { get set }

The flat version of the GameID

Declaration
Swift
public var asUInt64: UInt64 { get }

Queries

Is the GameID representing a valid thing?

Declaration
Swift
public var isValid: Bool { get }

Is this a mod?

Declaration
Swift
public var isMod: Bool { get }

Is this a shortcut?

Declaration
Swift
public var isShortcut: Bool { get }

Is this a p2pfile [err what]?

Declaration
Swift
public var isP2PFile: Bool { get }

Is this an app (== game)?

Declaration
Swift
public var isSteamApp: Bool { get }

Initializers

Create a fresh invalid GameID.

Declaration
Swift
public init()

Create a GameID from a flat value

Declaration
Swift
public init(_ gameID: UInt64)

Compound Setters

Clear all fields, leaving an invalid ID.

Declaration
Swift
public mutating func reset()

Conformances

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

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

A human-readable description of the GameID

Declaration
Swift
public var description: String { get }