Package codechicken.microblock.item

Record Class SawComponent

java.lang.Object
java.lang.Record
codechicken.microblock.item.SawComponent
public record SawComponent(List<SawComponent.Rule> rules, boolean defaultAllowCut) extends Record
Component to be added to saw items that can cut microblocks. Provides the logic that determines which blocks can be cut by the saw item this is attached to.

For standard Tier-based saws, use forTier(Tier)

See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final record 
    SawComponent.Rule
     

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final com.mojang.serialization.Codec<SawComponent>
    CODEC
     
    static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,SawComponent>
    STREAM_CODEC
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    SawComponent(List<SawComponent.Rule> rules, boolean defaultAllowCut)
    Creates an instance of a SawComponent record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    canCut(net.minecraft.world.level.block.state.BlockState state)
     
    boolean
    defaultAllowCut()
    Returns the value of the defaultAllowCut record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    static SawComponent
    forTier(net.minecraft.world.item.Tier tier)
    Creates a SawComponent that cuts any block at the given tier or lower.
    static @Nullable SawComponent
    getComponent(net.minecraft.world.item.ItemStack stack)
     
    final int
    hashCode()
    Returns a hash code value for this object.
    List<SawComponent.Rule>
    rules()
    Returns the value of the rules record component.
    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

  • Field Details

    • CODEC

      public static final com.mojang.serialization.Codec<SawComponent> CODEC

    • STREAM_CODEC

      public static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf,SawComponent> STREAM_CODEC

  • Constructor Details

    • SawComponent

      public SawComponent(List<SawComponent.Rule> rules, boolean defaultAllowCut)
      Creates an instance of a SawComponent record class.
      Parameters:
      rules - the value for the rules record component
      defaultAllowCut - the value for the defaultAllowCut record component

  • Method Details

    • canCut

      public boolean canCut(net.minecraft.world.level.block.state.BlockState state)

    • forTier

      public static SawComponent forTier(net.minecraft.world.item.Tier tier)
      Creates a SawComponent that cuts any block at the given tier or lower. If a tool of the given tier can harvest a block, then the saw can cut it.
      Parameters:
      tier - The tier of the saw.
      Returns:
      The saw component.

    • getComponent

      @Nullable public static @Nullable SawComponent getComponent(net.minecraft.world.item.ItemStack stack)

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.

    • rules

      public List<SawComponent.Rule> rules()
      Returns the value of the rules record component.
      Returns:
      the value of the rules record component

    • defaultAllowCut

      public boolean defaultAllowCut()
      Returns the value of the defaultAllowCut record component.
      Returns:
      the value of the defaultAllowCut record component