Project

General

Profile

Download (2.69 KB) Statistics
| Branch: | Revision:

library / src / main / java / org / distorted / library / message / EffectListener.java @ 3a54358a

1 d333eb6b Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
2 3a54358a Leszek Koltunski
// Copyright 2016 Leszek Koltunski  leszek@koltunski.pl                                          //
3 d333eb6b Leszek Koltunski
//                                                                                               //
4 46b572b5 Leszek Koltunski
// This file is part of Distorted.                                                               //
5 d333eb6b Leszek Koltunski
//                                                                                               //
6 3a54358a Leszek Koltunski
// This library is free software; you can redistribute it and/or                                 //
7
// modify it under the terms of the GNU Lesser General Public                                    //
8
// License as published by the Free Software Foundation; either                                  //
9
// version 2.1 of the License, or (at your option) any later version.                            //
10 d333eb6b Leszek Koltunski
//                                                                                               //
11 3a54358a Leszek Koltunski
// This library is distributed in the hope that it will be useful,                               //
12 d333eb6b Leszek Koltunski
// but WITHOUT ANY WARRANTY; without even the implied warranty of                                //
13 3a54358a Leszek Koltunski
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU                             //
14
// Lesser General Public License for more details.                                               //
15 d333eb6b Leszek Koltunski
//                                                                                               //
16 3a54358a Leszek Koltunski
// You should have received a copy of the GNU Lesser General Public                              //
17
// License along with this library; if not, write to the Free Software                           //
18
// Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA                //
19 d333eb6b Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
20
21 e458a4ba Leszek Koltunski
package org.distorted.library.message;
22 6a06a912 Leszek Koltunski
23
///////////////////////////////////////////////////////////////////////////////////////////////////
24 e458a4ba Leszek Koltunski
25 20dbec0e Leszek Koltunski
import org.distorted.library.effect.Effect;
26 fe82a979 Leszek Koltunski
27 6a06a912 Leszek Koltunski
/**
28 20dbec0e Leszek Koltunski
 * This interface lets users of the DistortedLibrary library get notified when a given effect finishes.
29
 * To receive the notifications, we first have to register with a call to {@link Effect#notifyWhenFinished(EffectListener)}.
30 6a06a912 Leszek Koltunski
 */
31
32
public interface EffectListener 
33
  {
34
/**
35 20dbec0e Leszek Koltunski
 * Gets called when Effect 'effectID' finishes execution (i.e. the Dynamic inside it reaches its final point).
36 6a06a912 Leszek Koltunski
 * 
37 20dbec0e Leszek Koltunski
 * @param effectID ID of the finished effect, as returned by {@link org.distorted.library.effect.Effect#getID() }
38 6a06a912 Leszek Koltunski
 */
39
   
40 20dbec0e Leszek Koltunski
  void effectFinished(final long effectID);
41 6a06a912 Leszek Koltunski
  }
42
43
///////////////////////////////////////////////////////////////////////////////////////////////////