Steamworks v1.1.0
Open on GitHub Open in Dash

SteamFriends

Swift
public struct SteamFriends: Sendable

Steamworks ISteamFriends

Access via friends.

Topics

Steamworks ISteamFriends::ActivateGameOverlay()

Declaration
Swift
public func activateGameOverlay(dialog: String)

Steamworks ISteamFriends::ActivateGameOverlayInviteDialog()

Declaration
Swift
public func activateGameOverlayInviteDialog(lobby: SteamID)

Steamworks ISteamFriends::ActivateGameOverlayInviteDialogConnectString()

Declaration
Swift
public func activateGameOverlayInviteDialogConnectString(connectString: String)

Steamworks ISteamFriends::ActivateGameOverlayRemotePlayTogetherInviteDialog()

Declaration
Swift
public func activateGameOverlayRemotePlayTogetherInviteDialog(lobby: SteamID)

Steamworks ISteamFriends::ActivateGameOverlayToStore()

Declaration
Swift
public func activateGameOverlayToStore(appID: AppID, flag: OverlayToStoreFlag)

Steamworks ISteamFriends::ActivateGameOverlayToUser()

Declaration
Swift
public func activateGameOverlayToUser(dialog: String, steamID: SteamID)

Steamworks ISteamFriends::ActivateGameOverlayToWebPage()

Declaration
Swift
public func activateGameOverlayToWebPage(
    url: String, mode: ActivateGameOverlayToWebPageMode)

Steamworks ISteamFriends::BHasEquippedProfileItem()

Declaration
Swift
public func hasEquippedProfileItem(
    steamID: SteamID, type: CommunityProfileItemType
) -> Bool

Steamworks ISteamFriends::ClearRichPresence()

Declaration
Swift
public func clearRichPresence()

Steamworks ISteamFriends::CloseClanChatWindowInSteam()

Declaration
Swift
public func closeClanChatWindowInSteam(clanChat: SteamID) -> Bool

Steamworks ISteamFriends::DownloadClanActivityCounts(), callback

Declaration
Swift
public func downloadClanActivityCounts(
    clans: [SteamID],
    completion: @Sendable @escaping (sending DownloadClanActivityCountsResult?)
        -> Void)

Steamworks ISteamFriends::DownloadClanActivityCounts(), async

Declaration
Swift
public func downloadClanActivityCounts(
    isolation: isolated (any Actor)? = #isolation, clans: [SteamID]
) async -> DownloadClanActivityCountsResult?

Steamworks ISteamFriends::EnumerateFollowingList(), callback

Declaration
Swift
public func enumerateFollowingList(
    startIndex: Int,
    completion: @Sendable @escaping (sending FriendsEnumerateFollowingList?) ->
        Void)

Steamworks ISteamFriends::EnumerateFollowingList(), async

Declaration
Swift
public func enumerateFollowingList(
    isolation: isolated (any Actor)? = #isolation, startIndex: Int
) async -> FriendsEnumerateFollowingList?

Steamworks ISteamFriends::GetChatMemberByIndex()

Declaration
Swift
public func getChatMemberByIndex(clan: SteamID, userIndex: Int) -> SteamID

Steamworks ISteamFriends::GetClanActivityCounts()

Declaration
Swift
public func getClanActivityCounts(clan: SteamID) -> (
    rc: Bool, online: Int, inGame: Int, chatting: Int
)

Steamworks ISteamFriends::GetClanByIndex()

Declaration
Swift
public func getClanByIndex(clanIndex: Int) -> SteamID

Steamworks ISteamFriends::GetClanChatMemberCount()

Declaration
Swift
public func getClanChatMemberCount(clan: SteamID) -> Int

Steamworks ISteamFriends::GetClanChatMessage()

Declaration
Swift
public func getClanChatMessage(
    clanChat: SteamID, messageIndex: Int,
    textMaxSize: Int = SteamConstants.chatMetadataMaxSize + 1
) -> (rc: Int, text: String, chatEntryType: ChatEntryType, chatter: SteamID)

Steamworks ISteamFriends::GetClanCount()

Declaration
Swift
public func getClanCount() -> Int

Steamworks ISteamFriends::GetClanName()

