Struct steamworks::Friend

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

Implementations

impl<Manager> Friend<Manager>

pub fn id(&self) -> SteamId

pub fn name(&self) -> String

pub fn nick_name(&self) -> Option<String>

Gets the nickname that the current user has set for the specified user.

pub fn state(&self) -> FriendState

pub fn game_played(&self) -> Option<FriendGame>

Returns information about the game the player is current playing if any

pub fn coplay_game_played(&self) -> AppId

Gets the app ID of the game that user played with someone on their recently-played-with list.

pub fn coplay_time(&self) -> i32

Gets the timestamp of when the user played with someone on their recently-played-with list.

pub fn small_avatar(&self) -> Option<Vec<u8>>

Returns a small (32x32) avatar for the user in RGBA format

pub fn medium_avatar(&self) -> Option<Vec<u8>>

Returns a medium (64x64) avatar for the user in RGBA format

pub fn large_avatar(&self) -> Option<Vec<u8>>

Returns a large (184x184) avatar for the user in RGBA format

pub fn has_friend(&self, flags: FriendFlags) -> bool

Checks if the user meets the specified criteria. (Friends, blocked, users on the same server, etc)

pub fn invite_user_to_game(&self, connect_string: &str)

Invites a friend or clan member to the current game using a special invite string. If the target user accepts the invite then the ConnectString gets added to the command-line when launching the game. If the game is already running for that user, then they will receive a GameRichPresenceJoinRequested_t callback with the connect string.

pub fn set_played_with(&self)

Mark a target user as ‘played with’. NOTE: The current user must be in game with the other player for the association to work.

Trait Implementations

impl<Manager> Debug for Friend<Manager>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.