This wiki is out of date, use the continuation of this wiki instead

From FenixWiki

Revision as of 15:16, 22 April 2007 (edit) Woody (Talk | contribs) ← Previous diff		Revision as of 23:51, 25 April 2007 (edit) (undo) Sandman (Talk | contribs) Next diff →
Line 3:		Line 3:
	==Definition==		==Definition==
-		+	'''INT''' play_song ( <'''INT''' songID> , <'''INT''' repeats> )
-	'''INT''' play_song ( <'''INT''' song> , <'''INT''' repeats> )	+
	Plays a song.		Plays a song.
-
	== Parameters ==		== Parameters ==
-
	{|		{|
-	| '''INT''' song || - Identifier of the song loaded previously with [[load_song]].	+	| '''INT''' songID || - Identifier of the song loaded previously with [[load_song]].
	|-		|-
	| '''INT''' repeats || - Number of times to repeat the song. Use -1 for an infinite loop.		| '''INT''' repeats || - Number of times to repeat the song. Use -1 for an infinite loop.
	|}		|}
		+
		+	== Returns ==
		+	'''INT''' : Errorcode
		+	{|
		+	| -1 || - Error.
		+	|-
		+	| 0 || - No error.
		+	|}
		+
		+	== Throws ==
		+	{|
		+	| Sound inactive || - The sound is inactive.
		+	|-
		+	| Invalid handle || - The song identifier was invalid.
		+	|-
		+	| Other || - Some Mixer error.
		+	|}
		+
		+	== Example ==
		+	<pre>
		+	Program example;
		+	Private
		+	int song;
		+	Begin
		+	song = load_song("my_song.ogg");
		+	play_song(song,0);
		+	Loop
		+	frame;
		+	End
		+	End
		+	</pre>

---

Revision as of 23:51, 25 April 2007

Contents 1 Definition 2 Parameters 3 Returns 4 Throws 5 Example

Definition

INT play_song ( <INT songID> , <INT repeats> )

Plays a song.

Parameters

INT songID	- Identifier of the song loaded previously with load_song.
INT repeats	- Number of times to repeat the song. Use -1 for an infinite loop.

Returns

INT : Errorcode

-1	- Error.
0	- No error.

Throws

Sound inactive	- The sound is inactive.
Invalid handle	- The song identifier was invalid.
Other	- Some Mixer error.

Example

Program example;
Private
    int song;
Begin
    song = load_song("my_song.ogg");
    play_song(song,0);
    Loop
        frame;
    End
End