nw::snd::SequenceSoundHandle::SetTrackBankIndex Member Function

#include <nw/snd/snd_SequenceSoundHandle.h>
bool SetTrackBankIndex(
     u32 trackBitFlag,
     int bankIndex
);

	Name	Description
in	trackBitFlag	Bit flag for each track.
in	bankIndex	The number of the bank to free.

Returns TRUE if the texture image is 0- to 3-bit format. Returns false if the value is out of bounds. (Release builds only. Execution stops on an assert in the case of Debug and Development builds.)

Changes the track bank of the sequence sound.

Changes the sequence track bank of the sound associated with the handle. If the handle is invalid, the function does nothing.

The value specified by this function operates independently of other volume parameters. The last value to arrive is enabled.

The trackBitFlag argument specifies the track. The tracks are identified from the lower bit in sequence: Track 0, Track 1, Track 2 .... All tracks with enabled bits will have their bank changed. For example, to change the bank of Track 2 and Track 5, use (1 << 2) | (1 << 5); that is, 0x0024.

The bank number given by bankIndex is specified as a value from 0 to 3. This value of 0 to 3 corresponds to the line number in the dialog box list displayed for multi-bank settings when using SoundMaker. If another number is specified, execution stops on an assert (Debug and Development versions). (Release version) Returns false.

If a bank_select command has been inserted in the sequence, subsequent settings for this function and subsequent bank_select commands will be enabled.

2011/02/22

Revised the description of return values.

2010/06/25

Corrected a mistake (silent status > bank).

2010/06/17

Initial version.