Oolite JavaScript Reference: Sound - Revision history

Phkb at 00:23, 15 November 2017

2017-11-15T00:23:34Z

Ahruman: Fixed dangling small

2010-06-28T08:55:50Z

Fixed dangling small

Ahruman: Updated for 1.74.

2010-06-20T14:38:38Z

Updated for 1.74.

Ahruman at 14:06, 19 June 2010

2010-06-19T14:06:20Z

Ahruman: Moving Oolite JS reference into a subcategory of Oolite scripting.

2010-06-19T13:57:41Z

Moving Oolite JS reference into a subcategory of Oolite scripting.

Ahruman at 21:39, 2 October 2009

2009-10-02T21:39:41Z

Ahruman at 21:36, 2 October 2009

2009-10-02T21:36:34Z

Kaks: /* `name` */

2009-09-17T15:21:53Z

‎<code>name</code>

Kaks: New page: '''Prototype:''' `Object`
'''Subtypes:''' SoundSource {{Oolite-class-added|1.71}} The '''Sound''' class is used to play music or sound effects. ==...

2009-09-17T15:19:38Z

New page: '''Prototype:''' <code>Object</code> '''Subtypes:''' SoundSource {{Oolite-class-added|1.71}} The '''Sound''' class is used to play music or sound effects. ==...

New page

'''Prototype:''' <code>Object</code> 
'''Subtypes:''' SoundSource

{{Oolite-class-added|1.71}}

The '''Sound''' class is used to play music or sound effects.

== Properties ==
=== <code>name</code> ===
{{Oolite-prop-added|1.70}}
'''name''' : String (read-only)
The file name of the sound file.

== Methods ==
=== <code>load</code> ===
function '''load'''(soundFile : String)
Loads a music file to memory, to avoid stutter on playback.

=== <code>playMusic</code> ===
function '''playMusic'''(soundFile : String)
Starts playing the sound file. Stops upon reaching the end of the sound file.

=== <code>stopMusic</code> ===
function '''stopMusic'''([soundFile : String])
Stops the specified sound file from playing. If no file is specified, stops all music.

[[Category:Oolite scripting]]

@@ Line 8: / Line 8: @@
  '''name''' : String (read-only)
 The file name of the sound file.
 == Static methods ==
@@ Line 15: / Line 21: @@
 === <code>playMusic</code> ===
- function '''playMusic'''(soundFile : String [, loop: Boolean])
+ function '''playMusic'''(soundFile : String [, loop: Boolean [, volumeGain: Float])
 Play the specified music file, optionally looped. This may have no effect depending on the player’s music settings.
 === <code>stopMusic</code> ===

@@ Line 1: / Line 1: @@
 <small>'''Prototype:''' <code>Object</code></small><br />
-<small>'''Subtypes:''' none
+<small>'''Subtypes:''' none</small>
 The '''Sound''' class represents sound files. A <code>Sound</code> can be played through a <code>[[Oolite JavaScript Reference: SoundSource|SoundSource]]</code>.  <code>Sound</code> also provides functions to start and stop music.

@@ Line 1: / Line 1: @@
 <small>'''Prototype:''' <code>Object</code></small><br />
 <small>'''Subtypes:''' none
 The '''Sound''' class represents sound files. A <code>Sound</code> can be played through a <code>[[Oolite JavaScript Reference: SoundSource|SoundSource]]</code>.  <code>Sound</code> also provides functions to start and stop music.

← Older revision		Revision as of 14:06, 19 June 2010
Line 24:		Line 24:
	Stop music. If a name is specified, the music will only be stopped if that’s the name of the currently playing music. For example, if you start some music with <code>Sound.playMusic("myoxp-exciting-music.ogg")</code> and later want to stop it, call <code>Sound.stopMusic("myoxp-exciting-music.ogg")</code> to avoid stopping any other music that may have taken over in the meanwhile.		Stop music. If a name is specified, the music will only be stopped if that’s the name of the currently playing music. For example, if you start some music with <code>Sound.playMusic("myoxp-exciting-music.ogg")</code> and later want to stop it, call <code>Sound.stopMusic("myoxp-exciting-music.ogg")</code> to avoid stopping any other music that may have taken over in the meanwhile.

−	[[Category:Oolite JavaScript ~~reference~~]]	+	[[Category:Oolite JavaScript Reference]]

← Older revision		Revision as of 13:57, 19 June 2010
Line 24:		Line 24:
	Stop music. If a name is specified, the music will only be stopped if that’s the name of the currently playing music. For example, if you start some music with <code>Sound.playMusic("myoxp-exciting-music.ogg")</code> and later want to stop it, call <code>Sound.stopMusic("myoxp-exciting-music.ogg")</code> to avoid stopping any other music that may have taken over in the meanwhile.		Stop music. If a name is specified, the music will only be stopped if that’s the name of the currently playing music. For example, if you start some music with <code>Sound.playMusic("myoxp-exciting-music.ogg")</code> and later want to stop it, call <code>Sound.stopMusic("myoxp-exciting-music.ogg")</code> to avoid stopping any other music that may have taken over in the meanwhile.

−	[[Category:Oolite ~~scripting~~]]	+	[[Category:Oolite JavaScript reference]]

@@ Line 14: / Line 14: @@
 === <code>load</code> ===
  function '''load'''(soundFile : String)
-Loads a sound file, and returns the resulting <code>Sound</code> object.
+Loads a sound file, and returns the resulting <code>Sound</code> object. <code>soundFile</code> may be either a file name or a [[customsounds.plist]] key in square brackets.
 === <code>playMusic</code> ===