Struct libosu::HitObject

pub struct HitObject {
    pub pos: Point<i32>,
    pub start_time: TimeLocation,
    pub kind: HitObjectKind,
    pub new_combo: bool,
    pub timing_point: Option<TimingPoint>,
    pub skip_color: i32,
    pub additions: Additions,
    pub sample_info: SampleInfo,
}

Represents a single hit object.

Fields

pos: Point<i32>

The position on the map at which this hit object is located (head for sliders).

start_time: TimeLocation

When this hit object occurs during the map.

kind: HitObjectKind

The kind of HitObject this represents (circle, slider, spinner).

new_combo: bool

Whether or not this object begins a new combo.

timing_point: Option<TimingPoint>

Reference to the timing point under which this HitObject belongs.

skip_color: i32

The number of combo colors to skip

additions: Additions

The hitsound additions attached to this hit object.

sample_info: SampleInfo

The sample used to play the hitsound assigned to this hit object.

Implementations

impl HitObject

pub fn end_pos(&self) -> Option<Point<f64>>

Computes the point at which the hitobject ends

impl HitObject

pub fn from_osz(input: &str) -> Result<HitObject, Error>

Creates a HitObject from the *.osz format

pub fn as_osz(&self) -> Result<String, Error>

Serializes this HitObject into the *.osz format.

Trait Implementations

impl Clone for HitObject

pub fn clone(&self) -> HitObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for HitObject

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

Formats the value using the given formatter.

impl Eq for HitObject

impl Ord for HitObject

pub fn cmp(&self, other: &Self) -> 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<HitObject> for HitObject

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

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

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<HitObject> for HitObject

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

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

#[must_use]pub fn lt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn le(&self, other: &Rhs) -> bool

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

#[must_use]pub fn gt(&self, other: &Rhs) -> bool

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

#[must_use]pub fn ge(&self, other: &Rhs) -> bool

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