Play song - Revision history

Sandman at 12:02, 19 September 2007

2007-09-19T12:02:37Z

←Older revision		Revision as of 12:02, 19 September 2007
Line 9:		Line 9:
	== Parameters ==		== Parameters ==
	{\|		{\|
-	\| '''INT''' songID \|\| - ~~Identifier~~ of the song loaded previously with [[load_song]]().	+	\| '''INT''' songID \|\| - [[SongID]] 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.
Line 17:		Line 17:
	'''INT''' : Error.		'''INT''' : Error.
	{\|		{\|
-	\| -1 \|\| - Error: sound inactive; mixer error; invalid songID.	+	\| -1 \|\| - Error: sound inactive; mixer error; invalid [[songID]].
	\|-		\|-
	\| 0 \|\| - No error.		\| 0 \|\| - No error.
Line 26:		Line 26:
	\| Sound inactive \|\| - The sound is inactive.		\| Sound inactive \|\| - The sound is inactive.
	\|-		\|-
-	\| Invalid songID \|\| - The songID was invalid.	+	\| Invalid songID \|\| - The [[songID]] was invalid.
	\|-		\|-
	\| Other \|\| - Some Mixer error.		\| Other \|\| - Some Mixer error.
Line 45:		Line 45:
	</pre>		</pre>
	Used in example: [[load_song]]()		Used in example: [[load_song]]()
		+
		+	{{Funcbox
		+	\| category=Sound
		+	}}

Sandman: /* Errors */

2007-07-31T12:03:32Z

Errors

←Older revision		Revision as of 12:03, 31 July 2007
Line 26:		Line 26:
	\| Sound inactive \|\| - The sound is inactive.		\| Sound inactive \|\| - The sound is inactive.
	\|-		\|-
-	\| Invalid ~~handle~~ \|\| - The ~~song identifier~~ was invalid.	+	\| Invalid songID \|\| - The songID was invalid.
	\|-		\|-
	\| Other \|\| - Some Mixer error.		\| Other \|\| - Some Mixer error.

Sandman: /* Returns */

2007-07-31T12:00:21Z

Returns

←Older revision		Revision as of 12:00, 31 July 2007
Line 15:		Line 15:

	== Returns ==		== Returns ==
-	'''INT''' : ~~Errorcode~~	+	'''INT''' : Error.
	{\|		{\|
-	\| -1 \|\| - Error.	+	\| -1 \|\| - Error: sound inactive; mixer error; invalid songID.
	\|-		\|-
	\| 0 \|\| - No error.		\| 0 \|\| - No error.

Sandman: /* Parameters */

2007-07-31T11:08:47Z

Parameters

←Older revision		Revision as of 11:08, 31 July 2007
Line 9:		Line 9:
	== Parameters ==		== Parameters ==
	{\|		{\|
-	\| '''INT''' songID \|\| - 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.

Sandman: /* Throws */ -> Errors

2007-05-01T01:34:28Z

Throws - -> Errors

←Older revision		Revision as of 01:34, 1 May 2007
Line 22:		Line 22:
	\|}		\|}

-	== ~~Throws~~ ==	+	== Errors ==
	{\|		{\|
	\| Sound inactive \|\| - The sound is inactive.		\| Sound inactive \|\| - The sound is inactive.

Sandman: /* Example */

2007-04-26T01:19:12Z

Example

←Older revision		Revision as of 01:19, 26 April 2007
Line 44:		Line 44:
	End		End
	</pre>		</pre>
		+	Used in example: [[load_song]]()

Sandman at 23:51, 25 April 2007

2007-04-25T23:51:01Z

←Older revision		Revision as of 23:51, 25 April 2007
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>

Woody at 15:16, 22 April 2007

2007-04-22T15:16:34Z

←Older revision		Revision as of 15:16, 22 April 2007
Line 1:		Line 1:
	[[Category:functions]]		[[Category:functions]]
		+	[[Category:sound]]

	==Definition==		==Definition==

Woody at 10:22, 22 April 2007

2007-04-22T10:22:03Z

New page

[[Category:functions]]

==Definition==

'''INT''' play_song ( <'''INT''' song> , <'''INT''' repeats> )

Plays a song.

== Parameters ==

{|
| '''INT''' song || - Identifier of the song loaded previously with [[load_song]].
|-
| '''INT''' repeats || - Number of times to repeat the song. Use -1 for an infinite loop.
|}