View Javadoc

1   /*
2    *   Magic-Project is a turn based strategy simulator
3    *   Copyright (C) 2003-2007 Fabrice Daugan
4    *
5    *   This program is free software; you can redistribute it and/or modify it 
6    * under the terms of the GNU General Public License as published by the Free 
7    * Software Foundation; either version 2 of the License, or (at your option) any
8    * later version.
9    *
10   *   This program is distributed in the hope that it will be useful, but WITHOUT 
11   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12   * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 
13   * details.
14   *
15   *   You should have received a copy of the GNU General Public License along  
16   * with this program; if not, write to the Free Software Foundation, Inc., 
17   * 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
18   */
19  package net.sf.magicproject.action.listener;
20  
21  import net.sf.magicproject.clickable.targetable.card.TriggeredCard;
22  
23  /***
24   * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
25   * @since 0.86
26   */
27  public interface WaitingTriggeredCard extends Waiting {
28  
29  	/***
30  	 * Called to specify the triggered card chosen for the current action by the
31  	 * handed player
32  	 * 
33  	 * @param triggeredCard
34  	 *          the clicked card by the handed player for the current action
35  	 * @return true if this click has been managed. Return false if this click has
36  	 *         been ignored
37  	 */
38  	boolean clickOn(TriggeredCard triggeredCard);
39  
40  	/***
41  	 * This function should be called by the 'clickOn' caller in case of the
42  	 * specified triggered has been handled during the checking validity of this
43  	 * click in the <code>clickOn(TriggeredCard)</code> function. <br>
44  	 * <ul>
45  	 * The calls chain is :
46  	 * <li>actionListener call clickOn(TriggeredCard)
47  	 * <li>if returned value is false we give hand to the player and exit, else
48  	 * we continue
49  	 * <li>actionListener call succeedClickOn(TriggeredCard)
50  	 * </ul>
51  	 * 
52  	 * @param card
53  	 *          the triggered card that was clicked and successfuly handled by the
54  	 *          <code>clickOn(TriggeredCard)</code> function.
55  	 * @return true if this action is completed
56  	 */
57  	boolean succeedClickOn(TriggeredCard card);
58  
59  	void finished();
60  
61  	boolean manualSkip();
62  }