Record Class SpecificEntityRidingPlaybackArea

java.lang.Object
java.lang.Record
de.mrjulsen.dragnsounds.api.playback.SpecificEntityRidingPlaybackArea
All Implemented Interfaces:
IPlaybackArea

public record SpecificEntityRidingPlaybackArea(net.minecraft.world.entity.Entity vehicle) extends Record implements IPlaybackArea
This implementation of IPlaybackArea checks if the player is riding a specific entity. If you want to use any instance of an entity, but not a specific one, you should use EntityTypeRidingPlaybackArea instead.
See Also:
  • Constructor Summary

    Constructors
    Constructor
    Description
    SpecificEntityRidingPlaybackArea(net.minecraft.world.entity.Entity vehicle)
    Creates an instance of a SpecificEntityRidingPlaybackArea record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canPlayForPlayer(net.minecraft.world.level.Level level, net.minecraft.world.entity.player.Player player)
    Check if the player matches the criteria.
    final boolean
    Indicates whether some other object is "equal to" this one.
    final int
    Returns a hash code value for this object.
    final String
    Returns a string representation of this record class.
    net.minecraft.world.entity.Entity
    Returns the value of the vehicle record component.

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait
  • Constructor Details

    • SpecificEntityRidingPlaybackArea

      public SpecificEntityRidingPlaybackArea(net.minecraft.world.entity.Entity vehicle)
      Creates an instance of a SpecificEntityRidingPlaybackArea record class.
      Parameters:
      vehicle - the value for the vehicle record component
  • Method Details

    • canPlayForPlayer

      public boolean canPlayForPlayer(net.minecraft.world.level.Level level, net.minecraft.world.entity.player.Player player)
      Description copied from interface: IPlaybackArea
      Check if the player matches the criteria.
      Specified by:
      canPlayForPlayer in interface IPlaybackArea
      Parameters:
      level - The current world level.
      player - The player to check.
      Returns:
      true if the player matches the given criteria, false otherwise.
    • 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.
    • vehicle

      public net.minecraft.world.entity.Entity vehicle()
      Returns the value of the vehicle record component.
      Returns:
      the value of the vehicle record component