View Javadoc

1   /*
2    * Created on Nov 28, 2004 
3    * Original filename was LoopAction.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 net.sf.magicproject.clickable.ability.Ability;
26  import net.sf.magicproject.event.context.ContextEventListener;
27  
28  /***
29   * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
30   * @since 0.80
31   */
32  public interface LoopAction {
33  
34  	/***
35  	 * Continue this action, giving the next index of this loop.
36  	 * 
37  	 * @param context
38  	 *          is the context attached to this action.
39  	 * @param loopingIndex
40  	 *          the current index
41  	 * @param ability
42  	 *          is the ability owning this test. The card component of this
43  	 *          ability should correspond to the card owning this test too.
44  	 * @return true if the stack can be resolved just after this action.
45  	 */
46  	boolean continueLoop(ContextEventListener context, int loopingIndex,
47  			Ability ability);
48  
49  	/***
50  	 * Return the first index of this loop.
51  	 * 
52  	 * @return the first index of this loop.
53  	 */
54  	int getStartIndex();
55  
56  }