Package com.kraken.api.query.groundobject

Class GroundObjectQuery

java.lang.Object

com.kraken.api.core.AbstractQuery<GroundObjectEntity,GroundObjectQuery,GroundItem>

com.kraken.api.query.groundobject.GroundObjectQuery

public class GroundObjectQuery
extends AbstractQuery<GroundObjectEntity,GroundObjectQuery,GroundItem>

Field Summary

Fields inherited from class com.kraken.api.core.AbstractQuery

ctx

Constructor Summary

Constructors

Constructor	Description
GroundObjectQuery(Context ctx)

Method Summary

Modifier and Type	Method	Description
GroundObjectQuery	at(net.runelite.api.coords.WorldPoint point)	Filters by exact WorldPoint.
GroundObjectQuery	highAlchemyPriceAbove(int value)	Filters for ground items where the high alchemy price is above a specific threshold.
GroundObjectEntity	nearest()	Sorts the stream of ground objects to order them by manhattan distance to the local player.
GroundObjectQuery	reachable()	Filters for only ground items which are reachable from the players current tile.
GroundObjectQuery	sortByDistance()	Sorts the ground object stream by distance from the local players' current location.
protected java.util.function.Supplier<java.util.stream.Stream<GroundObjectEntity>>	source()
GroundObjectQuery	stackValueAbove(int value)	Filters for ground items where the Grand Exchange price is above a specific threshold.
GroundObjectQuery	valueAbove(int value)	Filters for ground items where the Grand Exchange price is above a specific threshold.
GroundObjectQuery	within(int distance)	Filters for only objects whose location is within the specified distance from the players current local point.
GroundObjectQuery	within(net.runelite.api.coords.WorldPoint anchor, int distance)	Filters for only objects whose location is within the specified distance from the anchor point.

Methods inherited from class com.kraken.api.core.AbstractQuery

count, distinct, except, filter, first, list, map, nameContains, random, result, reverse, shuffle, sorted, stream, take, toRuneLite, withId, withName

Methods inherited from class java.lang.Object

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

Constructor Detail

GroundObjectQuery

public GroundObjectQuery(Context ctx)

Method Detail

source

protected java.util.function.Supplier<java.util.stream.Stream<GroundObjectEntity>> source()

Specified by:

source in class AbstractQuery<GroundObjectEntity,GroundObjectQuery,GroundItem>

within

public GroundObjectQuery within(net.runelite.api.coords.WorldPoint anchor,
                                int distance)

Filters for only objects whose location is within the specified distance from the anchor point.

Parameters:

anchor - The anchor local point.

distance - The maximum distance from the anchor point (in local units).

Returns:

True if the object is within the specified distance from the anchor point, false otherwise.

valueAbove

public GroundObjectQuery valueAbove(int value)

Filters for ground items where the Grand Exchange price is above a specific threshold. Stacks of items are NOT considered with this method. Use stackValueAbove() to consider stacks of items.

Parameters:

value - The value threshold for the items.

Returns:

GroundObjectQuery

stackValueAbove

public GroundObjectQuery stackValueAbove(int value)

Filters for ground items where the Grand Exchange price is above a specific threshold. Stacks of items are taken into consideration when using this method.

Parameters:

value - The value threshold for the items.

Returns:

GroundObjectQuery

highAlchemyPriceAbove

public GroundObjectQuery highAlchemyPriceAbove(int value)

Filters for ground items where the high alchemy price is above a specific threshold.

Parameters:

value - The value threshold for the ground items

Returns:

GroundObjectQuery

nearest

public GroundObjectEntity nearest()

Sorts the stream of ground objects to order them by manhattan distance to the local player.

Returns:

GroundObjectQuery

sortByDistance

public GroundObjectQuery sortByDistance()

Sorts the ground object stream by distance from the local players' current location.

Returns:

GroundObjectQuery

within

public GroundObjectQuery within(int distance)

Filters for only objects whose location is within the specified distance from the players current local point.

Parameters:

distance - The maximum distance from the anchor point (in world units).

Returns:

True if the object is within the specified distance from the anchor point, false otherwise.

at

public GroundObjectQuery at(net.runelite.api.coords.WorldPoint point)

Filters by exact WorldPoint.

Parameters:

point - The world point at which to find ground objects on

Returns:

GroundObjectQuery

reachable

public GroundObjectQuery reachable()

Filters for only ground items which are reachable from the players current tile.

Returns:

GroundObjectQuery