Package dev.kosmx.playerAnim.core.data.opennbs.format

Class Header

java.lang.Object
dev.kosmx.playerAnim.core.data.opennbs.format.Header
public class Header extends Object
Sound format header. contains Name, click amount, length, everything from header field names and descriptions are form https://opennbs.org/nbs Deprecated fields are not used by OPEN NOTE BLOCK STUDIO

  • Field Details

    • NBS_version

      public byte NBS_version
      The version of the new NBS format.

    • Vanilla_instrument_count

      public byte Vanilla_instrument_count
      Amount of default instruments when the song was saved. This is needed to determine at what index custom instruments start.

    • Song_length

      @Deprecated public short Song_length
      Deprecated.
      The length of the song, measured in ticks. Divide this by the tempo to get the length of the song in seconds. Note Block Studio doesn't really care about this value, the song size is calculated in the second part. (Note: this was re-added in NBS version 3)

    • Layer_count

      public short Layer_count
      The last layer with at least one note block in it, or the last layer that has had its name, volume or stereo changed.

    • Song_name

      public String Song_name
      The name of the song.

    • Song_author

      public String Song_author
      The author of the song.

    • Song_original_author

      public String Song_original_author
      The original author of the song.

    • Song_description

      public String Song_description
      The description of the song.

    • Song_tempo

      public short Song_tempo
      The tempo of the song multiplied by 100 (for example, 1225 instead of 12.25). Measured in ticks per second.

    • Auto_saving

      @Deprecated public byte Auto_saving
      Deprecated.
      Whether auto-saving has been enabled (0 or 1). As of NBS version 4 this value is still saved to the file, but no longer used in the program.

    • Auto_saving_duration

      @Deprecated public byte Auto_saving_duration
      Deprecated.
      The amount of minutes between each auto-save (if it has been enabled) (1-60). As of NBS version 4 this value is still saved to the file, but no longer used in the program.

    • Time_signature

      public byte Time_signature
      The time signature of the song. If this is 3, then the signature is 3/4. Default is 4. This value ranges from 2-8.

    • Minutes_spent

      public int Minutes_spent
      Amount of minutes spent on the project.

    • Left_clicks

      public int Left_clicks
      Amount of times the user has left-clicked.

    • Right_clicks

      public int Right_clicks
      Amount of times the user has right-clicked.

    • Note_blocks_added

      public int Note_blocks_added
      Amount of times the user has added a note block.

    • Note_blocks_removed

      public int Note_blocks_removed
      The amount of times the user have removed a note block.

    • MIDI_Schematic_file_name

      public String MIDI_Schematic_file_name
      If the song has been imported from a .mid or .schematic file, that file name is stored here (only the name of the file, not the path).

    • Loop_on_off

      public byte Loop_on_off
      Whether looping is on or off. (0 = off, 1 = on)

    • Max_loop_count

      public byte Max_loop_count
      0 = infinite. Other values mean the amount of times the song loops.

    • Loop_start_tick

      public short Loop_start_tick
      Determines which part of the song (in ticks) it loops back to.

  • Constructor Details

    • Header

      public Header()

  • Method Details

    • Auto_saving

      public boolean Auto_saving()

    • Loop_on_off

      public boolean Loop_on_off()