Package com.runemate.game.api.hybrid.local.hud.interfaces

Class Inventory

  • public final class Inventory
extends java.lang.Object

    • Field Detail

      • EQUIP_ACTIONS

        public static final java.util.regex.Pattern EQUIP_ACTIONS

    • Method Detail

      • contains

        public static boolean contains​(java.util.function.Predicate<SpriteItem> filter)
        Checks if any items match the given filter
        Parameters:
        filter - the predicate to check the items against
        Returns:
        true if an item matches the filter

      • contains

        public static boolean contains​(int id)
        Checks if any items match the given id
        Parameters:
        id - the id to check the items against
        Returns:
        true if an item matches the id

      • contains

        public static boolean contains​(java.lang.String name)
        Checks if any items match the given name
        Parameters:
        name - the name to check the items against
        Returns:
        true if an item matches the name

      • contains

        public static boolean contains​(java.util.regex.Pattern name)
        Checks if any items match the given name
        Parameters:
        name - the name to check the items against
        Returns:
        true if an item matches the name

      • containsAllOf

        public static boolean containsAllOf​(java.util.function.Predicate<SpriteItem> predicate)
        Checks if the supplied filter matches at least one item
        Parameters:
        predicate - the predicate to check the items against
        Returns:
        true if the predicate matches an item

      • containsAllOf

        @SafeVarargs
public static boolean containsAllOf​(java.util.function.Predicate<SpriteItem>... filters)
        Checks if all of the supplied filters match at least one item each
        Parameters:
        filters - the predicates to check the items against
        Returns:
        true if all of the predicates have a match

      • containsAllOf

        public static boolean containsAllOf​(int... ids)
        Checks if all of the supplied ids match at least one item each
        Parameters:
        ids - the ids to check the items against
        Returns:
        true if all of the ids have a match

      • containsAllOf

        public static boolean containsAllOf​(java.lang.String... names)
        Checks if all of the supplied names match at least one item each
        Parameters:
        names - the names to check the items against
        Returns:
        true if all of the names have a match

      • containsAllOf

        public static boolean containsAllOf​(java.util.regex.Pattern... names)
        Checks if all of the supplied names match at least one item each
        Parameters:
        names - the names to check the items against
        Returns:
        true if all of the names have a match

      • containsAnyExcept

        public static boolean containsAnyExcept​(java.util.function.Predicate<SpriteItem> filter)
        Checks if any items don't match the given filter
        Parameters:
        filter - the predicate to check the items against
        Returns:
        true if at least one item doesn't match the filter

      • containsAnyExcept

        @SafeVarargs
public static boolean containsAnyExcept​(java.util.function.Predicate<SpriteItem>... filters)
        Checks if any items don't match the given filters
        Parameters:
        filters - the predicates to check the items against
        Returns:
        true if at least one item doesn't match the filters

      • containsAnyExcept

        public static boolean containsAnyExcept​(int... ids)
        Checks if any items don't match the given ids
        Parameters:
        ids - the ids to check the items against
        Returns:
        true if at least one item doesn't match the ids

      • containsAnyExcept

        public static boolean containsAnyExcept​(java.lang.String... names)
        Checks if any items don't match the given names
        Parameters:
        names - the names to check the items against
        Returns:
        true if at least one item doesn't match the names

      • containsAnyExcept

        public static boolean containsAnyExcept​(java.util.regex.Pattern... names)
        Checks if any items don't match the given names
        Parameters:
        names - the names to check the items against
        Returns:
        true if at least one item doesn't match the names

      • containsAnyOf

        public static boolean containsAnyOf​(java.util.function.Predicate<SpriteItem> filter)
        Checks if any item matches the given filter
        Parameters:
        filter - the filter to check the items against
        Returns:
        true if at least one item matches the filter

      • containsAnyOf

        @SafeVarargs
