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

From FenixWiki

Revision as of 01:17, 26 April 2007 (edit) Sandman (Talk | contribs) m (→Example) ← Previous diff		Current revision (13:11, 19 September 2007) (edit) (undo) Sandman (Talk | contribs) m
(One intermediate revision not shown.)
Line 3:		Line 3:
	== Definition ==		== Definition ==
-	'''INT''' play_wav ( <'''INT''' waveID> , <'''INT''' repeats> )	+	'''INT''' play_wav ( <'''INT''' waveID> , <'''INT''' repeats> , [<'''INT''' channel>] )
-	Plays a [[sound effect]] previously loaded with [[load_wav]].	+	Plays a [[sound effect]] previously loaded with [[load_wav]]().
	== Parameters ==		== Parameters ==
Line 11:		Line 11:
	| '''INT''' waveID || - The [[WaveID]] of the sound effect to be played.		| '''INT''' waveID || - The [[WaveID]] of the sound effect to be played.
	|-		|-
-	| '''INT''' repeats || - Number of times to repeat the sound effect. Use -1 for an infinite loop.	+	| '''INT''' repeats || - Number of times to ''repeat'' the sound effect. Use -1 for an infinite loop.
		+	|-
		+	| ['''INT''' channel] || - The [[sound channel]] the [[sound effect]] is to be played on (-1 for any, default).
	|}		|}
	== Returns ==		== Returns ==
-	'''INT''' : Errorcode	+	'''INT''' : The [[sound channel]] the [[sound effect]] is now playing on.
	{|		{|
-	| -1 || - Error.	+	| -1 || - Error: sound inactive; invalid [[waveID]]
	|-		|-
-	| 0 || - No error.	+	| >=0 || - The [[sound channel]] the [[sound effect]] is now playing on.
	|}		|}
		+
		+
	== Example ==		== Example ==
Line 36:		Line 40:
	</pre>		</pre>
	Used in example: [[load_wav]]()		Used in example: [[load_wav]]()
		+
		+	{{Funcbox
		+	| category=Sound
		+	}}

---

Current revision

Contents 1 Definition 2 Parameters 3 Returns 4 Example

[edit] Definition

INT play_wav ( <INT waveID> , <INT repeats> , [<INT channel>] )

Plays a sound effect previously loaded with load_wav().

[edit] Parameters

INT waveID	- The WaveID of the sound effect to be played.
INT repeats	- Number of times to repeat the sound effect. Use -1 for an infinite loop.
[INT channel]	- The sound channel the sound effect is to be played on (-1 for any, default).

[edit] Returns

INT : The sound channel the sound effect is now playing on.

-1	- Error: sound inactive; invalid waveID
>=0	- The sound channel the sound effect is now playing on.

[edit] Example

Program
Private
    int wave;
Begin
    wave = load_wav("my_wav.wav");
    play_wav(wave,0);
    Loop
        frame;
    End
End

Used in example: load_wav()

Sound Functions

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