Declaration
Swift
public func getClanName(clan: SteamID) -> String

Steamworks ISteamFriends::GetClanOfficerByIndex()

Declaration
Swift
public func getClanOfficerByIndex(clan: SteamID, officerIndex: Int) -> SteamID

Steamworks ISteamFriends::GetClanOfficerCount()

Declaration
Swift
public func getClanOfficerCount(clan: SteamID) -> Int

Steamworks ISteamFriends::GetClanOwner()

Declaration
Swift
public func getClanOwner(clan: SteamID) -> SteamID

Steamworks ISteamFriends::GetClanTag()

Declaration
Swift
public func getClanTag(clan: SteamID) -> String

Steamworks ISteamFriends::GetCoplayFriend()

Declaration
Swift
public func getCoplayFriend(coplayFriendIndex: Int) -> SteamID

Steamworks ISteamFriends::GetCoplayFriendCount()

Declaration
Swift
public func getCoplayFriendCount() -> Int

Steamworks ISteamFriends::GetFollowerCount(), callback

Declaration
Swift
public func getFollowerCount(
    steamID: SteamID,
    completion: @Sendable @escaping (sending FriendsGetFollowerCount?) -> Void)

Steamworks ISteamFriends::GetFollowerCount(), async

Declaration
Swift
public func getFollowerCount(
    isolation: isolated (any Actor)? = #isolation, steamID: SteamID
) async -> FriendsGetFollowerCount?

Steamworks ISteamFriends::GetFriendByIndex()

Declaration
Swift
public func getFriendByIndex(friendIndex: Int, friendFlags: FriendFlags)
    -> SteamID

Steamworks ISteamFriends::GetFriendCoplayGame()

Declaration
Swift
public func getFriendCoplayGame(friend: SteamID) -> AppID

Steamworks ISteamFriends::GetFriendCoplayTime()

Declaration
Swift
public func getFriendCoplayTime(friend: SteamID) -> Int

Steamworks ISteamFriends::GetFriendCount()

Declaration
Swift
public func getFriendCount(friendFlags: FriendFlags) -> Int

Steamworks ISteamFriends::GetFriendCountFromSource()

Declaration
Swift
public func getFriendCountFromSource(source: SteamID) -> Int

Steamworks ISteamFriends::GetFriendFromSourceByIndex()

Declaration
Swift
public func getFriendFromSourceByIndex(source: SteamID, friendIndex: Int)
    -> SteamID

Steamworks ISteamFriends::GetFriendGamePlayed()

Declaration
Swift
public func getFriendGamePlayed(friend: SteamID) -> (
    rc: Bool, friendGameInfo: FriendGameInfo
)

Steamworks ISteamFriends::GetFriendMessage()

Declaration
Swift
public func getFriendMessage(
    friend: SteamID, messageIDIndex: Int,
    dataSize: Int = SteamConstants.chatMetadataMaxSize + 1
) -> (rc: Int, data: String, chatEntryType: ChatEntryType)

Steamworks ISteamFriends::GetFriendPersonaName()

Declaration
Swift
public func getFriendPersonaName(friend: SteamID) -> String

Steamworks ISteamFriends::GetFriendPersonaNameHistory()

Declaration
Swift
public func getFriendPersonaNameHistory(friend: SteamID, personaNameIndex: Int)
    -> String

Steamworks ISteamFriends::GetFriendPersonaState()

Declaration
Swift
public func getFriendPersonaState(friend: SteamID) -> PersonaState

Steamworks ISteamFriends::GetFriendRelationship()

Declaration
Swift
public func getFriendRelationship(friend: SteamID) -> FriendRelationship

Steamworks ISteamFriends::GetFriendRichPresence()

Declaration
Swift
public func getFriendRichPresence(friend: SteamID, key: String) -> String

Steamworks ISteamFriends::GetFriendRichPresenceKeyByIndex()

Declaration
Swift
public func getFriendRichPresenceKeyByIndex(friend: SteamID, keyIndex: Int)
    -> String

Steamworks ISteamFriends::GetFriendRichPresenceKeyCount()

Declaration
Swift
public func getFriendRichPresenceKeyCount(friend: SteamID) -> Int

