Package alexiil.mc.lib.attributes

Class CombinableAttribute<T>

java.lang.Object
alexiil.mc.lib.attributes.Attribute<T>
alexiil.mc.lib.attributes.DefaultedAttribute<T>
alexiil.mc.lib.attributes.CombinableAttribute<T>
public class CombinableAttribute<T> extends DefaultedAttribute<T>
A DefaultedAttribute that also provides a "get" method to combine every found attribute into a single one, using an AttributeCombiner.

  • Constructor Details

    • CombinableAttribute

      protected CombinableAttribute​(Class<T> clazz, @Nonnull T defaultValue, AttributeCombiner<T> combiner)

  • Method Details

    • appendBlockAdder

      public CombinableAttribute<T> appendBlockAdder​(CustomAttributeAdder<T> blockAdder)
      Description copied from class: Attribute
      Appends a single CustomAttributeAdder to the list of custom block adders. These are called only for blocks that don't implement AttributeProvider, or have an existing registration in one of the more specific methods above.
      Overrides:
      appendBlockAdder in class DefaultedAttribute<T>
      Returns:
      This.

    • appendItemAdder

      public CombinableAttribute<T> appendItemAdder​(ItemAttributeAdder<T> itemAdder)
      Description copied from class: Attribute
      Appends a single ItemAttributeAdder to the list of custom item adders. These are called only for items that don't implement AttributeProviderItem, or have an existing registration in one of the more specific methods above.
      Overrides:
      appendItemAdder in class DefaultedAttribute<T>
      Returns:
      This.

    • combine

      @Nonnull public final T combine​(List<T> list)

    • combine

      @Nonnull public final T combine​(List<T> firstList, List<T> secondList)

    • get

      @Nonnull public final T get​(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos)
      Returns:
      Either the #defaultValue defaultValue, a single instance, or a combined instance depending on how many attribute instances could be found.

    • get

      @Nonnull public final T get​(net.minecraft.world.World world, net.minecraft.util.math.BlockPos pos, SearchOption<? super T> searchParam)
      Parameters:
      searchParam - The search parameters to use for accessing instances. Many blocks only offer attributes from a certain direction, which should be provided as a SearchOptionDirectional. A full list of possible SearchOption's is in SearchOptions.
      Returns:
      Either the #defaultValue defaultValue, a single instance, or a combined instance depending on how many attribute instances could be found.

    • getFromNeighbour

      @Nonnull public final T getFromNeighbour​(net.minecraft.block.entity.BlockEntity be, net.minecraft.util.math.Direction dir)
      Shorter method call for the common case of:
      BlockEntity be = ...;
      Direction dir = ...;
      Attribute<T> attr = ...;
      AttributeList<T> list = attr.getAll(be.getWorld(), be.getPos().offset(dir), SearchOptions.inDirection(dir));

    • get

      @Nonnull public final T get​(net.minecraft.item.ItemStack unmodifiableStack)
      Obtains a combined instance of this attribute in the given ItemStack Reference, or the DefaultedAttribute.defaultValue if none were found.

      This method is just a quicker way of calling DefaultedAttribute.getFirst(Reference) of a single ItemStack which cannot be modified. Internally this creates a new UnmodifiableRef for the reference.

      Parameters:
      unmodifiableStack - An ItemStack that may not be modified by any of the attribute instances returned.
      Returns:
      The combined attribute instance found by Attribute.getAll(ItemStack), or the DefaultedAttribute.defaultValue if none were found in the given ItemStack.

    • get

      @Nonnull public final T get​(Reference<net.minecraft.item.ItemStack> stackRef)
      Obtains a combined instance of this attribute in the given ItemStack Reference, or the DefaultedAttribute.defaultValue if none were found.
      Parameters:
      stackRef - A Reference to the ItemStack to be searched. This is a full reference, which may allow any of the returned attribute instances to modify it. (For example if it was in an inventory then changes would be correctly reflected in the backing inventory).
      Returns:
      The combined attribute instance found by Attribute.getAll(Reference), or tge DefaultedAttribute.defaultValue if none were found in the given ItemStack.

    • get

      @Nonnull public final T get​(Reference<net.minecraft.item.ItemStack> stackRef, @Nullable Predicate<T> filter)
      Obtains a combined instance of this attribute in the given ItemStack Reference, or the DefaultedAttribute.defaultValue if none were found.
      Parameters:
      filter - A Predicate to test all offered objects before accepting them into the list. A null value equals no filter, which will not block any values.
      Returns:
      The combined attribute instance found by Attribute.getAll(Reference, Predicate), or the DefaultedAttribute.defaultValue if none were found in the given ItemStack.

    • get

      @Nonnull public final T get​(Reference<net.minecraft.item.ItemStack> stackRef, LimitedConsumer<net.minecraft.item.ItemStack> excess)
      Obtains a combined instance of this attribute in the given ItemStack Reference, or the DefaultedAttribute.defaultValue if none were found.
      Parameters:
      stackRef - A Reference to the ItemStack to be searched. This is a full reference, which may allow any of the returned attribute instances to modify it. (For example if it was in an inventory then changes would be correctly reflected in the backing inventory).
      excess - A LimitedConsumer which allows any of the returned attribute instances to spit out excess items in addition to changing the main stack. (As this is a LimitedConsumer rather than a normal consumer it is important to note that excess items items are not guaranteed to be accepted). A null value will default to LimitedConsumer.rejecting().
      Returns:
      The combined attribute instance found by Attribute.getAll(Reference, LimitedConsumer), or the DefaultedAttribute.defaultValue if none were found in the given ItemStack.

    • get

      @Nonnull public final T get​(Reference<net.minecraft.item.ItemStack> stackRef, LimitedConsumer<net.minecraft.item.ItemStack> excess, @Nullable Predicate<T> filter)
      Obtains a combined instance of this attribute in the given ItemStack Reference, or the DefaultedAttribute.defaultValue if none were found.
      Parameters:
      stackRef - A Reference to the ItemStack to be searched. This is a full reference, which may allow any of the returned attribute instances to modify it. (For example if it was in an inventory then changes would be correctly reflected in the backing inventory).
      excess - A LimitedConsumer which allows any of the returned attribute instances to spit out excess items in addition to changing the main stack. (As this is a LimitedConsumer rather than a normal consumer it is important to note that excess items items are not guaranteed to be accepted). A null value will default to LimitedConsumer.rejecting().
      filter - A Predicate to test all offered objects before accepting them into the list. A null value equals no filter, which will not block any values.
      Returns:
      The combined attribute instance found by Attribute.getAll(Reference, LimitedConsumer, Predicate), or the DefaultedAttribute.defaultValue if none were found in the given ItemStack.