SND_SetPlayerLocalVariable

C Specification

#include <nitro/snd.h>
void SND_SetPlayerLocalVariable( int playerNo, int varNo, s16 var );

Arguments

playerNo The Player number. Takes a value between 0 and 15.
varNo The variable number. Takes a value between 0 and 15.
var The variable value. Takes a value between -32768 and 32767.

Return Values

None.

Description

Changes the local variable of the sequence being played by the Player specified by playerNo.

Use the SND_GetPlayerLocalVariable function to get the value of the local variable written in the sequence data.

Caution

If a value has already been written in the sequence data for the variable number specified by varNo, the value last set is the one that is valid.

This function is an ARM7 reserved function. After this function is called, processing occurs only after the command is issued with the SND_FlushCommand function.

When it is necessary to synchronize something with the completion of the process, first use SND_GetCurrentCommandTag to obtain the command tag immediately after calling this function. After the command is issued, use the command tag and call either the SND_IsFinishedCommandTag or SND_WaitForCommandProc function to confirm that the process has finished or to wait for it to complete.

See Also

SND_GetPlayerLocalVariable, SND_FlushCommand, SND_GetCurrentCommandTag, SND_IsFinishedCommandTag, SND_WaitForCommandProc

Revision History

02/17/2005 Added a note about ARM7 command processing
07/20/2004 Initial version