Struct osu_file_parser::osu_file::hitobjects::HitObject

#[non_exhaustive]
pub struct HitObject {
    pub position: Position,
    pub time: Decimal,
    pub obj_params: HitObjectParams,
    pub new_combo: bool,
    pub combo_skip_count: ComboSkipCount,
    pub hitsound: HitSound,
    pub hitsample: Option<HitSample>,
}

A struct that represents a hitobject.

All hitobjects will have the properties: x, y, time, type, hitsound, hitsample.

The type property is a u8 integer with each bit flags containing some information, which are split into the functions and enums: hitobject_type, new_combo, combo_skip_count

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

position: Position

The position of the hitobject.

time: Decimal

The time when the object is to be hit, in milliseconds from the beginning of the beatmap’s audio.

obj_params: HitObjectParams

The hitobject parameters. Each hitobject contains different parameters. Also is used to know which hitobject type this is.

new_combo: bool

If the hitobject is a new combo.

combo_skip_count: ComboSkipCount

A 3-bit integer specifying how many combo colours to skip, if this object starts a new combo.

hitsound: HitSound

The hitsound property of the hitobject.

hitsample: Option<HitSample>

The hitsample property of the hitobject.

Implementations

impl HitObject

pub fn hitcircle_default() -> Self

pub fn spinner_default() -> Self

pub fn osu_mania_hold_default() -> Self

Trait Implementations

impl Clone for HitObject

fn clone(&self) -> HitObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HitObject

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

Formats the value using the given formatter.

impl Hash for HitObject

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl PartialEq<HitObject> for HitObject

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl VersionedFromStr for HitObject

type Err = ParseHitObjectError

fn from_str(s: &str, version: Version) -> Result<Option<Self>, Self::Err>

Parses a string into an object.

impl VersionedToString for HitObject

fn to_string(&self, version: Version) -> Option<String>

Returns a string representation of the object.

impl Eq for HitObject

impl StructuralEq for HitObject

impl StructuralPartialEq for HitObject