1 |
d333eb6b
|
Leszek Koltunski
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
2 |
|
|
// Copyright 2016 Leszek Koltunski //
|
3 |
|
|
// //
|
4 |
|
|
// This file is part of Distorted. //
|
5 |
|
|
// //
|
6 |
|
|
// Distorted is free software: you can redistribute it and/or modify //
|
7 |
|
|
// 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 |
|
|
// Distorted is distributed in the hope that it will be useful, //
|
12 |
|
|
// 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 |
|
|
// along with Distorted. If not, see <http://www.gnu.org/licenses/>. //
|
18 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
19 |
|
|
|
20 |
e458a4ba
|
Leszek Koltunski
|
package org.distorted.library.message;
|
21 |
6a06a912
|
Leszek Koltunski
|
|
22 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|
23 |
e458a4ba
|
Leszek Koltunski
|
|
24 |
|
|
import org.distorted.library.EffectNames;
|
25 |
|
|
|
26 |
6a06a912
|
Leszek Koltunski
|
/**
|
27 |
|
|
* This interface lets users of the Distorted library get notified when something happens to one of the effects.
|
28 |
6613266b
|
Leszek Koltunski
|
* To receive the notifications, we first have to register with a call to {@link org.distorted.library.DistortedObject#addEventListener(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 |
|
|
* @param effectID ID of the effect the event happened to. This ID must have been previously returned by one
|
39 |
6613266b
|
Leszek Koltunski
|
* of the DistortedObject.{deform,distort,move,...} functions.
|
40 |
e8c81a8e
|
Leszek Koltunski
|
* @param effectName Name of the effect as defined by EffectNames.
|
41 |
|
|
* @param objectID the ID of the DistortedObject object, as returned by {@link org.distorted.library.DistortedObject#getID()},
|
42 |
6613266b
|
Leszek Koltunski
|
* this event happened to. If the Object has been created using a copy constructor
|
43 |
|
|
* from another instance of DistortedObject, the ID here will be the one of the original object.
|
44 |
c6e1c219
|
Leszek Koltunski
|
* @param message Any message string associated with it. 'Failed' event types have one.
|
45 |
6a06a912
|
Leszek Koltunski
|
* @see EffectMessage
|
46 |
|
|
* @see EffectNames
|
47 |
|
|
*/
|
48 |
|
|
|
49 |
e8c81a8e
|
Leszek Koltunski
|
void effectMessage(final EffectMessage eventType, final long effectID, final EffectNames effectName, final long objectID, final String message);
|
50 |
6a06a912
|
Leszek Koltunski
|
}
|
51 |
|
|
|
52 |
|
|
///////////////////////////////////////////////////////////////////////////////////////////////////
|