Package com.minecolonies.core.event

Record Class ColonyStoryListener.StoryText

java.lang.Object
java.lang.Record
com.minecolonies.core.event.ColonyStoryListener.StoryText
Record Components:
biomeFilter - the filter that passes any biome where this story is valid.
content - the text content.
Enclosing class:
ColonyStoryListener
public static record ColonyStoryListener.StoryText(com.minecolonies.core.event.ColonyStoryListener.BiomeFilter biomeFilter, String content) extends Record
A bit of story text that is filterable by biome.

  • Constructor Summary

    Constructors
    Constructor
    Description
    StoryText(com.minecolonies.core.event.ColonyStoryListener.BiomeFilter biomeFilter, String content)
    Creates an instance of a StoryText record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    static List<String>
    allMatches(Collection<ColonyStoryListener.StoryText> stories, net.minecraft.core.Holder<net.minecraft.world.level.biome.Biome> biome)
    Builds a list of all possible matches from a collection of ColonyStoryListener.StoryText.
    com.minecolonies.core.event.ColonyStoryListener.BiomeFilter
    biomeFilter()
    Returns the value of the biomeFilter record component.
    String
    content()
    Returns the value of the content record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    boolean
    matches(net.minecraft.core.Holder<net.minecraft.world.level.biome.Biome> biome)
    Check if the given biome is valid for this story text.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Constructor Details

    • StoryText

      public StoryText(com.minecolonies.core.event.ColonyStoryListener.BiomeFilter biomeFilter, String content)
      Creates an instance of a StoryText record class.
      Parameters:
      biomeFilter - the value for the biomeFilter record component
      content - the value for the content record component

  • Method Details

    • matches

      public boolean matches(net.minecraft.core.Holder<net.minecraft.world.level.biome.Biome> biome)
      Check if the given biome is valid for this story text.
      Parameters:
      biome - the biome to check.
      Returns:
      true if valid.

    • allMatches

      public static List<String> allMatches(Collection<ColonyStoryListener.StoryText> stories, net.minecraft.core.Holder<net.minecraft.world.level.biome.Biome> biome)
      Builds a list of all possible matches from a collection of ColonyStoryListener.StoryText.
      Parameters:
      stories - the collection.
      biome - the biome to match against.
      Returns:
      a list of matching content.

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • biomeFilter

      public com.minecolonies.core.event.ColonyStoryListener.BiomeFilter biomeFilter()
      Returns the value of the biomeFilter record component.
      Returns:
      the value of the biomeFilter record component

    • content

      public String content()
      Returns the value of the content record component.
      Returns:
      the value of the content record component