Struct libosu::Mods

pub struct Mods { /* fields omitted */ }

Mod listing with their respective bitwise representation.

This list is ripped directly from the osu! wiki.

Implementations

impl Mods

pub const None: Mods

No selected mods

pub const NoFail: Mods

No-Fail (NF) Makes the player incapabale of failing beatmaps, even if their life drops to zero.

pub const Easy: Mods

Easy (EZ) halves the all difficulty settings for a beatmap, and gives the player 2 extra lives in modes other than taiko.

pub const NoVideo: Mods

No Video (NV) disables the background video of a beatmap. It is no longer available for use, it was replaced with a setting.

pub const Hidden: Mods

Hidden (HD) removes approach circles and causes hit objects to fade after appearing.

pub const HardRock: Mods

Hard Rock (HR) increases CS by 30% and all other difficulty settings by 40%.

pub const SuddenDeath: Mods

Sudden Death (SD) will cause the player to fail after missing a hit object or slider tick.

pub const DoubleTime: Mods

Double Time (DT) increasing the overall speed to 150%.

pub const Relax: Mods

Relax (RL) removes the need to tap hitobjects in standard, color judgement in taiko and allows free movement at any speed in catch.

pub const HalfTime: Mods

Half Time (HT) decreases the overall speed to 75%.

pub const Nightcore: Mods

Nightcore (NC) has the same effect as doubletime, but increases the pitch and adds a drum tick in the background. Nightcore will only be set alongside doubletime.

pub const Flashlight: Mods

Flashlight (FL) limits the visible area of the beatmap.

pub const Autoplay: Mods

Autoplay plays the beatmap automatically.

pub const SpunOut: Mods

SpunOut (SO) spins spinners automatically in osu!standard.

pub const Relax2: Mods

Autopilot (AP, Relex2) will automatically move the players cursor (osu!standard only).

pub const Perfect: Mods

Perfect (PF) will fail the player if they miss or a score under 300 on a hit object, only set along with SuddenDeath.

pub const Key4: Mods

4Key (4K, xK) forces maps converted into osu!mania to use 4 keys.

pub const Key5: Mods

5Key (5K, xK) forces maps converted into osu!mania to use 5 keys.

pub const Key6: Mods

6Key (6K, xK) forces maps converted into osu!mania to use 6 keys.

pub const Key7: Mods

7Key (7K, xK) forces maps converted into osu!mania to use 7 keys.

pub const Key8: Mods

8Key (8K, xK) forces maps converted into osu!mania to use 8 keys.

pub const FadeIn: Mods

Fade In (FI) causes notes start invisible and fade in as they approach the judgement bar, only set along with Hidden (osu!mania only).

pub const Random: Mods

Random (RD) randomizes note placement (osu!mania only).

pub const LastMod: Mods

Cinema (CM, LastMod) only plays the video or storyboard, without any gameplay. Hitsounds will still be heard.

pub const TargetPractice: Mods

Target Practice (TP) removes all mapped hitobjects and replaces them with a consistent set of target (osu!standard Cutting Edge only).

pub const Key9: Mods

9Key (9K, xK) forces maps converted into osu!mania to use 9 keys.

pub const Key10: Mods

10Key (10K, xK) forces maps converted into osu!mania to use 10 keys, it has been removed from the game.

pub const Key1: Mods

1Key (1K, xK) forces maps converted into osu!mania to use 1 key.

pub const Key3: Mods

3Key (3K, xK) forces maps converted into osu!mania to use 3 keys.

pub const Key2: Mods

2Key (2K, xK) forces maps converted into osu!mania to use 2 keys.

pub const KeyMod: Mods

Bits of Key4, Key5, Key6, Key7, and Key8.

pub const FreeModAllowed: Mods

Mods allowed to be chosen when FreeMod is enabled in multiplayer.

pub const fn empty() -> Mods

Returns an empty set of flags

pub const fn all() -> Mods

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<Mods>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> Mods

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> Mods

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: Mods) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: Mods) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: Mods)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: Mods)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: Mods)

Toggles the specified flags in-place.

pub fn set(&mut self, other: Mods, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for Mods

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

Formats the value using the given formatter.

impl BitAnd<Mods> for Mods

type Output = Mods

The resulting type after applying the & operator.

pub fn bitand(self, other: Mods) -> Mods

Returns the intersection between the two sets of flags.

impl BitAndAssign<Mods> for Mods

pub fn bitand_assign(&mut self, other: Mods)

Disables all flags disabled in the set.

impl BitOr<Mods> for Mods

type Output = Mods

The resulting type after applying the | operator.

pub fn bitor(self, other: Mods) -> Mods

Returns the union of the two sets of flags.

impl BitOrAssign<Mods> for Mods

pub fn bitor_assign(&mut self, other: Mods)

Adds the set of flags.

impl BitXor<Mods> for Mods

type Output = Mods

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: Mods) -> Mods

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<Mods> for Mods

pub fn bitxor_assign(&mut self, other: Mods)

Toggles the set of flags.

impl Clone for Mods

pub fn clone(&self) -> Mods

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Mods

impl Debug for Mods

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

Formats the value using the given formatter.

impl Default for Mods

pub fn default() -> Mods

Returns the "default value" for a type.

impl Eq for Mods

impl Extend<Mods> for Mods

pub fn extend<T: IntoIterator<Item = Mods>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<Mods> for Mods

pub fn from_iter<T: IntoIterator<Item = Mods>>(iterator: T) -> Mods

Creates a value from an iterator.

impl Hash for Mods

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl LowerHex for Mods

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

Formats the value using the given formatter.

impl Not for Mods

type Output = Mods

The resulting type after applying the ! operator.

pub fn not(self) -> Mods

Returns the complement of this set of flags.

impl Octal for Mods

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

Formats the value using the given formatter.

impl Ord for Mods

pub fn cmp(&self, other: &Mods) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Mods> for Mods

pub fn eq(&self, other: &Mods) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &Mods) -> bool

This method tests for !=.

impl PartialOrd<Mods> for Mods

pub fn partial_cmp(&self, other: &Mods) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

pub fn lt(&self, other: &Mods) -> bool

This method tests less than (for self and other) and is used by the < operator.

pub fn le(&self, other: &Mods) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

pub fn gt(&self, other: &Mods) -> bool

This method tests greater than (for self and other) and is used by the > operator.

pub fn ge(&self, other: &Mods) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Mods

impl StructuralPartialEq for Mods

impl Sub<Mods> for Mods

type Output = Mods

The resulting type after applying the - operator.

pub fn sub(self, other: Mods) -> Mods

Returns the set difference of the two sets of flags.

impl SubAssign<Mods> for Mods

pub fn sub_assign(&mut self, other: Mods)

Disables all flags enabled in the set.

impl UpperHex for Mods

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

Formats the value using the given formatter.