View Javadoc

1   /*
2    * Created on Jul 27, 2004 
3    * 
4    *   Magic-Project is a turn based strategy simulator
5    *   Copyright (C) 2003-2007 Fabrice Daugan
6    *
7    *   This program is free software; you can redistribute it and/or modify it 
8    * under the terms of the GNU General Public License as published by the Free 
9    * Software Foundation; either version 2 of the License, or (at your option) any
10   * later version.
11   *
12   *   This program is distributed in the hope that it will be useful, but WITHOUT 
13   * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14   * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more 
15   * details.
16   *
17   *   You should have received a copy of the GNU General Public License along  
18   * with this program; if not, write to the Free Software Foundation, Inc., 
19   * 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
20   * 
21   */
22  package net.sf.magicproject.stack;
23  
24  /***
25   * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
26   */
27  public interface ResolveStackHandler {
28  
29  	/***
30  	 * called when the stack is resolving
31  	 * 
32  	 * @see StackManager#resolveStack()
33  	 */
34  	void resolveStack();
35  
36  	/***
37  	 * Indicates if this ability is immediatly after it has been added to the
38  	 * stack. Note it's not says immediatly it has been triggered or playable, but
39  	 * says it has been activated - so added directly to the stack -, or has been
40  	 * triggered - so added to the triggered buffer zone - and then has been
41  	 * selected to be moved to the stack.
42  	 * 
43  	 * @return true if this ability is immediatly after it has been added to the
44  	 *         stack.
45  	 */
46  	boolean isAutoResolve();
47  
48  	/***
49  	 * Indicates if this ability is immediatly after it has been added to the
50  	 * stack (like isAutoResolve), and if no information is displayed or prompted
51  	 * to the users. Users would not see this ability played.
52  	 * 
53  	 * @return true if this ability is immediatly after it has been added to the
54  	 *         stack (like isAutoResolve), and if no information is displayed or
55  	 *         prompted to the users. Users would not see this ability played.
56  	 * @see #isAutoResolve()
57  	 */
58  	boolean isHidden();
59  }