simple.hooks.queries

Class SimplePlayerQuery<K extends SimpleActionable & SimpleNamable & SimpleLocatable>

java.lang.Object

simple.hooks.queries.SimpleQuery<SimplePlayerQuery<K>,K>

simple.hooks.queries.SimplePlayerQuery<K>

All Implemented Interfaces:

java.lang.Iterable<K>

Direct Known Subclasses:

SimplePlayers

public abstract class SimplePlayerQuery<K extends SimpleActionable & SimpleNamable & SimpleLocatable>
extends SimpleQuery<SimplePlayerQuery<K>,K>

Method Summary

Modifier and Type	Method and Description
SimplePlayerQuery<K>	filter(java.util.regex.Pattern... patterns) Will filter out all items whose name doesn't' match any of the patterns
SimplePlayerQuery<K>	filter(SimpleLocatable... locatables) Will filter out all items whose location doesn't match any of the locatable objects in the {locatables} array
SimplePlayerQuery<K>	filter(java.lang.String... names) Will filter out all items whose name isn't one of the elements inside of the {names} array
SimplePlayerQuery<K>	filter(WorldArea area) Will filter out all items who are not inside of the specified area
SimplePlayerQuery<K>	filter(net.runelite.api.coords.WorldPoint... points) Will filter out all items whose location are not one of those inside of the array {points}
SimplePlayerQuery<K>	filterHasAction(java.util.regex.Pattern... patterns) Will filter out all items who don't have any actions that match any of the patterns
SimplePlayerQuery<K>	filterHasAction(java.lang.String... actions) Will filter out all items who don't have any actions that are inside of the {actions} array
SimplePlayerQuery<K>	filterWithin(int distance) Will filter out all items not within specified distance to the local player
SimplePlayerQuery<K>	filterWithin(net.runelite.api.coords.WorldPoint worldPoint, int distance) Will filter out all items not within specified distance to said {worldPoint}
SimplePlayerQuery<K>	nearest() Will sort the query by closest distance to our local player
SimplePlayerQuery<K>	nearest(SimpleLocatable locatable) Will sort the query by closest distance to the location of said {locatable} object
SimplePlayerQuery<K>	nearest(net.runelite.api.coords.WorldPoint point) Will sort the query by closest distance to the specified worldpoint {point}
K	nextNearest() Deprecated.

Methods inherited from class simple.hooks.queries.SimpleQuery

contains, filter, isEmpty, iterator, next, peekNext, populate, population, reverse, shuffle, size, sort, toStream

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

nextNearest

@Deprecated
public K nextNearest()

Deprecated.

DO NOT USE!!!! Please refrain from using this method as it sorts the query every time you call it and rather use `.nearest().next()` Will sort the query by closest distance to the local player and return the `next#` method from the query

Returns:

the closest item to our local player inside of our query

filter

public SimplePlayerQuery<K> filter(java.lang.String... names)

Will filter out all items whose name isn't one of the elements inside of the {names} array

Parameters:

names - array of names for our filter

Returns:

returns the query of only items whose name matches one of those inside of {name}

filter

public SimplePlayerQuery<K> filter(java.util.regex.Pattern... patterns)

Will filter out all items whose name doesn't' match any of the patterns

Parameters:

patterns - regex patterns for our filter to check

Returns:

returns query of only items whose name matches one of the patterns inside of {patterns}

filterHasAction

public SimplePlayerQuery<K> filterHasAction(java.lang.String... actions)

Will filter out all items who don't have any actions that are inside of the {actions} array

Parameters:

actions - array of actions for our filter

Returns:

returns the query of only items whose actions matches one of those inside of {actions}

filterHasAction

public SimplePlayerQuery<K> filterHasAction(java.util.regex.Pattern... patterns)

Will filter out all items who don't have any actions that match any of the patterns

Parameters:

patterns - regex patterns for our filter to check

Returns:

returns query of only items whose action(s) matches one of the patterns inside of {patterns}

nearest

public SimplePlayerQuery<K> nearest()

Will sort the query by closest distance to our local player

Returns:

returns a sorted query by closest distance to our local player

nearest

public SimplePlayerQuery<K> nearest(net.runelite.api.coords.WorldPoint point)

Will sort the query by closest distance to the specified worldpoint {point}

Parameters:

point - world point to sort our query by

Returns:

returns a sorted query by closest distance to {point}

nearest

public SimplePlayerQuery<K> nearest(SimpleLocatable locatable)

Will sort the query by closest distance to the location of said {locatable} object

Parameters:

locatable - locatable object to sort our query by

Returns:

returns a sorted query by closest distance to {locatable}

filter

public SimplePlayerQuery<K> filter(SimpleLocatable... locatables)

Will filter out all items whose location doesn't match any of the locatable objects in the {locatables} array

Parameters:

locatables - array of locatable objects for our filter to check

Returns:

returns query of only items whose location are one of the locatable objects location inside of {locatables}

filter

public SimplePlayerQuery<K> filter(net.runelite.api.coords.WorldPoint... points)

Will filter out all items whose location are not one of those inside of the array {points}

Parameters:

points - array of worldpoints for our filter to check

Returns:

returns query of only items whose location are one of the worldpoints inside of {points}

filter

public SimplePlayerQuery<K> filter(WorldArea area)

Will filter out all items who are not inside of the specified area

Parameters:

area - area for our filter to check

Returns:

returns query of only items inside of the specified area

filterWithin

public SimplePlayerQuery<K> filterWithin(int distance)

Will filter out all items not within specified distance to the local player

Parameters:

distance - - radius to check around player

Returns:

returns all items within specified distance to the local player

filterWithin

public SimplePlayerQuery<K> filterWithin(net.runelite.api.coords.WorldPoint worldPoint,
                                         int distance)

Will filter out all items not within specified distance to said {worldPoint}

Parameters:

distance - - radius to check around {worldPoint}

worldPoint - - point to filter around

Returns:

returns all items within specified distance to said {worldPoint}