Struct Unlockable

pub struct Unlockable<U, K, S, I> {
    pub id: U,
    pub inner: K,
    pub is_unlocked: bool,
    pub unlock_stat_conditions: Vec<StatCondition<S>>,
    pub unlock_item_conditions: Vec<(I, usize, UseMode)>,
    pub unlock_dependencies: Vec<U>,
}

An unlockable element. It can be unlocked to access the inner value if all conditions are met:

• StatConditions
• Item Conditions
• Dependant unlockables were previously unlocked.

Fields

id: U

The key of this unlockable.

inner: K

The thing we want to unlock access to.

is_unlocked: bool

Whether we unlocked it or not.

unlock_stat_conditions: Vec<StatCondition<S>>

The stat conditions required to unlock this element.

unlock_item_conditions: Vec<(I, usize, UseMode)>

The item conditions required to unlock this element.

unlock_dependencies: Vec<U>

A list of other unlockables upon which this one depends. If Unlockable B depends on A, then A must be unlocked before B can be unlocked.

Implementations

impl<U, K, S, I> Unlockable<U, K, S, I>

pub fn new(id: U, inner: K, is_unlocked: bool) -> Self

Constructs a new Unlockable.

impl<U, K, S, I> Unlockable<U, K, S, I>

pub fn try_get(&self) -> Option<&K>

Returns Some with the inner value if is_unlocked = true. Otherwise returns None

pub fn try_get_mut(&mut self) -> Option<&mut K>

Returns Some with the inner value if is_unlocked = true. Otherwise returns None

pub fn get(&self) -> &K

Returns the inner value without checking the lock.

pub fn get_mut(&mut self) -> &mut K

Returns the inner value without checking the lock.

pub fn set(&mut self, new: K)

Inserts a new value without changing the lock. Returns the previous inner value.

pub fn lock(&mut self)

Locks the inner value.

pub fn unlock(&mut self)

Unlocks the inner value.

pub fn is_unlocked(&self) -> bool

Verifies if the inner value is locked.

Trait Implementations

impl<U: Clone, K: Clone, S: Clone, I: Clone> Clone for Unlockable<U, K, S, I>

fn clone(&self) -> Unlockable<U, K, S, I>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<U: Debug, K: Debug, S: Debug, I: Debug> Debug for Unlockable<U, K, S, I>

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

Formats the value using the given formatter.

impl<'de, U, K, S, I> Deserialize<'de> for Unlockable<U, K, S, I>

where U: Deserialize<'de>, K: Deserialize<'de>, S: Deserialize<'de>, I: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<U, K, S, I> Serialize for Unlockable<U, K, S, I>

where U: Serialize, K: Serialize, S: Serialize, I: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.