audio

This loop will repeat the function for each entry of a numbered table as if you call the function and pass the value of the table to the function.

foreach( table, function )

Example Table:

foreach( highscores, print )

-- prints: 984 145 103

This loop will repeat the code after do for each entry of the table provided and it will also set both the key and the value for each table entry as the local variable names you give them after for.

for key, value in pairs( table ) do

Example Table:

This is how you loop through this table, being able to access and use both the keys (names) and values (scores):

for name, score in pairs( highscores ) do
	print( name )
	print( score )
end

-- prints: john 10 bob 143 kim 984

sfx( #, [channel], [offset], [length] )

sfx( 1 )

sfx( 3, 0 )

sfx( 4, 2, 6 )

sfx( 4, 2, 6, 20 )

Extra Options using Negative Numbers:

sfx( -1 , 3 )

sfx( -2 , 3 )

sfx( -1 )

sfx( -2 )

music( #, [fade-length], [channel-mask] )

# = the number of the song in the music editor.

fade-length = (optional) a number, in milliseconds (default 0), to fade-in the music - increase the volume over this amount of time.

channel-mask = (optional) reserves channels for music (#0-15).

Note: SFX can still play on reserved channels but only if specifically designating the channel number with sfx(#, channel)

music( 1 )

music( 3, 1000 )

music( 4, 3000, 1 )

Important to know:

- A music pattern is simply one or more SFX patterns set to play in specific channels at the same time.

- There are only 4 channels and each channel can play only 1 SFX pattern at a time.

- You can only play 1 music pattern at a time (using up to 4 channels).

- The channels that the music pattern will use are set in the music editor.

- Playing an SFX will use the lowest available channel, unless the channel is specified.

- Using the channel-mask argument to reserve a channel for music does not affect which channels music plays on but does affect which channels are available for SFX to play on.

Extra Option using a Negative Number:

music( -1 )

- stop the currently playing music pattern

Reserving multiple channels:

The channel-mask option does not take channel numbers like sfx() does. Instead, the channel-mask is a value that represents one or more channel numbers.

The default channel-mask value is 0, no channels reserved for music.

To reserve multiple channels, you simply add the mask values together. For example, if we want to reserve channels 2 and 3 for music, then we take channel #2's value of 4 and channel #3's value of 8. Then we add them together: 4 + 8 = 12. So music( 0, 0, 12 ) will play pattern 0 and reserve channels 2 and 3 for music.

Let's flip the above table and list all the channel-mask values in order and see which channels each value will reserve:

Example:

music( 1, 0, 6)

- play music pattern #1, without fade-in, and reserve channels 1 and 2 for music.