Project

General

Profile

« Previous | Next » 

Revision cacc63de

Added by Leszek Koltunski over 7 years ago

Fix Lint warnings, correct a lot of comments, adjust EffectListener interface.

View differences:

src/main/java/org/distorted/library/message/EffectListener.java
25 25 

  		




  26
  26
  
    
/**


  		




  27
  27
  
    
 * This interface lets users of the Distorted library get notified when something happens to one of the effects.


  		




  28
  
  
    
 * To receive the notifications, we first have to register with a call to {@link org.distorted.library.DistortedObject#addEventListener(EffectListener)}.


  		




  
  28
  
    
 * To receive the notifications, we first have to register with a call to {@link org.distorted.library.DistortedEffects#registerForMessages(EffectListener)}.


  		




  29
  29
  
    
 * List of all possible events that can happen is defined in {@link EffectMessage}


  		




  30
  30
  
    
 */


  		




  31
  31
  
    

  		




  ......




  36
  36
  
    
 * 


  		




  37
  37
  
    
 * @param eventType  Type of event that happened.


  		




  38
  38
  
    
 * @param effectID   ID of the effect the event happened to. This ID must have been previously returned by one


  		




  39
  
  
    
 *                   of the DistortedObject.{deform,distort,move,...} functions.


  		




  
  39
  
    
 *                   of the DistortedEffects.{deform,distort,move,...} functions.


  		




  40
  40
  
    
 * @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
  
  
    
 *                   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
  
  
    
 * @param message    Any message string associated with it. 'Failed' event types have one.


  		




  
  41
  
    
 * @param objectID   the ID of the DistortedEffects object, as returned by {@link org.distorted.library.DistortedEffects#getID()},


  		




  
  42
  
    
 *                   this event happened to.


  		




  45
  43
  
    
 * @see EffectMessage


  		




  46
  44
  
    
 * @see EffectNames


  		




  47
  45
  
    
 */


  		




  48
  46
  
    
   


  		




  49
  
  
    
  void effectMessage(final EffectMessage eventType, final long effectID, final EffectNames effectName, final long objectID, final String message);


  		




  
  47
  
    
  void effectMessage(final EffectMessage eventType, final long effectID, final EffectNames effectName, final long objectID);


  		




  50
  48
  
    
  }


  		




  51
  49
  
    

  		




  52
  50
  
    
///////////////////////////////////////////////////////////////////////////////////////////////////


  		












Also available in:  Unified diff