Package me.emafire003.dev.particleanimationlib.effects

Class TextEffect.Builder

java.lang.Object
me.emafire003.dev.particleanimationlib.effects.TextEffect.Builder
Enclosing class:
TextEffect
public static final class TextEffect.Builder extends Object
TextEffect builder static inner class.

  • Field Details

    • text

      public String text
      Text to display

    • invert

      public boolean invert
      Invert the text, as in it makes it hollowed out of a rectangle background

    • stepX

      public int stepX
      Each stepX pixel will be shown. Saves packets for lower fontsizes.

    • stepY

      public int stepY
      Each stepY pixel will be shown. Saves packets for lower fontsizes.

    • size

      public float size
      Scale the font down

    • realtime

      public boolean realtime
      Set this only to true if you are working with changing text. I'd advise the parser to recalculate the BufferedImage every iteration. Recommended FALSE

    • font

      public Font font
      Font used to create the Text

  • Method Details

    • iterations

      public TextEffect.Builder iterations(int val)
      Sets the iterations and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the iterations to set
      Returns:
      a reference to this Builder

    • originPos

      public TextEffect.Builder originPos(net.minecraft.util.math.Vec3d val)
      Sets the originPos and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the originPos to set
      Returns:
      a reference to this Builder

    • updatePositions

      public TextEffect.Builder updatePositions(boolean val)
      Sets the updatePositions and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the updatePositions to set
      Returns:
      a reference to this Builder

    • useEyePosAsOrigin

      public TextEffect.Builder useEyePosAsOrigin(boolean val)
      Sets the useEyePosAsOrigin and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the useEyePosAsOrigin to set
      Returns:
      a reference to this Builder

    • entityOrigin

      public TextEffect.Builder entityOrigin(net.minecraft.entity.Entity val)
      Sets the entityOrigin and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the entityOrigin to set
      Returns:
      a reference to this Builder

    • originOffset

      public TextEffect.Builder originOffset(net.minecraft.util.math.Vec3d val)
      Sets the originOffset and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the originOffset to set
      Returns:
      a reference to this Builder

    • world

      public TextEffect.Builder world(net.minecraft.server.world.ServerWorld val)
      Sets the world and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the world to set
      Returns:
      a reference to this Builder

    • particle

      public TextEffect.Builder particle(net.minecraft.particle.ParticleEffect val)
      Sets the particle and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the particle to set
      Returns:
      a reference to this Builder

    • yawOffset

      public TextEffect.Builder yawOffset(float val)
      Sets the yawOffset and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the yawOffset to set
      Returns:
      a reference to this Builder

    • pitchOffset

      public TextEffect.Builder pitchOffset(float val)
      Sets the pitchOffset and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the pitchOffset to set
      Returns:
      a reference to this Builder

    • yaw

      public TextEffect.Builder yaw(float val)
      Sets the yaw and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the yaw to set
      Returns:
      a reference to this Builder

    • pitch

      public TextEffect.Builder pitch(float val)
      Sets the pitch and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the pitch to set
      Returns:
      a reference to this Builder

    • shouldUpdateYPR

      public TextEffect.Builder shouldUpdateYPR(boolean val)
      Sets the shouldUpdateYPR and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the shouldUpdateYPR to set
      Returns:
      a reference to this Builder

    • text

      public TextEffect.Builder text(String val)
      Sets the text and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the text to set
      Returns:
      a reference to this Builder

    • invert

      public TextEffect.Builder invert(boolean val)
      Sets the invert and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the invert to set
      Returns:
      a reference to this Builder

    • stepX

      public TextEffect.Builder stepX(int val)
      Sets the stepX and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the stepX to set
      Returns:
      a reference to this Builder

    • stepY

      public TextEffect.Builder stepY(int val)
      Sets the stepY and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the stepY to set
      Returns:
      a reference to this Builder

    • size

      public TextEffect.Builder size(float val)
      Sets the size and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the size to set
      Returns:
      a reference to this Builder

    • realtime

      public TextEffect.Builder realtime(boolean val)
      Sets the realtime and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the realtime to set
      Returns:
      a reference to this Builder

    • font

      public TextEffect.Builder font(Font val)
      Sets the font and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the font to set
      Returns:
      a reference to this Builder

    • executeOnStop

      public TextEffect.Builder executeOnStop(EffectModifier executeOnStop)
      Sets the executeOnStop and returns a reference to this Builder enabling method chaining.
      Parameters:
      executeOnStop - the executeOnStop to set
      Returns:
      a reference to this Builder

    • build

      public TextEffect build()
      Returns a TextEffect built from the parameters previously set.
      Returns:
      a TextEffect built with parameters of this TextEffect.Builder

    • shouldSpawnParticlesEveryNIteration

      public TextEffect.Builder shouldSpawnParticlesEveryNIteration(boolean val)
      Sets the shouldSpawnParticlesEveryNIteration and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the shouldSpawnParticlesEveryNIteration to set
      Returns:
      a reference to this Builder

    • spawnParticlesEveryNIteration

      public TextEffect.Builder spawnParticlesEveryNIteration(int val)
      Sets the spawnParticlesEveryNIteration and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the spawnParticlesEveryNIteration to set
      Returns:
      a reference to this Builder

    • shouldLimitParticlesSpawnedPerIteration

      public TextEffect.Builder shouldLimitParticlesSpawnedPerIteration(boolean val)
      Sets the shouldLimitParticlesSpawnedPerIteration and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the shouldLimitParticlesSpawnedPerIteration to set
      Returns:
      a reference to this Builder

    • particleLimit

      public TextEffect.Builder particleLimit(int val)
      Sets the particleLimit and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the particleLimit to set
      Returns:
      a reference to this Builder

    • shouldLimitParticlesEveryNIterations

      public TextEffect.Builder shouldLimitParticlesEveryNIterations(boolean val)
      Sets the shouldLimitParticlesEveryNIterations and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the shouldLimitParticlesEveryNIterations to set
      Returns:
      a reference to this Builder

    • limitParticlesEveryNIterations

      public TextEffect.Builder limitParticlesEveryNIterations(int val)
      Sets the limitParticlesEveryNIterations and returns a reference to this Builder enabling method chaining.
      Parameters:
      val - the limitParticlesEveryNIterations to set
      Returns:
      a reference to this Builder

    • forced

      public TextEffect.Builder forced(boolean forced)
      Sets the forced and returns a reference to this Builder enabling method chaining.
      Parameters:
      forced - the forced to set
      Returns:
      a reference to this Builder