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.handler;
20  
21  import net.sf.magicproject.clickable.ability.Ability;
22  import net.sf.magicproject.event.context.ContextEventListener;
23  
24  /***
25   * A standard action is an action that can be simply be played with a given
26   * context.
27   * 
28   * @author <a href="mailto:fabdouglas@users.sourceforge.net">Fabrice Daugan </a>
29   * @since 0.90
30   */
31  public interface StandardAction {
32  
33  	/***
34  	 * Generate event associated to this action. Only one or several events are
35  	 * generated and may be collected by event listeners. Then play this action
36  	 * 
37  	 * @param ability
38  	 *          is the ability owning this test. The card component of this
39  	 *          ability should correspond to the card owning this test too.
40  	 * @param context
41  	 *          is the context attached to this action.
42  	 * @return true if the stack can be resolved just after this call.
43  	 */
44  	boolean play(ContextEventListener context, Ability ability);
45  
46  }