Steamworks ISteamFriends::GetFriendSteamLevel()

Declaration
Swift
public func getFriendSteamLevel(friend: SteamID) -> Int

Steamworks ISteamFriends::GetFriendsGroupCount()

Declaration
Swift
public func getFriendsGroupCount() -> Int

Steamworks ISteamFriends::GetFriendsGroupIDByIndex()

Declaration
Swift
public func getFriendsGroupIDByIndex(fgIndex: Int) -> FriendsGroupID

Steamworks ISteamFriends::GetFriendsGroupMembersCount()

Declaration
Swift
public func getFriendsGroupMembersCount(friendsGroupID: FriendsGroupID) -> Int

Steamworks ISteamFriends::GetFriendsGroupMembersList()

Declaration
Swift
public func getFriendsGroupMembersList(
    friendsGroupID: FriendsGroupID, membersCount: Int
) -> [SteamID]

Steamworks ISteamFriends::GetFriendsGroupName()

Declaration
Swift
public func getFriendsGroupName(friendsGroupID: FriendsGroupID) -> String?

Steamworks ISteamFriends::GetLargeFriendAvatar()

Declaration
Swift
public func getLargeFriendAvatar(friend: SteamID) -> Int

Steamworks ISteamFriends::GetMediumFriendAvatar()

Declaration
Swift
public func getMediumFriendAvatar(friend: SteamID) -> Int

Steamworks ISteamFriends::GetNumChatsWithUnreadPriorityMessages()

Declaration
Swift
public func getNumChatsWithUnreadPriorityMessages() -> Int

Steamworks ISteamFriends::GetPersonaName()

Declaration
Swift
public func getPersonaName() -> String

Steamworks ISteamFriends::GetPersonaState()

Declaration
Swift
public func getPersonaState() -> PersonaState

Steamworks ISteamFriends::GetPlayerNickname()

Declaration
Swift
public func getPlayerNickname(player: SteamID) -> String?

Steamworks ISteamFriends::GetProfileItemPropertyString()

Declaration
Swift
public func getProfileItemPropertyString(
    steamID: SteamID, type: CommunityProfileItemType,
    prop: CommunityProfileItemProperty
) -> String

Steamworks ISteamFriends::GetProfileItemPropertyUint()

Declaration
Swift
public func getProfileItemPropertyUint(
    steamID: SteamID, type: CommunityProfileItemType,
    prop: CommunityProfileItemProperty
) -> Int

Steamworks ISteamFriends::GetSmallFriendAvatar()

Declaration
Swift
public func getSmallFriendAvatar(friend: SteamID) -> Int

Steamworks ISteamFriends::GetUserRestrictions()

Declaration
Swift
public func getUserRestrictions() -> UserRestriction

Steamworks ISteamFriends::HasFriend()

Declaration
Swift
public func hasFriend(friend: SteamID, friendFlags: FriendFlags) -> Bool

Steamworks ISteamFriends::InviteUserToGame()

Declaration
Swift
public func inviteUserToGame(friend: SteamID, connectString: String) -> Bool

Steamworks ISteamFriends::IsClanChatAdmin()

Declaration
Swift
public func isClanChatAdmin(clanChat: SteamID, user: SteamID) -> Bool

Steamworks ISteamFriends::IsClanChatWindowOpenInSteam()

Declaration
Swift
public func isClanChatWindowOpenInSteam(clanChat: SteamID) -> Bool

Steamworks ISteamFriends::IsClanOfficialGameGroup()

Declaration
Swift
public func isClanOfficialGameGroup(clan: SteamID) -> Bool

Steamworks ISteamFriends::IsClanPublic()

Declaration
Swift
public func isClanPublic(clan: SteamID) -> Bool

Steamworks ISteamFriends::IsFollowing(), callback

Declaration
Swift
public func isFollowing(
    steamID: SteamID,
    completion: @Sendable @escaping (sending FriendsIsFollowing?) -> Void)

Steamworks ISteamFriends::IsFollowing(), async

Declaration
Swift
public func isFollowing(
    isolation: isolated (any Actor)? = #isolation, steamID: SteamID
) async -> FriendsIsFollowing?

