Class weasel.PatternCell

Defined in: PatternCell.js.

Class Summary
Constructor Attributes	Constructor Name and Description
	weasel.PatternCell(iPatternCellData) Object to contain a single cell of pattern data (4 cells per pattern row).

Method Summary
Method Attributes	Method Name and Description
	getEffectNumber() Get the effect number from the current pattern cell.
	getEffectParameter() Get the effect parameter value from the current pattern cell.
	getInstrumentNumber() Get the instrument number from the current pattern cell.
	getNotePeriod() Get the Amiga note period of the current pattern cell.
	setCell(iPatternCellData) Set the pattern cell data for this cell.

Class Detail

weasel.PatternCell(iPatternCellData)

Object to contain a single cell of pattern data (4 cells per pattern row).
Author: Warren Willmey 2011.

Parameters:
{int} iPatternCellData: = The pattern cell data as a 32bit integer which takes the form nnnniedd, n = note, i = instrument number, e = effect number, d = effect data.

Method Detail

{int} getEffectNumber()

Get the effect number from the current pattern cell.

Returns:: {int} = The effect number stored in this cell (0-2 range, 0 = no effect, 1 = arpeggio, 2 = pitch bend).

{int} getEffectParameter()

Get the effect parameter value from the current pattern cell.

Returns:: {int} = The effect parameter value in this cell (Its meaning depends on the Effect Number).

{int} getInstrumentNumber()

Get the instrument number from the current pattern cell.

Returns:: {int} = The instrument number stored in this cell (0-15 range, 0 = no instrument number).

{int} getNotePeriod()

Get the Amiga note period of the current pattern cell.

setCell(iPatternCellData)

Set the pattern cell data for this cell.

Parameters:
{int} iPatternCellData: = In format of 0x12345678 where: 0x1234 = note period value , 0x5 = instrument number , 0x6 = effect number , 0x78 = effect parameter.

Classes