Package com.github.tommyettinger.textra.effects

Class SlipEffect

java.lang.Object

com.github.tommyettinger.textra.Effect

com.github.tommyettinger.textra.effects.SlipEffect

public class SlipEffect
extends Effect

Adds a small value to each glyph's x-offset, each one independently and randomly based on the current time.
Parameters: distance;speed;duration
The distance determines how far a glyph can be offset from its original position, in viewport units; defaults to 5. The speed affects how fast the glyphs should change position; defaults to 1.0 . The duration is how many seconds the effect should repeat, or _ to repeat forever; defaults to positive infinity.
Example usage: {SLIP=5;0.8;_}Each glyph here will slip a lot, but slowly, and will do so forever.{ENDSLIP} {SLIP=0.25;4;5}Each glyph here will slip a little, but quickly, for 5 seconds total.{ENDSLIP}

Nested Class Summary

Nested classes/interfaces inherited from class com.github.tommyettinger.textra.Effect

Effect.EffectBuilder

Field Summary

Fields inherited from class com.github.tommyettinger.textra.Effect

duration, indexEnd, indexStart, label, name, totalTime

Constructor Summary

Constructors

Constructor	Description
SlipEffect(TypingLabel label, String[] params)

Method Summary

Modifier and Type	Method	Description
protected void	onApply(long glyph, int localIndex, int globalIndex, float delta)	Called when this effect should be applied to the given glyph.

Methods inherited from class com.github.tommyettinger.textra.Effect

apply, assignTokenName, calculateFadeout, calculateProgress, calculateProgress, calculateProgress, isFinished, paramAsBoolean, paramAsColor, paramAsFloat, update

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SlipEffect

public SlipEffect(TypingLabel label,
 String[] params)

Method Details

onApply

protected void onApply(long glyph,
 int localIndex,
 int globalIndex,
 float delta)

Description copied from class: Effect

Called when this effect should be applied to the given glyph.

Specified by:

onApply in class Effect