ResultVariable
When adding an action with the script editor, you can use this field to specify a variable that the return value will be stored in.
See also: Related Actions
Audio.IsLooping
OverviewExamples
boolean Audio.IsLooping ( number Channel )
De s cr ip t ion
Returns true if an audio channel is set to loop when it reaches the end.
P arame t er s
Channel
(number) The audio channel to inspect:
|
CONSTANT |
VALUE DESCRIPTION |
|
|
CHANNEL_BACKGROUND |
5 |
Background audio channel. |
|
CHANNEL_EFFECTS |
0 |
Effects channel (used for mouse over, down, and click sounds). |
|
CHANNEL_NARRATION |
6 |
Narration channel (used for voice overs). |
|
CHANNEL_USER1 |
1 |
User channel 1. |
|
CHANNEL_USER2 |
2 |
User channel 2. |
|
CHANNEL_USER3 |
3 |
User channel 3. |
|
CHANNEL_USER4 |
4 |
User channel 4. |
Re t u r n s
(boolean) True if the audio channel will loop, or false if it won't. If an error occurs, false will be returned. You can use Application.GetLastError to determine whether this action failed, and why.