Project

General

Profile

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

library / src / main / java / org / distorted / library / message / EffectListener.java @ c38f3d33

1 d333eb6b Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
2
// Copyright 2016 Leszek Koltunski                                                               //
3
//                                                                                               //
4 46b572b5 Leszek Koltunski
// This file is part of Distorted.                                                               //
5 d333eb6b Leszek Koltunski
//                                                                                               //
6 46b572b5 Leszek Koltunski
// Distorted is free software: you can redistribute it and/or modify                             //
7 d333eb6b Leszek Koltunski
// it under the terms of the GNU General Public License as published by                          //
8
// the Free Software Foundation, either version 2 of the License, or                             //
9
// (at your option) any later version.                                                           //
10
//                                                                                               //
11 46b572b5 Leszek Koltunski
// Distorted 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
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the                                 //
14
// GNU General Public License for more details.                                                  //
15
//                                                                                               //
16
// You should have received a copy of the GNU General Public License                             //
17 46b572b5 Leszek Koltunski
// along with Distorted.  If not, see <http://www.gnu.org/licenses/>.                            //
18 d333eb6b Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
19
20 e458a4ba Leszek Koltunski
package org.distorted.library.message;
21 6a06a912 Leszek Koltunski
22
///////////////////////////////////////////////////////////////////////////////////////////////////
23 e458a4ba Leszek Koltunski
24 20dbec0e Leszek Koltunski
import org.distorted.library.effect.Effect;
25 fe82a979 Leszek Koltunski
26 6a06a912 Leszek Koltunski
/**
27 20dbec0e Leszek Koltunski
 * This interface lets users of the DistortedLibrary library get notified when a given effect finishes.
28
 * To receive the notifications, we first have to register with a call to {@link Effect#notifyWhenFinished(EffectListener)}.
29 6a06a912 Leszek Koltunski
 */
30
31
public interface EffectListener 
32
  {
33
/**
34 20dbec0e Leszek Koltunski
 * Gets called when Effect 'effectID' finishes execution (i.e. the Dynamic inside it reaches its final point).
35 6a06a912 Leszek Koltunski
 * 
36 20dbec0e Leszek Koltunski
 * @param effectID ID of the finished effect, as returned by {@link org.distorted.library.effect.Effect#getID() }
37 6a06a912 Leszek Koltunski
 */
38
   
39 20dbec0e Leszek Koltunski
  void effectFinished(final long effectID);
40 6a06a912 Leszek Koltunski
  }
41
42
///////////////////////////////////////////////////////////////////////////////////////////////////