net.raphimc.noteblocklib.format.nbs.model

Class NbsLayer

java.lang.Object

net.raphimc.noteblocklib.format.nbs.model.NbsLayer

public class NbsLayer
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
NbsLayer()

Method Summary

Modifier and Type	Method and Description
NbsLayer	copy()
java.lang.String	getName()
java.lang.String	getNameOr(java.lang.String fallback)
java.util.Map<java.lang.Integer,NbsNote>	getNotes()
short	getPanning()
byte	getVolume()
boolean	isLocked()
NbsLayer	setLocked(boolean locked)
NbsLayer	setName(java.lang.String name)
NbsLayer	setPanning(short panning)
NbsLayer	setVolume(byte volume)

Methods inherited from class java.lang.Object

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

Constructor Detail

NbsLayer

public NbsLayer()

Method Detail

getNotes

public java.util.Map<java.lang.Integer,NbsNote> getNotes()

Returns:

A map of all notes in this layer, with the tick as the key.

Since:

v0

getName

public java.lang.String getName()

Returns:

The name of the layer.

Since:

v0

getNameOr

public java.lang.String getNameOr(java.lang.String fallback)

Parameters:

fallback - The fallback value if the layer name is not set.

Returns:

The name of the layer.

Since:

v0

setName

public NbsLayer setName(java.lang.String name)

Parameters:

name - The name of the layer.

Returns:

this

Since:

v0

getVolume

public byte getVolume()

Returns:

The volume of the layer (percentage). Ranges from 0-100.

Since:

v0

setVolume

public NbsLayer setVolume(byte volume)

Parameters:

volume - The volume of the layer (percentage). Ranges from 0-100.

Returns:

this

Since:

v0

getPanning

public short getPanning()

Returns:

How much this layer is panned to the left/right. 0 is 2 blocks right, 100 is center, 200 is 2 blocks left.

Since:

v2

setPanning

public NbsLayer setPanning(short panning)

Parameters:

panning - How much this layer should be panned to the left/right. 0 is 2 blocks right, 100 is center, 200 is 2 blocks left.

Returns:

this

Since:

v2

isLocked

public boolean isLocked()

Returns:

Whether this layer has been marked as locked.

Since:

v4

setLocked

public NbsLayer setLocked(boolean locked)

Parameters:

locked - Whether this layer should be marked as locked.

Returns:

this

Since:

v4

copy

public NbsLayer copy()