public static boolean containsAnyOf​(java.util.function.Predicate<SpriteItem>... filters)
        Checks if any item matches the given filters
        Parameters:
        filters - the filters to check the items against
        Returns:
        true if at least one item matches a filter

      • containsAnyOf

        public static boolean containsAnyOf​(int... ids)
        Checks if any item matches the given ids
        Parameters:
        ids - the ids to check the items against
        Returns:
        true if at least one item matches an id

      • containsAnyOf

        public static boolean containsAnyOf​(java.lang.String... names)
        Checks if any item matches the given names
        Parameters:
        names - the names to check the items against
        Returns:
        true if at least one item matches a name

      • containsAnyOf

        public static boolean containsAnyOf​(java.util.regex.Pattern... names)
        Checks if any item matches the given names
        Parameters:
        names - the names to check the items against
        Returns:
        true if at least one item matches a name

      • containsAnyOf

        public static boolean containsAnyOf​(java.util.Collection<java.util.regex.Pattern> names)

      • containsOnly

        public static boolean containsOnly​(java.util.function.Predicate<SpriteItem> filter)
        Checks if all of the items match the given filter
        Parameters:
        filter - the filter to check the items against
        Returns:
        true if all items match the filter

      • containsOnly

        @SafeVarargs
public static boolean containsOnly​(java.util.function.Predicate<SpriteItem>... filters)
        Checks if all of the items match the given filters
        Parameters:
        filters - the filters to check the items against
        Returns:
        true if all items match at least one filter each

      • containsOnly

        public static boolean containsOnly​(java.lang.String... names)
        Checks if all of the items match the given names
        Parameters:
        names - the filters to check the items against
        Returns:
        true if all items match at least one name each

      • containsOnly

        public static boolean containsOnly​(java.util.regex.Pattern... names)
        Checks if all of the items match the given names
        Parameters:
        names - the filters to check the items against
        Returns:
        true if all items match at least one name each

      • getQuantity

        public static int getQuantity()
        Gets the total quantity of items
        Returns:
        the total quantity of items

      • getQuantity

        public static int getQuantity​(java.util.function.Predicate<SpriteItem> filter)
        Gets the total quantity of items matching the filter
        Parameters:
        filter - the filter to check the items against
        Returns:
        the total quantity of items matching the filter

      • getQuantity

        @SafeVarargs
public static int getQuantity​(java.util.function.Predicate<SpriteItem>... filters)
        Gets the total quantity of items matching the filters
        Parameters:
        filters - the filters to check the items against
        Returns:
        the total quantity of items matching the filters

      • getQuantity

        public static int getQuantity​(int... ids)
        Gets the total quantity of items matching the ids
        Parameters:
        ids - the ids to check the items against
        Returns:
        the total quantity of items matching the ids

      • getQuantity

        public static int getQuantity​(java.lang.String... names)
        Gets the total quantity of items matching the names
        Parameters:
        names - the ids to check the items against
        Returns:
        the total quantity of items matching the names

      • getQuantity

        public static int getQuantity​(java.util.regex.Pattern... names)
        Gets the total quantity of items matching the names
        Parameters:
        names - the ids to check the items against
        Returns:
        the total quantity of items matching the names

      • equip

        public static boolean equip​(SpriteItem item)

      • equip

        public static boolean equip​(SpriteItem... items)

      • getActionPredicate

        @Deprecated
public static java.util.function.Predicate<SpriteItem> getActionPredicate​(java.lang.String... acceptedActions)
        Deprecated.
        use Items.getInventoryActionPredicate(String...)
        Gets a SpriteItem filter that can be used to get the items with the specified inventory actions
        Parameters:
        acceptedActions - the powers that are valid (case-sensitive)
        Returns:
        a filter

      • getActionPredicate

        @Deprecated
public static java.util.function.Predicate<SpriteItem> getActionPredicate​(java.util.regex.Pattern... acceptedActions)
        Deprecated.
        use Items.getIdPredicate(int...)

      • getEmptySlots

        public static int getEmptySlots()

      • getItemIn

        @Nullable
public static @Nullable SpriteItem getItemIn​(int slot)

      • getItems

        public static SpriteItemQueryResults getItems()
        Returns a list of all the items in your inventory (Does not require opening the tab)
        Returns:
        a list of all the items in your inventory

      • isItemSelected

        public static boolean isItemSelected()
        Technically relates to a selected item OR spell.

      • getSelectedItem

        @Nullable
public static @Nullable SpriteItem getSelectedItem()

      • getUsedSlots

        public static int getUsedSlots()

      • isEmpty

        public static boolean isEmpty()

      • isFull

        public static boolean isFull()