SteamFriends

Swift
public struct SteamFriends: Sendable

Steamworks ISteamFriends

Access via friends.


Topics

func activateGameOverlay(dialog: String)

Steamworks ISteamFriends::ActivateGameOverlay()

Declaration
Swift
public func activateGameOverlay(dialog: String)

func activateGameOverlayInviteDialog(lobby: SteamID)

Steamworks ISteamFriends::ActivateGameOverlayInviteDialog()

Declaration
Swift
public func activateGameOverlayInviteDialog(lobby: SteamID)

func activateGameOverlayInviteDialogConnectString(connectString: String)

Steamworks ISteamFriends::ActivateGameOverlayInviteDialogConnectString()

Declaration
Swift
public func activateGameOverlayInviteDialogConnectString(connectString: String)

func activateGameOverlayRemotePlayTogetherInviteDialog(lobby: SteamID)

Steamworks ISteamFriends::ActivateGameOverlayRemotePlayTogetherInviteDialog()

Declaration
Swift
public func activateGameOverlayRemotePlayTogetherInviteDialog(lobby: SteamID)

func activateGameOverlayToStore(appID: AppID, flag: OverlayToStoreFlag)

Steamworks ISteamFriends::ActivateGameOverlayToStore()

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

func activateGameOverlayToUser(dialog: String, steamID: SteamID)

Steamworks ISteamFriends::ActivateGameOverlayToUser()

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

func activateGameOverlayToWebPage(url: String, mode: ActivateGameOverlayToWebPageMode)

Steamworks ISteamFriends::ActivateGameOverlayToWebPage()

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

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

Steamworks ISteamFriends::BHasEquippedProfileItem()

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

func clearRichPresence()

Steamworks ISteamFriends::ClearRichPresence()

Declaration
Swift
public func clearRichPresence()

func closeClanChatWindowInSteam(clanChat: SteamID) -> Bool

Steamworks ISteamFriends::CloseClanChatWindowInSteam()

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

func downloadClanActivityCounts(clans: [SteamID], completion: (DownloadClanActivityCountsResult?) -> Void)

Steamworks ISteamFriends::DownloadClanActivityCounts(), callback

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

func downloadClanActivityCounts(clans: [SteamID]) async -> DownloadClanActivityCountsResult?

Steamworks ISteamFriends::DownloadClanActivityCounts(), async

Declaration
Swift
public func downloadClanActivityCounts(clans: [SteamID]) async
    -> DownloadClanActivityCountsResult?

func enumerateFollowingList(startIndex: Int, completion: (FriendsEnumerateFollowingList?) -> Void)

Steamworks ISteamFriends::EnumerateFollowingList(), callback

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

func enumerateFollowingList(startIndex: Int) async -> FriendsEnumerateFollowingList?

Steamworks ISteamFriends::EnumerateFollowingList(), async

Declaration
Swift
public func enumerateFollowingList(startIndex: Int) async
    -> FriendsEnumerateFollowingList?

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

Steamworks ISteamFriends::GetChatMemberByIndex()

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

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

Steamworks ISteamFriends::GetClanActivityCounts()

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

func getClanByIndex(clanIndex: Int) -> SteamID

Steamworks ISteamFriends::GetClanByIndex()

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

func getClanChatMemberCount(clan: SteamID) -> Int

Steamworks ISteamFriends::GetClanChatMemberCount()

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

func getClanChatMessage(clanChat: SteamID, messageIndex: Int, textMaxSize: Int) -> (rc: Int, text: String, chatEntryType: ChatEntryType, chatter: SteamID)

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)

func getClanCount() -> Int

Steamworks ISteamFriends::GetClanCount()

Declaration
Swift
public func getClanCount() -> Int

func getClanName(clan: SteamID) -> String

Steamworks ISteamFriends::GetClanName()

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

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

Steamworks ISteamFriends::GetClanOfficerByIndex()

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

func getClanOfficerCount(clan: SteamID) -> Int

Steamworks ISteamFriends::GetClanOfficerCount()

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

func getClanOwner(clan: SteamID) -> SteamID

Steamworks ISteamFriends::GetClanOwner()

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

func getClanTag(clan: SteamID) -> String

Steamworks ISteamFriends::GetClanTag()

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

func getCoplayFriend(coplayFriendIndex: Int) -> SteamID

Steamworks ISteamFriends::GetCoplayFriend()

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

func getCoplayFriendCount() -> Int

Steamworks ISteamFriends::GetCoplayFriendCount()

Declaration
Swift
public func getCoplayFriendCount() -> Int

