Package com.kraken.api.query.player

Class PlayerQuery

java.lang.Object

com.kraken.api.core.AbstractQuery<PlayerEntity,PlayerQuery,net.runelite.api.Player>

com.kraken.api.query.player.PlayerQuery

public class PlayerQuery
extends AbstractQuery<PlayerEntity,PlayerQuery,net.runelite.api.Player>

Field Summary

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

ctx

Constructor Summary

Constructors

Constructor	Description
PlayerQuery(Context ctx)

Method Summary

Modifier and Type	Method	Description
PlayerQuery	at(net.runelite.api.coords.WorldPoint location)	Returns a stream of Players at a given world point.
PlayerQuery	combatLevelGreaterThan(int level)	Finds players with a combat level strictly greater than the given argument
PlayerQuery	interactingWith(net.runelite.api.Actor actor)	Filters the stream for players interacting with a specified actor
LocalPlayerEntity	local()	Directly retrieves the local player wrapper.
PlayerEntity	nearest()	Finds the nearest player to the local player.
PlayerQuery	sortByDistance()	Sorts the player stream by distance from the local players current location.
protected java.util.function.Supplier<java.util.stream.Stream<PlayerEntity>>	source()
PlayerQuery	withinArea(net.runelite.api.coords.WorldPoint minimum, net.runelite.api.coords.WorldPoint max)	Filters for players within a specified area.
PlayerQuery	withinAttackableWildernessLevel()	Filters the stream for players who can attack you within the wilderness.
PlayerQuery	withinDistance(int distance)	Filters the stream for players within a specified distance from the local player.
PlayerQuery	withinLevel(int low, int high)	Filters the stream for players within a specified combat level (inclusive).

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

count, distinct, empty, 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

PlayerQuery

public PlayerQuery(Context ctx)

Method Detail

source

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

Specified by:

source in class AbstractQuery<PlayerEntity,PlayerQuery,net.runelite.api.Player>

interactingWith

public PlayerQuery interactingWith(net.runelite.api.Actor actor)

Filters the stream for players interacting with a specified actor

Parameters:

actor - The actor to check for interacting with

Returns:

PlayerQuery

at

public PlayerQuery at(net.runelite.api.coords.WorldPoint location)

Returns a stream of Players at a given world point.

Parameters:

location - The world point to check

Returns:

PlayerQuery

withinArea

public PlayerQuery withinArea(net.runelite.api.coords.WorldPoint minimum,
                              net.runelite.api.coords.WorldPoint max)

Filters for players within a specified area. The min WorldPoint should be the southwest tile of the area and the max WorldPoint should be the northeast tile of the area.

Parameters:

minimum - The southwest minimum world point of the area to check

max - The northeast maximum world point of the area to check

Returns:

NpcQuery

withinDistance

public PlayerQuery withinDistance(int distance)

Filters the stream for players within a specified distance from the local player.

Parameters:

distance - The maximum distance from the local player.

Returns:

PlayerQuery

withinLevel

public PlayerQuery withinLevel(int low,
                               int high)

Filters the stream for players within a specified combat level (inclusive).

Parameters:

low - The minimum combat level bound

high - The maximum combat level bound

Returns:

PlayerQuery

withinAttackableWildernessLevel

public PlayerQuery withinAttackableWildernessLevel()

Filters the stream for players who can attack you within the wilderness. If this is called outside the wilderness, the stream will contain no players, be warned.

Returns:

PlayerQuery

combatLevelGreaterThan

public PlayerQuery combatLevelGreaterThan(int level)

Finds players with a combat level strictly greater than the given argument

Parameters:

level - Combat level

Returns:

PlayerQuery

nearest

public PlayerEntity nearest()

Finds the nearest player to the local player.

Returns:

PlayerQuery

sortByDistance

public PlayerQuery sortByDistance()

Sorts the player stream by distance from the local players current location.

Returns:

PlayerQuery

local

public LocalPlayerEntity local()

Directly retrieves the local player wrapper. Does not use the filter list.

Returns:

PlayerEntity the LocalPlayerEntity object.