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

From FenixWiki

Revision as of 11:53, 30 July 2007 (edit) G105b (Talk | contribs) (New page: Category:functions Category:sound ==Definition== '''INT''' unload_song ( <'''INT''' SongID> ) Frees the memory occupied by the song file. == Parameters == {| | '''INT''' SongID...) ← Previous diff		Current revision (13:10, 19 September 2007) (edit) (undo) Sandman (Talk | contribs) m
(2 intermediate revisions not shown.)
Line 5:		Line 5:
	'''INT''' unload_song ( <'''INT''' SongID> )		'''INT''' unload_song ( <'''INT''' SongID> )
-	Frees the memory occupied by the song file.	+	Frees the memory occupied by the song file, previously loaded with [[load_song]]().
	== Parameters ==		== Parameters ==
	{|		{|
-	| '''INT''' SongID || - The [[SongID]] identifier of the music.	+	| '''INT''' SongID || - The [[SongID]] of the song to unload.
	|}		|}
-	== Notes ==	+	== Returns ==
-	This function frees up the memory occupied by the song file, first loaded with [[load_song]]. Before unloading the song, it is necessary to stop the playback with the function [[stop_song]].	+	'''INT''' : Error.
		+	{|
		+	| -1 || - Error: sound inactive; invalid [[songID]].
		+	|-
		+	| 0 || - No error.
		+	|}
		+
		+	{{Funcbox
		+	| category=Sound
		+	}}

---

Current revision

[edit] Definition

INT unload_song ( <INT SongID> )

Frees the memory occupied by the song file, previously loaded with load_song().

[edit] Parameters

INT SongID

- The SongID of the song to unload.

[edit] Returns

INT : Error.

-1	- Error: sound inactive; invalid songID.
0	- No error.

Sound Functions

• Is_playing_song() • Load_song() • Load_wav() • Pause_song() • Play_song() • Play_wav() • Resume_song() • Set_song_volume() • Unload_song() •