Struct steamworks::User

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

Access to the steam user interface

Implementations

impl<Manager> User<Manager>

pub fn steam_id(&self) -> SteamId

Returns the steam id of the current user

pub fn level(&self) -> u32

Returns the level of the current user

pub fn logged_on(&self) -> bool

Returns whether the current user’s Steam client is connected to the Steam servers.

pub fn authentication_session_ticket_with_steam_id( &self, steam_id: SteamId ) -> (AuthTicket, Vec<u8>)

Retrieve an authentication session ticket that can be sent to an entity that wishes to verify you.

This ticket should not be reused.

When creating ticket for use by the web API you should wait for the AuthSessionTicketResponse event before trying to use the ticket.

When the multiplayer session terminates you must call cancel_authentication_ticket

pub fn authentication_session_ticket( &self, network_identity: NetworkingIdentity ) -> (AuthTicket, Vec<u8>)

pub fn cancel_authentication_ticket(&self, ticket: AuthTicket)

Cancels an authentication session ticket received from authentication_session_ticket.

This should be called when you are no longer playing with the specified entity.

pub fn begin_authentication_session( &self, user: SteamId, ticket: &[u8] ) -> Result<(), AuthSessionError>

Authenticate the ticket from the steam ID to make sure it is valid and not reused.

A ValidateAuthTicketResponse callback will be fired if the entity goes offline or cancels the ticket.

When the multiplayer session terminates you must call end_authentication_session

pub fn end_authentication_session(&self, user: SteamId)

Ends an authentication session that was started with begin_authentication_session.

This should be called when you are no longer playing with the specified entity.

pub fn authentication_session_ticket_for_webapi( &self, identity: &str ) -> AuthTicket

Retrieve an authentication ticket to be sent to the entity that wishes to authenticate you using the ISteamUserAuth/AuthenticateUserTicket Web API.

The calling application must wait for the TicketForWebApiResponse callback generated
by the API call to access the ticket.

It is best practice to use an identity string for each service that will consume tickets.

This API can not be used to create a ticket for use by the BeginAuthSession/ISteamGameServer::BeginAuthSession. Use the authentication_session_ticket API instead