Oolite JavaScript Reference: SoundSource - Revision history

Cim: /* Properties */ 1.79 properties

2013-12-30T21:04:03Z

‎Properties: 1.79 properties

Ahruman: /* sound */

2011-01-06T17:24:11Z

‎sound

Ahruman: Fixed dangling small

2010-06-28T08:56:06Z

Fixed dangling small

Ahruman: Updated for 1.74.

2010-06-20T14:39:33Z

Updated for 1.74.

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

2010-06-19T14:06:43Z

Moving Oolite JS reference into a *correctly-named* subcategory of Oolite scripting.

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

2010-06-19T13:57:55Z

Moving Oolite JS reference into a subcategory of Oolite scripting.

Eric Walch: Added example

2009-12-31T13:48:13Z

Added example

Ahruman: /* `playSound` */

2009-10-02T22:01:14Z

‎<code>playSound</code>

Ahruman: New page: '''Prototype:''' `Object`
'''Subtypes:''' none {{Oolite-class-added|1.71}} A '''SoundSource''' is an abstract object that can play a sound. A given...

2009-10-02T22:00:44Z

New page: '''Prototype:''' <code>Object</code> '''Subtypes:''' none {{Oolite-class-added|1.71}} A '''SoundSource''' is an abstract object that can play a sound. A given...

New page

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

{{Oolite-class-added|1.71}}

A '''SoundSource''' is an abstract object that can play a sound. A given <code>SoundSource</code> can only be playing one sound at a particular time.

=== Sound Expressions ===
Several <code>SoundSource</code> properties and methods can take either <code>Sound</code> object, or a string representing a file name or a [[customsounds.plist]] key.

== Properties ==
=== <code>isPlaying</code> ===
'''isPlaying''' : Boolean (read-only)
<code>true</code> if the sound is currently playing, <code>false</code> otherwise.

=== <code>loop</code> ===
'''loop''' : Boolean (read/write)
<code>true</code> if the sound source should loop its sound, <code>false</code> otherwise. Changing this while a sound is playing does not affect the currently-playing sound; it only takes effect when the sound source starts playing.

'''See Also:''' <code>[[#repeatCount|repeatCount]]</code>

=== <code>repeatCount</code> ===
'''repeatCount''' : Integer (read/write)
The number of times the sound should repeat, if <code>loop</code> is <code>false</code>, ranging from 1 to 100. Unlike [[#loop|loop]], this can usefully be changed while the sound is playing, and <code>repeatCount</code> will be decremented each time the sound is repeated.

'''See Also:''' <code>[[#loop|loop]]</code>

=== <code>sound</code> ===
'''sound''' : [[#Sound Expressions|soundExpression]] (read/write)
The sound to be played by this sound source. You can assign either a <code>[[Oolite JavaScript Reference: Sound]]</code> or a string to this property, but when you read it it will always be a <code>[[Oolite JavaScript Reference: Sound]]</code> object (or <code>null</code>).

== Methods ==
=== <code>play</code> ===
play([count : Integer])
Start playing <code>[[#sound|sound]]</code>. If <code>count</code> is specified, <code>[[#repeatCount|repeatCount]]</code> is set to <code>count</code> first. If the sound source is currently playing a sound, it is stopped.

'''See Also:''' <code>[[#playOrRepeat|playOrRepeat]]()</code>, <code>[[#playSound|playSound]]()</code>

=== <code>playOrRepeat</code> ===
playOrRepeat()
If a sound is not playing, starts playing. If a sound is playing and is not looping, increases [[#repeatCount|repeatCount]] by one.

'''See Also:''' <code>[[#play|play]]()</code>

=== <code>playSound</code> ===
play(sound : [[#Sound Expressions|soundExpression]] [, count : Integer])
Set <code>[[#sound|sound]]</code> (and, optionally, [[#repeatCount|repeatCount]]) and start playing.

'''See Also:''' <code>[[#play|play]]()</code>

=== <code>stop</code> ===
stop()
Stop playing sound.

[[Category:Oolite scripting]]

@@ Line 1: / Line 1: @@
 <small>'''Prototype:''' <code>Object</code></small><br />
-<small>'''Subtypes:''' none
+<small>'''Subtypes:''' none</small>
 A '''SoundSource''' is an abstract object that can play a sound. A given <code>SoundSource</code> can only be playing one sound at a particular time.

@@ Line 1: / Line 1: @@
 <small>'''Prototype:''' <code>Object</code></small><br />
 <small>'''Subtypes:''' none
 A '''SoundSource''' is an abstract object that can play a sound. A given <code>SoundSource</code> can only be playing one sound at a particular time.

← Older revision		Revision as of 14:06, 19 June 2010
Line 64:		Line 64:


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

← Older revision		Revision as of 13:57, 19 June 2010
Line 64:		Line 64:


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

@@ Line 26: / Line 26: @@
 '''See Also:''' <code>[[#repeatCount|repeatCount]]</code>
 === <code>repeatCount</code> ===
@@ Line 36: / Line 48: @@
  '''sound''' : [[#Sound Expressions|soundExpression]] (read/write)
 The sound to be played by this sound source. You can assign either a <code>[[Oolite JavaScript Reference: Sound|Sound]]</code> or a string to this property, but when you read it it will always be a <code>[[Oolite JavaScript Reference: Sound|Sound]]</code> object (or <code>null</code>).
 == Methods ==

@@ Line 8: / Line 8: @@
 === Sound Expressions ===
 Several <code>SoundSource</code> properties and methods can take either  <code>Sound</code> object, or a string representing a file name or a [[customsounds.plist]] key.
 == Properties ==

@@ Line 46: / Line 46: @@
 === <code>playSound</code> ===
  play(sound : [[#Sound Expressions|soundExpression]] [, count : Integer])
-Set <code>[[#sound|sound]]</code> (and, optionally, [[#repeatCount|repeatCount]]) and start playing.
+Set <code>[[#sound|sound]]</code> (and, optionally, <code>[[#repeatCount|repeatCount]]</code>) and start playing.
 '''See Also:''' <code>[[#play|play]]()</code>