net.raphimc.noteblocklib.parser.nbs.header

Class NBSv0Header

java.lang.Object

net.raphimc.noteblocklib.parser.Header

net.raphimc.noteblocklib.parser.nbs.header.NBSHeader

net.raphimc.noteblocklib.parser.nbs.header.NBSv0Header

Direct Known Subclasses:

NBSv4Header

public class NBSv0Header
extends NBSHeader

Constructor Summary

Constructors

Constructor and Description
NBSv0Header(com.google.common.io.LittleEndianDataInputStream dis)
NBSv0Header(short length, byte nbsVersion, byte vanillaInstrumentCount, short layerCount, java.lang.String title, java.lang.String author, java.lang.String originalAuthor, java.lang.String description, short speed, boolean autoSave, byte autoSaveInterval, byte timeSignature, int minutesSpent, int leftClicks, int rightClicks, int noteBlocksAdded, int noteBlocksRemoved, java.lang.String sourceFileName)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getAuthor()
byte	getAutoSaveInterval()
java.lang.String	getDescription()
short	getLayerCount()
int	getLeftClicks()
int	getMinutesSpent()
int	getNoteBlocksAdded()
int	getNoteBlocksRemoved()
java.lang.String	getOriginalAuthor()
int	getRightClicks()
java.lang.String	getSourceFileName()
short	getSpeed()
byte	getTimeSignature()
java.lang.String	getTitle()
boolean	isAutoSave()
void	setAuthor(java.lang.String author)
void	setAutoSave(boolean autoSave)
void	setAutoSaveInterval(byte autoSaveInterval)
void	setDescription(java.lang.String description)
void	setLayerCount(short layerCount)
void	setLeftClicks(int leftClicks)
void	setMinutesSpent(int minutesSpent)
void	setNoteBlocksAdded(int noteBlocksAdded)
void	setNoteBlocksRemoved(int noteBlocksRemoved)
void	setOriginalAuthor(java.lang.String originalAuthor)
void	setRightClicks(int rightClicks)
void	setSourceFileName(java.lang.String sourceFileName)
void	setSpeed(short speed)
void	setTimeSignature(byte timeSignature)
void	setTitle(java.lang.String title)

Methods inherited from class net.raphimc.noteblocklib.parser.nbs.header.NBSHeader

getLength, getNbsVersion, getVanillaInstrumentCount, setLength, setNbsVersion, setVanillaInstrumentCount

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NBSv0Header

public NBSv0Header(com.google.common.io.LittleEndianDataInputStream dis)
            throws java.io.IOException

Throws:

java.io.IOException

NBSv0Header

public NBSv0Header(short length,
                   byte nbsVersion,
                   byte vanillaInstrumentCount,
                   short layerCount,
                   java.lang.String title,
                   java.lang.String author,
                   java.lang.String originalAuthor,
                   java.lang.String description,
                   short speed,
                   boolean autoSave,
                   byte autoSaveInterval,
                   byte timeSignature,
                   int minutesSpent,
                   int leftClicks,
                   int rightClicks,
                   int noteBlocksAdded,
                   int noteBlocksRemoved,
                   java.lang.String sourceFileName)

Method Detail

setLayerCount

public void setLayerCount(short layerCount)

getLayerCount

public short getLayerCount()

Returns:

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

setTitle

public void setTitle(java.lang.String title)

getTitle

public java.lang.String getTitle()

Returns:

The name of the song.

setAuthor

public void setAuthor(java.lang.String author)

getAuthor

public java.lang.String getAuthor()

Returns:

The author of the song.

setOriginalAuthor

public void setOriginalAuthor(java.lang.String originalAuthor)

getOriginalAuthor

public java.lang.String getOriginalAuthor()

Returns:

The original author of the song.

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

Returns:

The description of the song.

setSpeed

public void setSpeed(short speed)

getSpeed

public short getSpeed()

Returns:

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

setAutoSave

public void setAutoSave(boolean autoSave)

isAutoSave

public boolean isAutoSave()

Returns:

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.

setAutoSaveInterval

public void setAutoSaveInterval(byte autoSaveInterval)

getAutoSaveInterval

public byte getAutoSaveInterval()

Returns:

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.

setTimeSignature

public void setTimeSignature(byte timeSignature)

getTimeSignature

public byte getTimeSignature()

Returns:

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.

setMinutesSpent

public void setMinutesSpent(int minutesSpent)

getMinutesSpent

public int getMinutesSpent()

Returns:

Amount of minutes spent on the project.

setLeftClicks

public void setLeftClicks(int leftClicks)

getLeftClicks

public int getLeftClicks()

Returns:

Amount of times the user has left-clicked.

setRightClicks

public void setRightClicks(int rightClicks)

getRightClicks

public int getRightClicks()

Returns:

Amount of times the user has right-clicked.

setNoteBlocksAdded

public void setNoteBlocksAdded(int noteBlocksAdded)

getNoteBlocksAdded

public int getNoteBlocksAdded()

Returns:

Amount of times the user has added a note block.

setNoteBlocksRemoved

public void setNoteBlocksRemoved(int noteBlocksRemoved)

getNoteBlocksRemoved

public int getNoteBlocksRemoved()

Returns:

Amount of times the user has removed a note block.

setSourceFileName

public void setSourceFileName(java.lang.String sourceFileName)

getSourceFileName

public java.lang.String getSourceFileName()

Returns:

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).