Package net.ixdarklord.folios.api.client

Class FoliosReveals

java.lang.Object
net.ixdarklord.folios.api.client.FoliosReveals
public final class FoliosReveals extends Object
The reveal effects books can use (FoliosReveal), by id. CoolCatLib's own:
  • folios:rise, the default: each part fades in as it rises a few pixels into place, from the top of the page down
  • folios:fade: everything fades in together
  • folios:ink: the page fills in from top to bottom like ink soaking down it, with a soft edge
  • folios:sweep: the page fills in from its spine edge outwards
  • folios:scatter: parts drift in from a little way off, each from its own side, settling as they fade in
  • folios:burn: each thing on the page is burnt into it in turn, down the page and along each line: it flares white-hot, burns orange with flames licking up off it, chars and settles into its own colour, with sparks and smoke rising off what burns
  • folios:runes: each part first shows as glowing runes that flicker and settle into its own words, while runes drift up the page and a shimmer of light crosses it
  • none: shown at once

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final net.minecraft.resources.ResourceLocation
    BURN
     
    static final FoliosReveal.Use
    DEFAULT
    The reveal a book has when book.json doesn't say.
    static final float
    DEFAULT_SECONDS
    How long an effect takes when book.json names it without a length.
    static final net.minecraft.resources.ResourceLocation
    FADE
     
    static final net.minecraft.resources.ResourceLocation
    INK
     
    static final net.minecraft.resources.ResourceLocation
    NONE
     
    static final net.minecraft.resources.ResourceLocation
    RISE
     
    static final net.minecraft.resources.ResourceLocation
    RUNES
     
    static final net.minecraft.resources.ResourceLocation
    SCATTER
     
    static final net.minecraft.resources.ResourceLocation
    SWEEP
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static @Nullable FoliosReveal
    get(net.minecraft.resources.ResourceLocation id)
    The effect with that id; null when there is none.
    static void
    register(net.minecraft.resources.ResourceLocation id, FoliosReveal effect)
    Adds an effect, or replaces the one with that id.

    Methods inherited from class java.lang.Object

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

  • Field Details

    • NONE

      public static final net.minecraft.resources.ResourceLocation NONE

    • RISE

      public static final net.minecraft.resources.ResourceLocation RISE

    • FADE

      public static final net.minecraft.resources.ResourceLocation FADE

    • INK

      public static final net.minecraft.resources.ResourceLocation INK

    • SWEEP

      public static final net.minecraft.resources.ResourceLocation SWEEP

    • SCATTER

      public static final net.minecraft.resources.ResourceLocation SCATTER

    • BURN

      public static final net.minecraft.resources.ResourceLocation BURN

    • RUNES

      public static final net.minecraft.resources.ResourceLocation RUNES

    • DEFAULT

      public static final FoliosReveal.Use DEFAULT
      The reveal a book has when book.json doesn't say.

    • DEFAULT_SECONDS

      public static final float DEFAULT_SECONDS
      How long an effect takes when book.json names it without a length.
      See Also:

  • Method Details

    • register

      public static void register(net.minecraft.resources.ResourceLocation id, FoliosReveal effect)
      Adds an effect, or replaces the one with that id. Safe to call while mods load.

    • get

      @Nullable public static @Nullable FoliosReveal get(net.minecraft.resources.ResourceLocation id)
      The effect with that id; null when there is none.