Steamworks ISteamFriends::IsUserInSource()

Declaration
Swift
public func isUserInSource(user: SteamID, source: SteamID) -> Bool

Steamworks ISteamFriends::JoinClanChatRoom(), callback

Declaration
Swift
public func joinClanChatRoom(
    clan: SteamID,
    completion: @Sendable @escaping (sending JoinClanChatRoomCompletionResult?)
        -> Void)

Steamworks ISteamFriends::JoinClanChatRoom(), async

Declaration
Swift
public func joinClanChatRoom(
    isolation: isolated (any Actor)? = #isolation, clan: SteamID
) async -> JoinClanChatRoomCompletionResult?

Steamworks ISteamFriends::LeaveClanChatRoom()

Declaration
Swift
public func leaveClanChatRoom(clan: SteamID) -> Bool

Steamworks ISteamFriends::OpenClanChatWindowInSteam()

Declaration
Swift
public func openClanChatWindowInSteam(clanChat: SteamID) -> Bool

Steamworks ISteamFriends::RegisterProtocolInOverlayBrowser()

Declaration
Swift
public func registerProtocolInOverlayBrowser(protocol: String) -> Bool

Steamworks ISteamFriends::ReplyToFriendMessage()

Declaration
Swift
public func replyToFriendMessage(friend: SteamID, msgToSend: String) -> Bool

Steamworks ISteamFriends::RequestClanOfficerList(), callback

Declaration
Swift
public func requestClanOfficerList(
    clan: SteamID,
    completion: @Sendable @escaping (sending ClanOfficerListResponse?) -> Void)

Steamworks ISteamFriends::RequestClanOfficerList(), async

Declaration
Swift
public func requestClanOfficerList(
    isolation: isolated (any Actor)? = #isolation, clan: SteamID
) async -> ClanOfficerListResponse?

Steamworks ISteamFriends::RequestEquippedProfileItems(), callback

Declaration
Swift
public func requestEquippedProfileItems(
    steamID: SteamID,
    completion: @Sendable @escaping (sending EquippedProfileItems?) -> Void)

Steamworks ISteamFriends::RequestEquippedProfileItems(), async

Declaration
Swift
public func requestEquippedProfileItems(
    isolation: isolated (any Actor)? = #isolation, steamID: SteamID
) async -> EquippedProfileItems?

Steamworks ISteamFriends::RequestFriendRichPresence()

Declaration
Swift
public func requestFriendRichPresence(friend: SteamID)

Steamworks ISteamFriends::RequestUserInformation()

Declaration
Swift
public func requestUserInformation(user: SteamID, requireNameOnly: Bool) -> Bool

Steamworks ISteamFriends::SendClanChatMessage()

Declaration
Swift
public func sendClanChatMessage(clanChat: SteamID, text: String) -> Bool

Steamworks ISteamFriends::SetInGameVoiceSpeaking()

Declaration
Swift
public func setInGameVoiceSpeaking(user: SteamID, speaking: Bool)

Steamworks ISteamFriends::SetListenForFriendsMessages()

Declaration
Swift
@discardableResult
public func setListenForFriendsMessages(interceptEnabled: Bool) -> Bool

Steamworks ISteamFriends::SetPersonaName(), callback

Declaration
Swift
public func setPersonaName(
    personaName: String,
    completion: @Sendable @escaping (sending SetPersonaNameResponse?) -> Void)

Steamworks ISteamFriends::SetPersonaName(), async

Declaration
Swift
public func setPersonaName(
    isolation: isolated (any Actor)? = #isolation, personaName: String
) async -> SetPersonaNameResponse?

Steamworks ISteamFriends::SetPlayedWith()

Declaration
Swift
public func setPlayedWith(userPlayedWith: SteamID)

Steamworks ISteamFriends::SetRichPresence()

Declaration
Swift
@discardableResult
public func setRichPresence(key: String, value: String?) -> Bool
Note

Provided by module SteamworksHelpers.

Steamworks ISteamFriends::GetFriendsGroupMembersList()

Declaration
Swift
public func getFriendsGroupMembersList(friendsGroupID: FriendsGroupID)
    -> [SteamID]