Package live.crowdcontrol.cc4j.websocket.payload

Class CCEffectDescription

java.lang.Object

live.crowdcontrol.cc4j.websocket.payload.CCBaseEffectDescription

live.crowdcontrol.cc4j.websocket.payload.CCEffectDescription

public class CCEffectDescription
extends CCBaseEffectDescription

Describes the metadata of an effect.

Field Summary

Fields

Modifier and Type	Field	Description
protected final @NotNull String	effectID
protected final @NotNull String	type

Fields inherited from class live.crowdcontrol.cc4j.websocket.payload.CCBaseEffectDescription

admin, category, description, disabled, duration, group, hidden, image, inactive, isNew, name, note, tags, unavailable

Constructor Summary

Constructors

Constructor

Description

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

Method Summary

Modifier and Type	Method	Description
@NotNull String	getEffectId()	The unique ID of the effect.
@NotNull String	getType()	Gets the type of the effect.
String	toString()

Methods inherited from class live.crowdcontrol.cc4j.websocket.payload.CCBaseEffectDescription

getCategories, getDescription, getDuration, getDurationMillis, getGroups, getImage, getName, getNote, getTags, isAdminOnly, isDisabled, isHidden, isInactive, isNew, isUnavailable

Methods inherited from class java.lang.Object

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

Field Details

effectID

@NotNull
protected final @NotNull String effectID

type

@NotNull
protected final @NotNull String type

Constructor Details

CCEffectDescription

public CCEffectDescription(@NotNull
 @NotNull String effectID,
 @NotNull
 @NotNull String type,
 @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

getEffectId

@NotNull
public @NotNull String getEffectId()

The unique ID of the effect.

Returns:

effectID

getType

@NotNull
public @NotNull String getType()

Gets the type of the effect. Typically game.

Returns:

effect type

toString

public String toString()

Overrides:

toString in class CCBaseEffectDescription