diff --git a/package.json b/package.json index 002795e..df88284 100644 --- a/package.json +++ b/package.json @@ -27,7 +27,7 @@ "build": "bun run build:bundle && bun run build:docs", "build:bundle": "bun build.ts", "build:docs": "typedoc", - "publish": "bun run test && bun run build && npm publish" + "build:publish": "bun run test && bun run build && npm publish" }, "engines": { "node": ">=18" diff --git a/public/docs/dev/classes/BufferReader.html b/public/docs/dev/classes/BufferReader.html index 0f55e1b..da1c84b 100644 --- a/public/docs/dev/classes/BufferReader.html +++ b/public/docs/dev/classes/BufferReader.html @@ -157,7 +157,7 @@ --md-sys-color-surface-container-highest: #e7e1e5 }

Class BufferReaderInternal

Represents an ArrayBuffer reader.

-

Hierarchy (view full)

Properties

buffer +

Hierarchy (view full)

Properties

buffer nextByte viewer

Methods

readByte @@ -168,19 +168,19 @@ resize

Constructors

constructor

Properties

Readonlybuffer

buffer: ArrayBufferLike

Buffer that is being read.

-

nextByte

nextByte: number = 0

Next byte to read.

-

Protectedviewer

viewer: DataView

Data view for the buffer.

-

Methods

readByte

readInt

readShort

readString

readUnsignedByte

  • readUnsignedByte(): number

  • Read the next unsigned byte.

    -

    Returns number

Protectedresize

nextByte

nextByte: number = 0

Next byte to read.

+

Protectedviewer

viewer: DataView

Data view for the buffer.

+

Methods

readByte

readInt

readShort

readString

readUnsignedByte

  • readUnsignedByte(): number

  • Read the next unsigned byte.

    +

    Returns number

Protectedresize

  • resize(by): number

  • Resize the ArrayBuffer and increment the next byte.

    Parameters

    • by: number

      The amount of bytes to increment by

    Returns number

    The byte that now has by bytes to write to.

    -

Constructors

constructor

Constructors

constructor

Settings

Member Visibility

On This Page

Properties
Methods
Constructors

Class BufferWrapperInternal

A buffer object wrapper.

-

Hierarchy (view full)

Properties

buffer +

Hierarchy (view full)

Properties

buffer nextByte viewer

Methods

resize

Constructors

constructor

Properties

Readonlybuffer

buffer: ArrayBufferLike

Buffer that is being read.

-

nextByte

nextByte: number = 0

Next byte to read.

-

Protectedviewer

viewer: DataView

Data view for the buffer.

-

Methods

Protectedresize

  • resize(by): number

  • Resize the ArrayBuffer and increment the next byte.

    +

nextByte

nextByte: number = 0

Next byte to read.

+

Protectedviewer

viewer: DataView

Data view for the buffer.

+

Methods

Protectedresize

  • resize(by): number

  • Resize the ArrayBuffer and increment the next byte.

    Parameters

    • by: number

      The amount of bytes to increment by

    Returns number

    The byte that now has by bytes to write to.

    -

Constructors

constructor

Constructors

constructor

Settings

Member Visibility

On This Page

Properties
Methods
Constructors

Class BufferWriterInternal

Represents an ArrayBuffer writer.

-

Hierarchy (view full)

Properties

buffer +

Hierarchy (view full)

Properties

buffer nextByte viewer

Methods

writeByte @@ -168,17 +168,17 @@ resize

Constructors

constructor

Properties

Readonlybuffer

buffer: ArrayBufferLike

Buffer that is being read.

-

nextByte

nextByte: number = 0

Next byte to read.

-

Protectedviewer

viewer: DataView

Data view for the buffer.

-

Methods

writeByte

  • writeByte(value?): void

  • Write a byte.

    -

    Parameters

    • value: number = 0

    Returns void

writeInt

  • writeInt(value?): void

  • Write an integer.

    -

    Parameters

    • value: number = 0

    Returns void

writeShort

  • writeShort(value?): void

  • Write a short.

    -

    Parameters

    • value: number = 0

    Returns void

writeString

  • writeString(value?): void

  • Write a string.

    -

    Parameters

    • value: string = ""

    Returns void

writeUnsignedByte

  • writeUnsignedByte(value?): void

  • Write an unsigned byte.

    -

    Parameters

    • value: number = 0

    Returns void

Protectedresize

nextByte

nextByte: number = 0

Next byte to read.

+

Protectedviewer

viewer: DataView

Data view for the buffer.

+

Methods

writeByte

  • writeByte(value?): void

  • Write a byte.

    +

    Parameters

    • value: number = 0

    Returns void

writeInt

  • writeInt(value?): void

  • Write an integer.

    +

    Parameters

    • value: number = 0

    Returns void

writeShort

  • writeShort(value?): void

  • Write a short.

    +

    Parameters

    • value: number = 0

    Returns void

writeString

  • writeString(value?): void

  • Write a string.

    +

    Parameters

    • value: string = ""

    Returns void

writeUnsignedByte

  • writeUnsignedByte(value?): void

  • Write an unsigned byte.

    +

    Parameters

    • value: number = 0

    Returns void

Protectedresize

  • resize(by): number

  • Resize the ArrayBuffer and increment the next byte.

    Parameters

    • by: number

      The amount of bytes to increment by

    Returns number

    The byte that now has by bytes to write to.

    -

Constructors

constructor

Settings

Member Visibility

On This Page

Properties
Methods
Constructors

Class SongInstruments

Represents the Instruments of a Song with helper methods.

-

Properties

all +

Properties

all firstCustomIndex

Methods

[iterator] add @@ -169,27 +169,27 @@

Properties

Readonlyall

all: ExistingInstruments = ...

ID-instrument pair of the song's instruments.

Remarks

Currently, this always includes the built-in instruments from Note Block Studio v5.

See

This should not be modified directly! Instead, utilize the various helper methods in this class.

-

Readonly InternalfirstCustomIndex

firstCustomIndex: number = ...

The ID of the first custom instrument.

-

Methods

[iterator]

Readonly InternalfirstCustomIndex

firstCustomIndex: number = ...

The ID of the first custom instrument.

+

Methods

[iterator]

add

add

create

Returns Instrument

create

delete

Returns Instrument

delete

  • delete(id): void

  • Delete an Instrument.

    Parameters

    • id: number

      ID of the instrument to be deleted

    Returns void

    Remarks

    Does not protect built-in instruments. This may not be desirable!

    See

    According to the NBS specification, instrument IDs must be consecutive! Make sure to update any proceeding instrument IDs.

    -

getTotal

set

getTotal

set

  • set(id, instrument): Instrument

  • Set an existing Instrument at an ID.

    Parameters

    • id: number

      ID of the instrument to be set

    • instrument: Instrument

      The instrument to set at id.

    Returns Instrument

    Remarks

    Any existing instrument with the same ID as the added instrument will be overwritten. This includes built-in instruments, which may not be desirable!

    See

    According to the NBS specification, instrument IDs must be consecutive!

    -

Constructors

constructor

Settings

Member Visibility

On This Page

Properties
Methods
Constructors

Interface FromArrayBufferOptionsInternal

Options for fromArrayBuffer.

-
interface FromArrayBufferOptions {
    ignoreEmptyLayers?: boolean;
}

Properties

ignoreEmptyLayers? +
interface FromArrayBufferOptions {
    ignoreEmptyLayers?: boolean;
}

Properties

ignoreEmptyLayers?

Properties

OptionalignoreEmptyLayers

ignoreEmptyLayers?: boolean

Whether to ignore (delete) unpopulated leading layers.

Remarks

Note Block Studio automatically generates extra layers past the last populated layer.

This option skips those layers upon import.

-

Settings

Member Visibility

On This Page

Properties

Interface InstrumentOptions

Options available for an Instrument.

-
interface InstrumentOptions {
    key?: number;
    name?: string;
    pressKey?: boolean;
    soundFile?: string;
}

Properties

key? +
interface InstrumentOptions {
    key?: number;
    name?: string;
    pressKey?: boolean;
    soundFile?: string;
}

Properties

key? name? pressKey? soundFile?

Properties

Optionalkey

key?: number

Key of the sound file.

Remarks

Just like note blocks, this ranges from 0-87.

-

Optionalname

name?: string

Name of the instrument.

-

OptionalpressKey

pressKey?: boolean

Whether the on-screen piano should visually press keys when these notes are played.

-

OptionalsoundFile

soundFile?: string

Sound file of the instrument.

+

Optionalname

name?: string

Name of the instrument.

+

OptionalpressKey

pressKey?: boolean

Whether the on-screen piano should visually press keys when these notes are played.

+

OptionalsoundFile

soundFile?: string

Sound file of the instrument.

Remarks

Relative to the Data/Sounds/ directory of Note Block Studio installations.

-

Settings

Member Visibility

On This Page

Properties

Interface LayerOptions

Options available for a Layer.

-
interface LayerOptions {
    isLocked?: boolean;
    isSolo?: boolean;
    name?: string;
    stereo?: number;
    volume?: number;
}

Properties

isLocked? +
interface LayerOptions {
    isLocked?: boolean;
    isSolo?: boolean;
    name?: string;
    stereo?: number;
    volume?: number;
}

Properties

isLocked? isSolo? name? stereo? volume?

Properties

OptionalisLocked

isLocked?: boolean

Whether this layer has been marked as locked.

-

OptionalisSolo

isSolo?: boolean

Whether this layer has been marked as solo.

-

Optionalname

name?: string

Name of the layer.

-

Optionalstereo

stereo?: number

How much this layer is panned to the left or right.

-

Optionalvolume

volume?: number

Volume percentage of the layer.

-

Settings

Member Visibility

On This Page

Properties

Interface NoteOptions

Options available for a Note.

-
interface NoteOptions {
    key?: number;
    panning?: number;
    pitch?: number;
    velocity?: number;
}

Properties

key? +
interface NoteOptions {
    key?: number;
    panning?: number;
    pitch?: number;
    velocity?: number;
}

Properties

key? panning? pitch? velocity?

Properties

Optionalkey

key?: number

Key of the note block.

Remarks

From 0 to 87. 33 to 57 is within the 2-octave limit.

-

Optionalpanning

panning?: number

Stereo position of the note block.

+

Optionalpanning

panning?: number

Stereo position of the note block.

Remarks

From -100 to 100.

-

Optionalpitch

pitch?: number

Fine pitch of the note block.

+

Optionalpitch

pitch?: number

Fine pitch of the note block.

Remarks

The max in Note Block Studio is limited to -1200 and +1200.

-

Optionalvelocity

velocity?: number

Velocity (volume) of the note block.

+

Optionalvelocity

velocity?: number

Velocity (volume) of the note block.

Remarks

From 0% to 100%.

-

Settings

Member Visibility

On This Page

Properties

Interface SongAutoSave

Options available for Song#autoSave.

Remarks

These properties are not used within nbs.js for anything other than storage.

They only exist as data fields to work with other applications that implement functionality.

-
interface SongAutoSave {
    enabled: boolean;
    interval: number;
}

Properties

enabled +
interface SongAutoSave {
    enabled: boolean;
    interval: number;
}

Properties

enabled interval

Properties

enabled

enabled: boolean

Whether auto-saving has been enabled.

-

interval

interval: number

Number of minutes between each auto-save.

+

interval

interval: number

Number of minutes between each auto-save.

Remarks

Ranges from 1 to 60.

-

Settings

Member Visibility

On This Page

Properties

Interface SongLoop

Options available for Song#loop.

Remarks

These properties are not used within nbs.js for anything other than storage.

They only exist as data fields to work with other applications that implement functionality.

-
interface SongLoop {
    enabled: boolean;
    startTick: number;
    totalLoops: number;
}

Properties

enabled +
interface SongLoop {
    enabled: boolean;
    startTick: number;
    totalLoops: number;
}

Properties

enabled startTick totalLoops

Properties

enabled

enabled: boolean

Whether looping is enabled.

-

startTick

startTick: number

Where the song should loop back to.

+

startTick

startTick: number

Where the song should loop back to.

Remarks

Unit is ticks.

-

totalLoops

totalLoops: number

Number of times the song should loop.

+

totalLoops

totalLoops: number

Number of times the song should loop.

Remarks

0 designates infinite.

-

Settings

Member Visibility

On This Page

Properties

Interface ToArrayBufferOptionsInternal

Options for toArrayBuffer.

-
interface ToArrayBufferOptions {
    ignoreEmptyLayers?: boolean;
}

Properties

ignoreEmptyLayers? +
interface ToArrayBufferOptions {
    ignoreEmptyLayers?: boolean;
}

Properties

ignoreEmptyLayers?

Properties

OptionalignoreEmptyLayers

ignoreEmptyLayers?: boolean

Whether to ignore unpopulated leading layers.

Remarks

This skips all layers without notes from the exported song.

-

Settings

Member Visibility

On This Page

Properties

Type Alias BuiltIn

BuiltIn: {
    [Id in keyof typeof builtInBuilder]: Instrument
}

Every built-in instrument.

See

Instrument.builtIn

-

Settings

Member Visibility

Variable builtInBuilderConst Internal

builtInBuilder: BuiltInBuilder = ...

Used to construct Instrument.builtIn.

-

Settings

Member Visibility

Variable defaultAutoSaveConst Internal

defaultAutoSave: SongAutoSave = ...

Default Song#autoSave values.

-

Settings

Member Visibility

Variable defaultFromArrayBufferOptionsConst Internal

defaultFromArrayBufferOptions: FromArrayBufferOptions = ...

Default options for fromArrayBuffer.

-

Settings

Member Visibility

Variable defaultInstrumentOptionsConst

defaultInstrumentOptions: InstrumentOptions = ...

Default Instrument values.

-

Settings

Member Visibility

Variable defaultLayerOptionsConst Internal

defaultLayerOptions: Required<LayerOptions> = ...

Default Layer values.

-

Settings

Member Visibility

Variable defaultLoopConst Internal

defaultLoop: SongLoop = ...

Default Song#loop values.

-

Settings

Member Visibility

Variable defaultNoteOptionsConst Internal

defaultNoteOptions: Required<NoteOptions> = ...

Default NoteOptions values.

-

Settings

Member Visibility

Variable defaultToArrayBufferOptionsConst Internal

defaultToArrayBufferOptions: ToArrayBufferOptions = ...

Default options for toArrayBuffer.

-

Settings

Member Visibility