View Javadoc

1   /*
2    * Created on Oct 23, 2004 
3    * Original filename was Sound.java
4    * 
5    *   Magic-Project is a turn based strategy simulator
6    *   Copyright (C) 2003-2007 Fabrice Daugan
7    *
8    *   This program is free software; you can redistribute it and/or modify it 
9    * under the terms of the GNU General Public License as published by the Free 
10   * Software Foundation; either version 2 of the License, or (at your option) any
11   * later version.
12   *
13   *   This program is distributed in the hope that it will be useful, but WITHOUT 
14   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
15   * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 
16   * details.
17   *
18   *   You should have received a copy of the GNU General Public License along  
19   * with this program; if not, write to the Free Software Foundation, Inc., 
20   * 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
21   * 
22   */
23  package net.sf.magicproject.action;
24  
25  import java.io.IOException;
26  import java.io.InputStream;
27  
28  import net.sf.magicproject.action.handler.StandardAction;
29  import net.sf.magicproject.clickable.ability.Ability;
30  import net.sf.magicproject.event.context.ContextEventListener;
31  import net.sf.magicproject.tools.Configuration;
32  import net.sf.magicproject.tools.MToolKit;
33  
34  /***
35   * Play a sound.
36   * 
37   * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
38   * @since 0.80
39   */
40  public class Sound extends UserAction implements StandardAction {
41  
42  	/***
43  	 * Create an instance of Sound by reading a file Offset's file must pointing
44  	 * on the first byte of this action. <br>
45  	 * <ul>
46  	 * Structure of InputStream : Data[size]
47  	 * <li>sound filename to play +'/0' [...]</li>
48  	 * </ul>
49  	 * 
50  	 * @param inputFile
51  	 *          file containing this action
52  	 * @throws IOException
53  	 *           if error occurred during the reading process from the specified
54  	 *           input stream
55  	 */
56  	Sound(InputStream inputFile) throws IOException {
57  		super(inputFile);
58  		soundFile = MToolKit.readString(inputFile);
59  	}
60  
61  	@Override
62  	public final Actiontype getIdAction() {
63  		return Actiontype.SOUND;
64  	}
65  
66  	public boolean play(ContextEventListener context, Ability ability) {
67  		if (Configuration.getBoolean("sound", false)) {
68  			MToolKit.loadClip(soundFile);
69  		}
70  		return true;
71  	}
72  
73  	@Override
74  	public String toString(Ability ability) {
75  		return "Play sound " + soundFile;
76  	}
77  
78  	/***
79  	 * The sound file to play
80  	 */
81  	private String soundFile;
82  
83  }