SND_SetPlayerGlobalVariable

Syntax

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

Arguments

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 sequence global variable.

Use the SND_GetPlayerGlobalVariable function to get the value of a global variable written in the sequence data.

Note

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, its processing will occur only after the command is issued with the SND_FlushCommand function.

If program execution must be synchronized with process completion, first use the SND_GetCurrentCommandTag function to obtain the command tag immediately after calling this function. Then, after the command is issued, use the command tag and call either the SND_IsFinishedCommandTag or SND_WaitForCommandProc function to confirm that processing has finished or to wait for it to complete.

See Also

SND_GetPlayerGlobalVariable, SND_FlushCommand, SND_GetCurrentCommandTag, SND_IsFinishedCommandTag, SND_WaitForCommandProc

Revision History

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


CONFIDENTIAL