Package live.crowdcontrol.cc4j.websocket.payload

Class CCBaseEffectDescription

java.lang.Object
live.crowdcontrol.cc4j.websocket.payload.CCBaseEffectDescription
Direct Known Subclasses:
CCEffectDescription
public class CCBaseEffectDescription extends Object
Describes the metadata of an effect.

  • Field Details

    • name

      @NotNull protected final @NotNull CCName name

    • image

      @Nullable protected final @Nullable String image

    • note

      @Nullable protected final @Nullable String note

    • description

      @Nullable protected final @Nullable String description

    • disabled

      protected final boolean disabled

    • isNew

      protected final boolean isNew

    • inactive

      protected final boolean inactive

    • admin

      protected final boolean admin

    • hidden

      protected final boolean hidden

    • unavailable

      protected final boolean unavailable

    • category

      @Nullable protected final @Nullable List<@NotNull String> category

    • group

      @Nullable protected final @Nullable List<@NotNull String> group

    • tags

      @Nullable protected final @Nullable List<@NotNull String> tags

    • duration

      @Nullable protected final @Nullable CustomEffectDuration duration

  • Constructor Details

    • CCBaseEffectDescription

      public CCBaseEffectDescription(@NotNull @NotNull CCName name, @Nullable @Nullable String image, @Nullable @Nullable String note, @Nullable @Nullable String description, boolean disabled, boolean isNew, boolean inactive, boolean admin, boolean hidden, boolean unavailable, @Nullable @Nullable List<String> category, @Nullable @Nullable List<String> group, @Nullable @Nullable List<String> tags, @Nullable @Nullable CustomEffectDuration duration)

  • Method Details

    • getName

      @NotNull public @NotNull CCName getName()
      Gets the display name of the effect.
      Returns:
      display name
      See Also:

    • getImage

      @Nullable public @Nullable String getImage()
      Gets the filename of the image. The full image URL is determined using: https://resources.crowdcontrol.live/images/{GAME_ID}/{GAME_PACK_ID}/icons/{EFFECT_IMAGE ?? EFFECT_ID}.png
      Returns:
      image filename override

    • getNote

      @Nullable public @Nullable String getNote()
      Gets the note to be displayed next to the effect name.
      Returns:
      clarifying note

    • getDescription

      @Nullable public @Nullable String getDescription()
      Gets the description of the effect. It describes what is expected to happen.
      Returns:
      effect description

    • isDisabled

      public boolean isDisabled()
      Whether the effect has been temporarily removed by Crowd Control staff due to instability.
      Returns:
      is disabled

    • isNew

      public boolean isNew()
      Whether the effect has been added in a recent update.
      Returns:
      is new

    • isInactive

      public boolean isInactive()
      Whether the effect has been hidden by the streamer.
      Returns:
      is inactive

    • isAdminOnly

      public boolean isAdminOnly()
      Whether the effect is hidden from viewers, only allowing it to be used by streamers. Typically used for repairing broken game states.
      Returns:
      is admin-only

    • isHidden

      public boolean isHidden()
      Whether the effect is currently hidden by the game.
      Returns:
      is hidden

    • isUnavailable

      public boolean isUnavailable()
      Whether the effect is currently available for purchase, as dictated by the game.
      Returns:
      is unavailable

    • getCategories

      @Nullable public @Nullable List<String> getCategories()
      Gets the effect's categories. These are displayed to the viewer and streamer and used to narrow down their list of visible effects.
      Returns:
      groups

    • getGroups

      @Nullable public @Nullable List<String> getGroups()
      Gets the effect's groups. Groups are used to connect effects together so the pack can change multiple effects at once. This is used for hiding effects or making multiple effects unavailable at once.
      Returns:
      groups

    • getTags

      @Deprecated @Nullable public @Nullable List<@NotNull String> getTags()
      Deprecated.
      Unused.
      Returns:
      tags

    • getDuration

      @Nullable public @Nullable CustomEffectDuration getDuration()
      The duration of the effect in seconds. null if non-timed.
      Returns:
      duration obj

    • getDurationMillis

      public long getDurationMillis()

    • toString

      public String toString()
      Overrides:
      toString in class Object