Class: OsuRuby::Beatmap::HitObjects::Base Abstract

Inherits:
Object
  • Object
show all
Includes:
Interface::AbstractClass, Interface::ExtendableMethod
Defined in:
(osu-ruby2 0.0.2) osu-ruby2/beatmap/data.rb

Overview

This class is abstract.

A base class for hitobject-related queries

Note that this implement a very core of the object itself. If you want to do a note specific, please see the implementation of subclasses

Direct Known Subclasses

BaseCircle, BaseSlider, BaseSpinner, Hold

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Interface::MultiplexerInterface

extended

Constructor Details

#initialize(beatmap, pos_x, pos_y, start_time, note_type, hitsounds, *extras) ⇒ Base

Returns a new instance of Base.

Instance Attribute Details

#hitsound ⇒ Object (readonly)

Returns the value of attribute hitsound.

#start_time ⇒ Object (readonly)

Returns the value of attribute start_time.

#type ⇒ Object (readonly)

Returns the value of attribute type.

#x ⇒ Object (readonly)

Returns the value of attribute x.

#y ⇒ Object (readonly)

Returns the value of attribute y.

Class Method Details

.parse(beatmap, str) ⇒ HitObjects::Base

parses the given string into a HitObject Base.

Parameters:

  • beatmap (Beatmap::Data) —

    a beatmap to stick on with.

  • str (String) —

    hitobject string to parse on

Returns:

Instance Method Details

#as_osu ⇒ Array

Note:

It's suggested to use this when trying to convert hitobjects or whatever you think it is. into a comma-split entry.

Returns a modifiable pre-HitObject compliant format data.

Returns:

  • (Array) —

    a modifiable pre-HitObject compliant format data

See Also:

#end_time ⇒ Integer

Returns hitobject endpoint.

Returns:

  • (Integer) —

    hitobject endpoint

#extra_data ⇒ Object?

Note:

Not really useful? Hope this is just raw data of extra parameters. but will see the later implementation after all of them are done.

Returns extra data.

Returns:

  • (Object, nil) —

    extra data.

#have_base? ⇒ Boolean

Returns have hitnormal.

Returns:

  • (Boolean) —

    have hitnormal

#have_clap? ⇒ Boolean

Returns have hitclap.

Returns:

  • (Boolean) —

    have hitclap

#have_finish? ⇒ Boolean

Returns have hitfinish.

Returns:

  • (Boolean) —

    have hitfinish

#have_hitsound? ⇒ Boolean

Returns have hitsound.

Returns:

  • (Boolean) —

    have hitsound

#have_whistle? ⇒ Boolean

Returns have hitwhistle.

Returns:

  • (Boolean) —

    have hitwhistle

#is_combo_hax ⇒ Boolean

Returns combo hax offset check.

Returns:

  • (Boolean) —

    combo hax offset check

#is_new_combo? ⇒ Boolean

Returns new combo marker.

Returns:

  • (Boolean) —

    new combo marker

#length ⇒ Integer

Returns hitobject duration.

Returns:

  • (Integer) —

    hitobject duration

#no_hitsound? ⇒ Boolean

Returns no hitsound.

Returns:

  • (Boolean) —

    no hitsound

#note_type ⇒ Integer

Returns hitobject raw type.

Returns:

  • (Integer) —

    hitobject raw type

#process_extras(*extras)

This method is abstract.

This function is meant to control any non-base related parsing

This method returns an undefined value.

Including the badly formatted extras from v10

#timing_data ⇒ TimingPoints::Compound

Returns current state of timing point on given object time.

Returns:

#to_osu ⇒ String

Returns a HitObject format compliant.

Returns:

  • (String) —

    a HitObject format compliant

See Also: