From db0e6f93e1ce864a6efa965b10ba0754985da9f8 Mon Sep 17 00:00:00 2001
From: Charlie Groves <charlie@threerings.net>
Date: Tue, 5 Aug 2008 18:49:33 +0000
Subject: [PATCH] Document the return on play

git-svn-id: svn+ssh://src.earth.threerings.net/nenya/trunk@608 ed5b42cb-e716-0410-a449-f6a68f950b19
---
 src/java/com/threerings/media/sound/SoundManager.java | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/src/java/com/threerings/media/sound/SoundManager.java b/src/java/com/threerings/media/sound/SoundManager.java
index 678e039e..42e57e56 100644
--- a/src/java/com/threerings/media/sound/SoundManager.java
+++ b/src/java/com/threerings/media/sound/SoundManager.java
@@ -321,6 +321,9 @@ public class SoundManager
     /**
      * Play the specified sound as the specified type of sound, immediately. Note that a sound
      * need not be locked prior to playing.
+     *
+     * @return true if the sound actually played, or false if its sound type was disabled or if
+     * sound is off altogether.
      */
     public boolean play (SoundType type, String pkgPath, String key)
     {
@@ -333,6 +336,8 @@ public class SoundManager
      * Note that a sound need not be locked prior to playing.
      *
      * @param pan a value from -1f (all left) to +1f (all right).
+     * @return true if the sound actually played, or false if its sound type was disabled or if
+     * sound is off altogether.
      */
     public boolean play (SoundType type, String pkgPath, String key, float pan)
     {
@@ -342,6 +347,8 @@ public class SoundManager
     /**
      * Play the specified sound after the specified delay.
      * @param delay the delay in milliseconds.
+     * @return true if the sound actually played, or false if its sound type was disabled or if
+     * sound is off altogether.
      */
     public boolean play (SoundType type, String pkgPath, String key, int delay)
     {
@@ -352,6 +359,8 @@ public class SoundManager
      * Play the specified sound after the specified delay.
      * @param delay the delay in milliseconds.
      * @param pan a value from -1f (all left) to +1f (all right).
+     * @return true if the sound actually played, or false if its sound type was disabled or if
+     * sound is off altogether.
      */
     public boolean play (SoundType type, String pkgPath, String key, int delay, float pan)
     {