Project

General

Profile

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

library / src / main / java / org / distorted / library / message / EffectListener.java @ 7602a827

1 d333eb6b Leszek Koltunski
///////////////////////////////////////////////////////////////////////////////////////////////////
2
// Copyright 2016 Leszek Koltunski                                                               //
3
//                                                                                               //
4 7602a827 Leszek Koltunski
// This file is part of DistortedLibrary.                                                               //
5 d333eb6b Leszek Koltunski
//                                                                                               //
6 7602a827 Leszek Koltunski
// DistortedLibrary 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 7602a827 Leszek Koltunski
// DistortedLibrary 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 7602a827 Leszek Koltunski
// along with DistortedLibrary.  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 fe82a979 Leszek Koltunski
import org.distorted.library.main.DistortedEffects;
25
26 6a06a912 Leszek Koltunski
/**
27 7602a827 Leszek Koltunski
 * This interface lets users of the DistortedLibrary library get notified when something happens to one of the effects.
28 fe82a979 Leszek Koltunski
 * To receive the notifications, we first have to register with a call to {@link DistortedEffects#registerForMessages(EffectListener)}.
29 6a06a912 Leszek Koltunski
 * List of all possible events that can happen is defined in {@link EffectMessage}
30
 */
31
32
public interface EffectListener 
33
  {
34
/**
35 6613266b Leszek Koltunski
 * Gets called when event of type 'eventType' happens to effect 'effectID'.
36 6a06a912 Leszek Koltunski
 * 
37 c6e1c219 Leszek Koltunski
 * @param eventType  Type of event that happened.
38 15aa7d94 Leszek Koltunski
 * @param effectID   ID of the effect the event happened to, as returned by {@link org.distorted.library.effect.Effect#getID() }
39
 * @param objectID   the ID of the DistortedEffects object, as returned by {@link org.distorted.library.main.DistortedEffects#getID()},
40 cacc63de Leszek Koltunski
 *                   this event happened to.
41 6a06a912 Leszek Koltunski
 * @see EffectMessage
42
 */
43
   
44 15aa7d94 Leszek Koltunski
  void effectMessage(final EffectMessage eventType, final long effectID, final long objectID);
45 6a06a912 Leszek Koltunski
  }
46
47
///////////////////////////////////////////////////////////////////////////////////////////////////