AbstractEffect (Nostr Game Engine)

java.lang.Object

com.simsilica.lemur.effect.AbstractEffect<T>

All Implemented Interfaces:: Effect<T>

public abstract class AbstractEffect<T> extends Object implements Effect<T>

Base implementation of the Effect class that implements standard interface functionality other than the create() method.

Constructor Summary

Constructors

Modifier

Constructor

Description

protected

AbstractEffect()

Creates an effect on the 'null' channel, or undefined channel.

protected

AbstractEffect(String channel)

Creates an effect with the specified channel.
Method Summary

Modifier and Type

Method

Description

String

getChannel()

Returns the channel name that will be used for looking up existing animations for a given target.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.simsilica.lemur.effect.Effect
create

Constructor Details
- AbstractEffect
  
  protected AbstractEffect()
  
  Creates an effect on the 'null' channel, or undefined channel. Effects that are on the 'null' channel are not tracked.
- AbstractEffect
  
  protected AbstractEffect(String channel)
  
  Creates an effect with the specified channel. Effects that are on the 'null' channel are not tracked.
Method Details
- getChannel
  
  public String getChannel()
  
  Description copied from interface: Effect
  
  Returns the channel name that will be used for looking up existing animations for a given target. Effects that are on the 'null' channel are not tracked in this way. Otherwise, when the effect is run, the channel is used to provide information to the effect about any previous effects that were run. This allows the new effect to adjust its own animations accordingly, either reducing time, starting from a different point, or entirely custom behavior depending on the needs of the effect.
  
  Specified by:
  
  getChannel in interface Effect<T>