SteamUser
public struct SteamUser: Sendable
Steamworks ISteamUser
Access via user
.
Topics
func advertiseGame(gameServer: SteamID, ipServer: Int, portServer: UInt16)
func advertiseGame(gameServer: SteamID, ipServer: Int, portServer: UInt16)
func isBehindNAT() -> Bool
func isBehindNAT() -> Bool
func isPhoneIdentifying() -> Bool
func isPhoneIdentifying() -> Bool
Steamworks ISteamUser::BIsPhoneIdentifying()
Declaration
public func isPhoneIdentifying() -> Bool
func isPhoneRequiringVerification() -> Bool
func isPhoneRequiringVerification() -> Bool
Steamworks ISteamUser::BIsPhoneRequiringVerification()
Declaration
public func isPhoneRequiringVerification() -> Bool
func isPhoneVerified() -> Bool
func isPhoneVerified() -> Bool
func isTwoFactorEnabled() -> Bool
func isTwoFactorEnabled() -> Bool
Steamworks ISteamUser::BIsTwoFactorEnabled()
Declaration
public func isTwoFactorEnabled() -> Bool
func loggedOn() -> Bool
func loggedOn() -> Bool
func setDurationControlOnlineState(newState: DurationControlOnlineState) -> Bool
func setDurationControlOnlineState(newState: DurationControlOnlineState) -> Bool
Steamworks ISteamUser::BSetDurationControlOnlineState()
Declaration
@discardableResult
public func setDurationControlOnlineState(newState: DurationControlOnlineState)
-> Bool
func beginAuthSession(authTicket: UnsafeRawPointer, authTicketSize: Int, steamID: SteamID) -> BeginAuthSessionResult
func beginAuthSession(authTicket: UnsafeRawPointer, authTicketSize: Int, steamID: SteamID) -> BeginAuthSessionResult
Steamworks ISteamUser::BeginAuthSession()
Declaration
public func beginAuthSession(
authTicket: UnsafeRawPointer, authTicketSize: Int, steamID: SteamID
) -> BeginAuthSessionResult
func cancelAuthTicket(authTicket: HAuthTicket)
func cancelAuthTicket(authTicket: HAuthTicket)
Steamworks ISteamUser::CancelAuthTicket()
Declaration
public func cancelAuthTicket(authTicket: HAuthTicket)
func decompressVoice(compressed: UnsafeRawPointer, compressedSize: Int, destBuffer: UnsafeMutableRawPointer, destBufferSize: Int, desiredSampleRate: Int) -> (rc: VoiceResult, bytesWritten: Int)
func decompressVoice(compressed: UnsafeRawPointer, compressedSize: Int, destBuffer: UnsafeMutableRawPointer, destBufferSize: Int, desiredSampleRate: Int) -> (rc: VoiceResult, bytesWritten: Int)
Steamworks ISteamUser::DecompressVoice()
Declaration
public func decompressVoice(
compressed: UnsafeRawPointer, compressedSize: Int,
destBuffer: UnsafeMutableRawPointer, destBufferSize: Int,
desiredSampleRate: Int
) -> (rc: VoiceResult, bytesWritten: Int)
func endAuthSession(steamID: SteamID)
func endAuthSession(steamID: SteamID)
Steamworks ISteamUser::EndAuthSession()
Declaration
public func endAuthSession(steamID: SteamID)
func getAuthSessionTicket(maxTicketSize: Int, steamNetworkingIdentity: SteamNetworkingIdentity?) -> (rc: HAuthTicket, ticket: [UInt8], ticketSize: Int)
func getAuthSessionTicket(maxTicketSize: Int, steamNetworkingIdentity: SteamNetworkingIdentity?) -> (rc: HAuthTicket, ticket: [UInt8], ticketSize: Int)
Steamworks ISteamUser::GetAuthSessionTicket()
Declaration
public func getAuthSessionTicket(
maxTicketSize: Int = 1024, steamNetworkingIdentity: SteamNetworkingIdentity?
) -> (rc: HAuthTicket, ticket: [UInt8], ticketSize: Int)
func getAuthTicketForWebApi(identity: String?) -> HAuthTicket
func getAuthTicketForWebApi(identity: String?) -> HAuthTicket
Steamworks ISteamUser::GetAuthTicketForWebApi()
Declaration
public func getAuthTicketForWebApi(identity: String?) -> HAuthTicket
func getAvailableVoice(uncompressedVoiceDesiredSampleRateDeprecated: Int) -> (rc: VoiceResult, compressedSize: Int, uncompressedDeprecatedSize: Int)
func getAvailableVoice(uncompressedVoiceDesiredSampleRateDeprecated: Int) -> (rc: VoiceResult, compressedSize: Int, uncompressedDeprecatedSize: Int)
Steamworks ISteamUser::GetAvailableVoice()
Declaration
public func getAvailableVoice(
uncompressedVoiceDesiredSampleRateDeprecated: Int = 0
) -> (rc: VoiceResult, compressedSize: Int, uncompressedDeprecatedSize: Int)
func getDurationControl(completion: (sending DurationControl?) -> Void)
func getDurationControl(completion: (sending DurationControl?) -> Void)
Steamworks ISteamUser::GetDurationControl()
, callback
Declaration
public func getDurationControl(
completion: @Sendable @escaping (sending DurationControl?) -> Void)
func getDurationControl(isolation: isolated (any Actor)?) async -> DurationControl?
func getDurationControl(isolation: isolated (any Actor)?) async -> DurationControl?
Steamworks ISteamUser::GetDurationControl()
, async
Declaration
public func getDurationControl(isolation: isolated (any Actor)? = #isolation)
async -> DurationControl?
func getEncryptedAppTicket(returnTicket: Bool, maxTicketSize: Int) -> (rc: Bool, ticket: [UInt8], ticketSize: Int)
func getEncryptedAppTicket(returnTicket: Bool, maxTicketSize: Int) -> (rc: Bool, ticket: [UInt8], ticketSize: Int)
func getGameBadgeLevel(series: Int, foil: Bool) -> Int
func getGameBadgeLevel(series: Int, foil: Bool) -> Int
func getHSteamUser() -> HSteamUser
func getHSteamUser() -> HSteamUser
func getMarketEligibility(completion: (sending MarketEligibilityResponse?) -> Void)
func getMarketEligibility(completion: (sending MarketEligibilityResponse?) -> Void)
Steamworks ISteamUser::GetMarketEligibility()
, callback
Declaration
public func getMarketEligibility(
completion: @Sendable @escaping (sending MarketEligibilityResponse?) -> Void
)
func getMarketEligibility(isolation: isolated (any Actor)?) async -> MarketEligibilityResponse?
func getMarketEligibility(isolation: isolated (any Actor)?) async -> MarketEligibilityResponse?
Steamworks ISteamUser::GetMarketEligibility()
, async
Declaration
public func getMarketEligibility(isolation: isolated (any Actor)? = #isolation)
async -> MarketEligibilityResponse?
func getPlayerSteamLevel() -> Int
func getPlayerSteamLevel() -> Int
Steamworks ISteamUser::GetPlayerSteamLevel()
Declaration
public func getPlayerSteamLevel() -> Int
func getSteamID() -> SteamID
func getSteamID() -> SteamID
func getUserDataFolder(bufferSize: Int) -> (rc: Bool, buffer: String)
func getUserDataFolder(bufferSize: Int) -> (rc: Bool, buffer: String)
Steamworks ISteamUser::GetUserDataFolder()
Declaration
public func getUserDataFolder(bufferSize: Int = SteamConstants.filenameMaxSize)
-> (rc: Bool, buffer: String)
func getVoice(wantCompressed: Bool, destBuffer: UnsafeMutableRawPointer, destBufferSize: Int, wantUncompressedDeprecated: Bool, uncompressedDestBufferDeprecated: UnsafeMutableRawPointer?, uncompressedDestBufferSizeDeprecatedSize: Int, uncompressedVoiceDesiredSampleRateDeprecated: Int) -> (rc: VoiceResult, bytesWritten: Int, uncompressBytesWrittenDeprecated: Int)
func getVoice(wantCompressed: Bool, destBuffer: UnsafeMutableRawPointer, destBufferSize: Int, wantUncompressedDeprecated: Bool, uncompressedDestBufferDeprecated: UnsafeMutableRawPointer?, uncompressedDestBufferSizeDeprecatedSize: Int, uncompressedVoiceDesiredSampleRateDeprecated: Int) -> (rc: VoiceResult, bytesWritten: Int, uncompressBytesWrittenDeprecated: Int)
Steamworks ISteamUser::GetVoice()
Declaration
public func getVoice(
wantCompressed: Bool, destBuffer: UnsafeMutableRawPointer,
destBufferSize: Int, wantUncompressedDeprecated: Bool = false,
uncompressedDestBufferDeprecated: UnsafeMutableRawPointer? = nil,
uncompressedDestBufferSizeDeprecatedSize: Int = 0,
uncompressedVoiceDesiredSampleRateDeprecated: Int = 0
) -> (rc: VoiceResult, bytesWritten: Int, uncompressBytesWrittenDeprecated: Int)
func getVoiceOptimalSampleRate() -> Int
func getVoiceOptimalSampleRate() -> Int
Steamworks ISteamUser::GetVoiceOptimalSampleRate()
Declaration
public func getVoiceOptimalSampleRate() -> Int
func initiateGameConnectionDEPRECATED(authBlob: UnsafeMutableRawPointer, maxAuthBlobSize: Int, gameServer: SteamID, ipServer: Int, portServer: UInt16, secure: Bool) -> Int
func initiateGameConnectionDEPRECATED(authBlob: UnsafeMutableRawPointer, maxAuthBlobSize: Int, gameServer: SteamID, ipServer: Int, portServer: UInt16, secure: Bool) -> Int
func requestEncryptedAppTicket(dataToInclude: [UInt8], completion: (sending EncryptedAppTicketResponse?) -> Void)
func requestEncryptedAppTicket(dataToInclude: [UInt8], completion: (sending EncryptedAppTicketResponse?) -> Void)
Steamworks ISteamUser::RequestEncryptedAppTicket()
, callback
Declaration
public func requestEncryptedAppTicket(
dataToInclude: [UInt8],
completion: @Sendable @escaping (sending EncryptedAppTicketResponse?) ->
Void)
func requestEncryptedAppTicket(isolation: isolated (any Actor)?, dataToInclude: [UInt8]) async -> EncryptedAppTicketResponse?
func requestEncryptedAppTicket(isolation: isolated (any Actor)?, dataToInclude: [UInt8]) async -> EncryptedAppTicketResponse?
Steamworks ISteamUser::RequestEncryptedAppTicket()
, async
Declaration
public func requestEncryptedAppTicket(
isolation: isolated (any Actor)? = #isolation, dataToInclude: [UInt8]
) async -> EncryptedAppTicketResponse?
func requestStoreAuthURL(redirectURL: String, completion: (sending StoreAuthURLResponse?) -> Void)
func requestStoreAuthURL(redirectURL: String, completion: (sending StoreAuthURLResponse?) -> Void)
Steamworks ISteamUser::RequestStoreAuthURL()
, callback
Declaration
public func requestStoreAuthURL(
redirectURL: String,
completion: @Sendable @escaping (sending StoreAuthURLResponse?) -> Void)
func requestStoreAuthURL(isolation: isolated (any Actor)?, redirectURL: String) async -> StoreAuthURLResponse?
func requestStoreAuthURL(isolation: isolated (any Actor)?, redirectURL: String) async -> StoreAuthURLResponse?
Steamworks ISteamUser::RequestStoreAuthURL()
, async
Declaration
public func requestStoreAuthURL(
isolation: isolated (any Actor)? = #isolation, redirectURL: String
) async -> StoreAuthURLResponse?
func startVoiceRecording()
func startVoiceRecording()
Steamworks ISteamUser::StartVoiceRecording()
Declaration
public func startVoiceRecording()
func stopVoiceRecording()
func stopVoiceRecording()
Steamworks ISteamUser::StopVoiceRecording()
Declaration
public func stopVoiceRecording()
func terminateGameConnectionDEPRECATED(ipServer: Int, portServer: UInt16)
func terminateGameConnectionDEPRECATED(ipServer: Int, portServer: UInt16)
func trackAppUsageEvent(id: GameID, appUsageEvent: Int, extraInfo: String)
func trackAppUsageEvent(id: GameID, appUsageEvent: Int, extraInfo: String)
func userHasLicenseForApp(steamID: SteamID, id: AppID) -> UserHasLicenseForAppResult
func userHasLicenseForApp(steamID: SteamID, id: AppID) -> UserHasLicenseForAppResult
Steamworks ISteamUser::UserHasLicenseForApp()
Declaration
public func userHasLicenseForApp(steamID: SteamID, id: AppID)
-> UserHasLicenseForAppResult
func getEncryptedAppTicket() -> [UInt8]?
func getEncryptedAppTicket() -> [UInt8]?
Provided by module SteamworksHelpers
.
Steamworks ISteamUser::GetEncryptedAppTicket()
Declaration
public func getEncryptedAppTicket() -> [UInt8]?