Struct steamworks::Friends

pub struct Friends<Manager> { /* private fields */ }

Access to the steam friends interface

Implementations

impl<Manager> Friends<Manager>

pub fn name(&self) -> String

Returns the (display) name of the current user

pub fn get_friends(&self, flags: FriendFlags) -> Vec<Friend<Manager>>

pub fn get_coplay_friends(&self) -> Vec<Friend<Manager>>

Returns recently played with players list

pub fn get_friend(&self, friend: SteamId) -> Friend<Manager>

pub fn request_user_information(&self, user: SteamId, name_only: bool) -> bool

pub fn activate_game_overlay(&self, dialog: &str)

pub fn activate_game_overlay_to_web_page(&self, url: &str)

pub fn activate_game_overlay_to_store( &self, app_id: AppId, overlay_to_store_flag: OverlayToStoreFlag )

pub fn activate_game_overlay_to_user(&self, dialog: &str, user: SteamId)

pub fn activate_invite_dialog(&self, lobby: LobbyId)

Opens up an invite dialog for the given lobby

pub fn set_rich_presence(&self, key: &str, value: Option<&str>) -> bool

Set rich presence for the user. Unsets the rich presence if value is None or empty. See Steam API

pub fn clear_rich_presence(&self)

Clears all of the current user’s Rich Presence key/values.

pub fn get_user_restrictions(&self) -> UserRestriction

Checks if current user is chat restricted.

If they are restricted, then they can’t send or receive any text/voice chat messages, can’t see custom avatars. A chat restricted user can’t add friends or join any groups. Restricted users can still be online and send/receive game invites.