Reaction

public interface Reaction

Represents an interactive reaction that can be triggered.

A Reaction may include a visual representation (texture), an optional sound, particle effect, and a set of trigger words that activate it.

Instances of Reaction are created using the builder(String, String) method.

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static interface

Reaction.Builder<T extends Reaction.Builder<T>>

Builder for creating Reaction instances.
Method Summary

Modifier and Type

Method

Description

static Reaction.Builder<?>

builder(@NotNull String name, @NotNull String texture)

Creates a new Reaction.Builder for constructing a Reaction.

@NotNull String

name()

Returns the unique name of this reaction.

@Nullable String

particle()

Returns the optional particle effect associated with this reaction.

@Nullable Sound

sound()

Returns the optional sound associated with this reaction.

@NotNull String

texture()

Returns the texture associated with this reaction.

@NotNull List<String>

triggerWords()

Returns the list of words that trigger this reaction.

Method Details
- builder
  
  static Reaction.Builder<?> builder(@NotNull @NotNull String name, @NotNull @NotNull String texture)
  
  Creates a new Reaction.Builder for constructing a Reaction.
  
  Parameters:
  
  name - the unique name of the reaction
  
  texture - the texture or visual representation of the reaction
  
  Returns:
  
  a new reaction builder
- name
  
  @NotNull @NotNull String name()
  
  Returns the unique name of this reaction.
  
  Returns:
  
  the reaction name
- texture
  
  @NotNull @NotNull String texture()
  
  Returns the texture associated with this reaction.
  
  Returns:
  
  the texture string
- sound
  
  @Nullable @Nullable Sound sound()
  
  Returns the optional sound associated with this reaction.
  
  Returns:
  
  the Sound, or null if none
- particle
  
  @Nullable @Nullable String particle()
  
  Returns the optional particle effect associated with this reaction.
  
  Returns:
  
  the particle effect name, or null if none
- triggerWords
  
  @NotNull @NotNull List<String> triggerWords()
  
  Returns the list of words that trigger this reaction.
  
  Returns:
  
  a list of trigger words