func getFollowerCount(steamID: SteamID, completion: (FriendsGetFollowerCount?) -> Void)

Steamworks ISteamFriends::GetFollowerCount(), callback

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

func getFollowerCount(steamID: SteamID) async -> FriendsGetFollowerCount?

Steamworks ISteamFriends::GetFollowerCount(), async

Declaration
Swift
public func getFollowerCount(steamID: SteamID) async -> FriendsGetFollowerCount?

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

Steamworks ISteamFriends::GetFriendByIndex()

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

func getFriendCoplayGame(friend: SteamID) -> AppID

Steamworks ISteamFriends::GetFriendCoplayGame()

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

func getFriendCoplayTime(friend: SteamID) -> Int

Steamworks ISteamFriends::GetFriendCoplayTime()

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

func getFriendCount(friendFlags: FriendFlags) -> Int

Steamworks ISteamFriends::GetFriendCount()

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

func getFriendCountFromSource(source: SteamID) -> Int

Steamworks ISteamFriends::GetFriendCountFromSource()

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

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

Steamworks ISteamFriends::GetFriendFromSourceByIndex()

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

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

Steamworks ISteamFriends::GetFriendGamePlayed()

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

func getFriendMessage(friend: SteamID, messageIDIndex: Int, dataSize: Int) -> (rc: Int, data: String, chatEntryType: ChatEntryType)

Steamworks ISteamFriends::GetFriendMessage()

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

func getFriendPersonaName(friend: SteamID) -> String

Steamworks ISteamFriends::GetFriendPersonaName()

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

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

Steamworks ISteamFriends::GetFriendPersonaNameHistory()

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

func getFriendPersonaState(friend: SteamID) -> PersonaState

Steamworks ISteamFriends::GetFriendPersonaState()

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

func getFriendRelationship(friend: SteamID) -> FriendRelationship

Steamworks ISteamFriends::GetFriendRelationship()

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

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

Steamworks ISteamFriends::GetFriendRichPresence()

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

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

Steamworks ISteamFriends::GetFriendRichPresenceKeyByIndex()

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

func getFriendRichPresenceKeyCount(friend: SteamID) -> Int

Steamworks ISteamFriends::GetFriendRichPresenceKeyCount()

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

func getFriendSteamLevel(friend: SteamID) -> Int

Steamworks ISteamFriends::GetFriendSteamLevel()

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

func getFriendsGroupCount() -> Int

Steamworks ISteamFriends::GetFriendsGroupCount()

Declaration
Swift
public func getFriendsGroupCount() -> Int

func getFriendsGroupIDByIndex(fgIndex: Int) -> FriendsGroupID

Steamworks ISteamFriends::GetFriendsGroupIDByIndex()

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

func getFriendsGroupMembersCount(friendsGroupID: FriendsGroupID) -> Int

Steamworks ISteamFriends::GetFriendsGroupMembersCount()

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

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

Steamworks ISteamFriends::GetFriendsGroupMembersList()

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

func getFriendsGroupName(friendsGroupID: FriendsGroupID) -> String?

Steamworks ISteamFriends::GetFriendsGroupName()

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

func getLargeFriendAvatar(friend: SteamID) -> Int

Steamworks ISteamFriends::GetLargeFriendAvatar()

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

func getMediumFriendAvatar(friend: SteamID) -> Int

Steamworks ISteamFriends::GetMediumFriendAvatar()

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

func getNumChatsWithUnreadPriorityMessages() -> Int

Steamworks ISteamFriends::GetNumChatsWithUnreadPriorityMessages()

Declaration
Swift
public func getNumChatsWithUnreadPriorityMessages() -> Int

func getPersonaName() -> String

Steamworks ISteamFriends::GetPersonaName()

Declaration
Swift
public func getPersonaName() -> String

func getPersonaState() -> PersonaState

Steamworks ISteamFriends::GetPersonaState()

Declaration
Swift
public func getPersonaState() -> PersonaState

func getPlayerNickname(player: SteamID) -> String?

Steamworks ISteamFriends::GetPlayerNickname()

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

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

Steamworks ISteamFriends::GetProfileItemPropertyString()

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

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

Steamworks ISteamFriends::GetProfileItemPropertyUint()

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

func getSmallFriendAvatar(friend: SteamID) -> Int

Steamworks ISteamFriends::GetSmallFriendAvatar()

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

func getUserRestrictions() -> UserRestriction

Steamworks ISteamFriends::GetUserRestrictions()

Declaration
Swift
public func getUserRestrictions() -> UserRestriction

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

