Package net.neoforged.neoforge.transfer.item

Class VanillaContainerWrapper

java.lang.Object
net.neoforged.neoforge.transfer.item.VanillaContainerWrapper
All Implemented Interfaces:
ResourceHandler<ItemResource>
Direct Known Subclasses:
PlayerInventoryWrapper
public class VanillaContainerWrapper extends Object implements ResourceHandler<ItemResource>
An implementation of ResourceHandler<ItemResource> for vanilla's Container.

Important note: This wrapper assumes that the container owns its slots. If the container does not own its slots, for example because it delegates to another container, this wrapper should not be used!

See Also:

  • Field Details

    • wrappers

      private static final Map<Container,VanillaContainerWrapper> wrappers
      Global wrapper concurrent map.

      Note on thread-safety: we assume that Containers are inherently single-threaded, and no attempt is made at synchronization. However, the access to implementations can happen on multiple threads concurrently, which is why we use a thread-safe wrapper map.

      We use weak keys and values to avoid keeping a strong reference to the Container until the next time the map is cleaned. As long as a slot wrapper is used, there is a strong reference to the outer VanillaContainerWrapper class, which also references the container. This ensures that the entries remain in the map at least as long as the wrappers are in use.

      Note that MapMaker.weakKeys() makes the map use identity semantics for the keys, which is desirable here.

    • container

      private final Container container

    • size

      int size

    • slotWrappers

      final List<VanillaContainerWrapper.SlotWrapper> slotWrappers

    • setChangedJournal

      private final RootCommitJournal setChangedJournal

  • Constructor Details

    • VanillaContainerWrapper

      VanillaContainerWrapper(Container container)

  • Method Details

    • of

      public static ResourceHandler<ItemResource> of(Container container)
      Wraps a vanilla container into a ResourceHandler of ItemResources.

      If the container is a player Inventory, use PlayerInventoryWrapper instead which adds convenience methods for players.

      If the container is a WorldlyContainer, use WorldlyContainerWrapper instead which checks the extra methods of worldy containers.

    • internalOf

      static VanillaContainerWrapper internalOf(Container container)

    • resize

      void resize()

    • getSlotWrapper

      VanillaContainerWrapper.SlotWrapper getSlotWrapper(int index)

    • onRootCommit

      void onRootCommit()

    • size

      public int size()
      Description copied from interface: ResourceHandler
      Returns the current number of indices in this resource handler.

      This size provides a bound on the valid indices for this handler, see the documentation of ResourceHandler.

      Specified by:
      size in interface ResourceHandler<ItemResource>
      Returns:
      The size of the resource handler. Can be 0 if the handler currently has no indices.

    • insert

      public int insert(int index, ItemResource resource, int amount, TransactionContext transaction)
      Description copied from interface: ResourceHandler
      Inserts up to the given amount of a resource into the handler at the given index.

      Changes to the handler are made in the context of a transaction.

      Specified by:
      insert in interface ResourceHandler<ItemResource>
      Parameters:
      index - The index to insert the resource into.
      resource - The resource to insert. Must be non-empty.
      amount - The maximum amount of the resource to insert. Must be non-negative.
      transaction - The transaction that this operation is part of.
      Returns:
      The amount that was inserted. Between 0 (inclusive, nothing was inserted) and amount (inclusive, everything was inserted).
      See Also:

    • extract

      public int extract(int index, ItemResource resource, int amount, TransactionContext transaction)
      Description copied from interface: ResourceHandler
      Extracts up to the given amount of a resource from the handler at the given index.

      Changes to the handler are made in the context of a transaction.

      Specified by:
      extract in interface ResourceHandler<ItemResource>
      Parameters:
      index - The index to extract the resource from.
      resource - The resource to extract. Must be non-empty.
      amount - The maximum amount of the resource to extract. Must be non-negative.
      transaction - The transaction that this operation is part of.
      Returns:
      The amount that was extracted. Between 0 (inclusive, nothing was extracted) and amount (inclusive, everything was extracted).
      See Also:

    • getResource

      public ItemResource getResource(int index)
      Description copied from interface: ResourceHandler
      Returns the resource at the given index, which may be empty.

      If the resource is empty, the stored amount must be 0.

      Specified by:
      getResource in interface ResourceHandler<ItemResource>
      Parameters:
      index - The index to get the resource from.
      Returns:
      the resource at the given index, which may be empty

    • getAmountAsLong

      public long getAmountAsLong(int index)
      Description copied from interface: ResourceHandler
      Returns the amount of the currently stored resource at the given index, as a long.

      In general, resource handlers can report long amounts. However, if the handler is known to only support amounts up to Integer.MAX_VALUE, or if the caller prefers to deal in ints only, the int-returning overload can be used instead.

      The returned amount must be non-negative. If the stored resource is empty, the amount must be 0.

      Specified by:
      getAmountAsLong in interface ResourceHandler<ItemResource>
      Parameters:
      index - The index to get the amount from.
      Returns:
      the amount at the given index, as a long
      See Also:

    • getCapacityAsLong

      public long getCapacityAsLong(int index, ItemResource resource)
      Description copied from interface: ResourceHandler
      Returns the capacity of the handler at the given index and for the given resource, irrespective of the current amount or resource currently at that index, as a long.

      In general, resource handlers can report long capacities. However, if the handler is known to only support capacities up to Integer.MAX_VALUE, or if the caller prefers to deal in ints only, the int-returning overload can be used instead.

      This function serves as a hint on the maximum amount the resource handler might contain, for example the handler can be considered full if amount >= capacity. Note that the returned capacity may overestimate the actual allowed amount, and it might be smaller than the current amount. The only way to know if a handler will accept a resource, is to try to insert it.

      Specified by:
      getCapacityAsLong in interface ResourceHandler<ItemResource>
      Parameters:
      index - The index to get the capacity for.
      resource - The resource to get the capacity for. May be empty to get the general capacity at the index.
      Returns:
      the capacity at the given index, as a long
      See Also:

    • isValid

      public boolean isValid(int index, ItemResource resource)
      Description copied from interface: ResourceHandler
      Returns whether the given resource is generally allowed to be contained at the given index, irrespective of the current amount or resource currently at that index.

      This function serves as a hint on whether the resource handler can contain the resource or not. The only way to know if a handler will accept a resource, is to try to insert it.

      Specified by:
      isValid in interface ResourceHandler<ItemResource>
      Parameters:
      index - The index to check.
      resource - The resource to check. Must be non-empty.
      Returns:
      whether the given resource is generally allowed to be contained at the given index, irrespective of the current amount or resource currently at that index

    • toString

      public String toString()
      Overrides:
      toString in class Object