Struct bevy_steamworks::stats::AchievementHelper

pub struct AchievementHelper<'parent, M> { /* fields omitted */ }

Achievement API.

Methods require request_current_stats() to have been called and a successful UserStatsReceived callback processed.

Example

// Unlock the 'WIN_THE_GAME' achievement
client.user_stats().achievement("WIN_THE_GAME").set()?;

Implementations

impl<'_, M> AchievementHelper<'_, M>

pub fn get(&self) -> Result<bool, ()>

Gets the unlock status of the Achievement.

This call only modifies Steam’s in-memory state so it is quite cheap. To send the unlock status to the server and to trigger the Steam overlay notification you must call store_stats().

Fails if this achievement’s ‘API Name’ is unknown, or unsuccessful UserStatsReceived.

pub fn set(&self) -> Result<(), ()>

Unlocks an achievement.

This call only modifies Steam’s in-memory state so it is quite cheap. To send the unlock status to the server and to trigger the Steam overlay notification you must call store_stats().

Fails if this achievement’s ‘API Name’ is unknown, or unsuccessful UserStatsReceived.

pub fn clear(&self) -> Result<(), ()>

Resets the unlock status of an achievement.

This call only modifies Steam’s in-memory state so it is quite cheap. To send the unlock status to the server and to trigger the Steam overlay notification you must call store_stats().

Fails if this achievement’s ‘API Name’ is unknown, or unsuccessful UserStatsReceived.