Steamworks ISteamFriends::HasFriend()

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

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

Steamworks ISteamFriends::InviteUserToGame()

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

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

Steamworks ISteamFriends::IsClanChatAdmin()

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

func isClanChatWindowOpenInSteam(clanChat: SteamID) -> Bool

Steamworks ISteamFriends::IsClanChatWindowOpenInSteam()

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

func isClanOfficialGameGroup(clan: SteamID) -> Bool

Steamworks ISteamFriends::IsClanOfficialGameGroup()

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

func isClanPublic(clan: SteamID) -> Bool

Steamworks ISteamFriends::IsClanPublic()

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

func isFollowing(steamID: SteamID, completion: (FriendsIsFollowing?) -> Void)

Steamworks ISteamFriends::IsFollowing(), callback

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

func isFollowing(steamID: SteamID) async -> FriendsIsFollowing?

Steamworks ISteamFriends::IsFollowing(), async

Declaration
Swift
public func isFollowing(steamID: SteamID) async -> FriendsIsFollowing?

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

Steamworks ISteamFriends::IsUserInSource()

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

func joinClanChatRoom(clan: SteamID, completion: (JoinClanChatRoomCompletionResult?) -> Void)

Steamworks ISteamFriends::JoinClanChatRoom(), callback

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

func joinClanChatRoom(clan: SteamID) async -> JoinClanChatRoomCompletionResult?

Steamworks ISteamFriends::JoinClanChatRoom(), async

Declaration
Swift
public func joinClanChatRoom(clan: SteamID) async
    -> JoinClanChatRoomCompletionResult?

func leaveClanChatRoom(clan: SteamID) -> Bool

Steamworks ISteamFriends::LeaveClanChatRoom()

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

func openClanChatWindowInSteam(clanChat: SteamID) -> Bool

Steamworks ISteamFriends::OpenClanChatWindowInSteam()

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

func registerProtocolInOverlayBrowser(protocol: String) -> Bool

Steamworks ISteamFriends::RegisterProtocolInOverlayBrowser()

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

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

Steamworks ISteamFriends::ReplyToFriendMessage()

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

func requestClanOfficerList(clan: SteamID, completion: (ClanOfficerListResponse?) -> Void)

Steamworks ISteamFriends::RequestClanOfficerList(), callback

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

func requestClanOfficerList(clan: SteamID) async -> ClanOfficerListResponse?

Steamworks ISteamFriends::RequestClanOfficerList(), async

Declaration
Swift
public func requestClanOfficerList(clan: SteamID) async
    -> ClanOfficerListResponse?

func requestEquippedProfileItems(steamID: SteamID, completion: (EquippedProfileItems?) -> Void)

Steamworks ISteamFriends::RequestEquippedProfileItems(), callback

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

func requestEquippedProfileItems(steamID: SteamID) async -> EquippedProfileItems?

Steamworks ISteamFriends::RequestEquippedProfileItems(), async

Declaration
Swift
public func requestEquippedProfileItems(steamID: SteamID) async
    -> EquippedProfileItems?

func requestFriendRichPresence(friend: SteamID)

Steamworks ISteamFriends::RequestFriendRichPresence()

Declaration
Swift
public func requestFriendRichPresence(friend: SteamID)

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

Steamworks ISteamFriends::RequestUserInformation()

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

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

Steamworks ISteamFriends::SendClanChatMessage()

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

func setInGameVoiceSpeaking(user: SteamID, speaking: Bool)

Steamworks ISteamFriends::SetInGameVoiceSpeaking()

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

func setListenForFriendsMessages(interceptEnabled: Bool) -> Bool

Steamworks ISteamFriends::SetListenForFriendsMessages()

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

func setPersonaName(personaName: String, completion: (SetPersonaNameResponse?) -> Void)

Steamworks ISteamFriends::SetPersonaName(), callback

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

func setPersonaName(personaName: String) async -> SetPersonaNameResponse?

Steamworks ISteamFriends::SetPersonaName(), async

Declaration
Swift
public func setPersonaName(personaName: String) async -> SetPersonaNameResponse?

func setPlayedWith(userPlayedWith: SteamID)

Steamworks ISteamFriends::SetPlayedWith()

Declaration
Swift
public func setPlayedWith(userPlayedWith: SteamID)

func setRichPresence(key: String, value: String?) -> Bool

Steamworks ISteamFriends::SetRichPresence()

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

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

Note

Provided by module SteamworksHelpers.

Steamworks ISteamFriends::GetFriendsGroupMembersList()

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