Struct bevy_steamworks::stats::AchievementHelper[−][src]

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>[src]

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

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<(), ()>[src]

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<(), ()>[src]

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.

Auto Trait Implementations

impl<'parent, M> RefUnwindSafe for AchievementHelper<'parent, M> where
    M: RefUnwindSafe, 

impl<'parent, M> !Send for AchievementHelper<'parent, M>

impl<'parent, M> !Sync for AchievementHelper<'parent, M>

impl<'parent, M> Unpin for AchievementHelper<'parent, M>

impl<'parent, M> UnwindSafe for AchievementHelper<'parent, M> where
    M: RefUnwindSafe, 

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
    T: Any, 

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T> Instrument for T[src]

fn instrument(self, span: Span) -> Instrumented<Self>[src]

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>[src]

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>, 

pub fn vzip(self) -> V