WorldQuery

public class WorldQuery extends StreamBackedQuery<World, WorldQuery>

A query to search over all available game worlds

Functions

activityContains

WorldQuery activityContains(Array<String> activity)

Only matches worlds whose activity contains one of the specified activities

activityEquals

WorldQuery activityEquals(Array<String> activity)

Only matches worlds whose activity equals one of the specified activities

activityNotContains

WorldQuery activityNotContains(Array<String> activity)

Only matches worlds whose activity does not contain one of the specified activities

activityNotEquals

WorldQuery activityNotEquals(Array<String> activity)

Only matches worlds whose activity does not equal one of the specified activities

bank

static BankQuery bank()

Creates a new BankQuery

count

int count()

Executes this query and gets the number of results

equipment

static EquipmentQuery equipment()

Creates a new EquipmentQuery

filter

QueryType filter(Predicate<EntityType> filter)

Applies the specified filter to this query.

findFirst

Optional<EntityType> findFirst()

Executes this query, and gets the first result if it exists

findRandom

Optional<EntityType> findRandom()

Executes this query, and selects a random result based on a uniform distribution

forEach

void forEach(Consumer<EntityType> consumer)

Executes this query and passes each result to the specified consumer

gameObjects

static GameObjectQuery gameObjects()

Creates a new GameObjectQuery

grandExchangeOffers

static GrandExchangeOfferQuery grandExchangeOffers()

Creates a new GrandExchangeOfferQuery

graphicObjects

static GraphicObjectQuery graphicObjects()

Creates a new GraphicObjectQuery

groundItems

static GroundItemQuery groundItems()

Creates a new GroundItemQuery

hostAddressContains

WorldQuery hostAddressContains(Array<String> address)

Only matches worlds whose host address contains one of the specified addresses

hostAddressEquals

WorldQuery hostAddressEquals(Array<String> address)

Only matches worlds whose host address equals one of the specified addresses

hostAddressNotContains

WorldQuery hostAddressNotContains(Array<String> address)

Only matches worlds whose host address does not contain one of the specified addresses

hostAddressNotEquals

WorldQuery hostAddressNotEquals(Array<String> address)

Only matches worlds whose host address does not equal one of the specified addresses

inventory

static InventoryQuery inventory()

Creates a new InventoryQuery

isAny

boolean isAny()

Executes this query and checks if any result exists

isDangerous

WorldQuery isDangerous()

Only match worlds that are dangerous

isLowPing

WorldQuery isLowPing()

Only accept worlds that have 'low' ping relative to other worlds

isMainGame

WorldQuery isMainGame()

Only match worlds that are the main game

isMembers

WorldQuery isMembers()

Only matches worlds that are members worlds

isNonMembers

WorldQuery isNonMembers()

Only matches worlds that are non members worlds

isNotAllTypes

WorldQuery isNotAllTypes(Array<World.Type> types)

Only matches worlds that do not contain all of the specified types

isNotAnyType

WorldQuery isNotAnyType(Array<World.Type> types)

Only matches worlds that do not contain any of the specified types

isNotCurrentWorld

WorldQuery isNotCurrentWorld()

Only match worlds that are not the current world

isNotDangerous

WorldQuery isNotDangerous()

Only match worlds that are not dangerous

isNotMainGame

WorldQuery isNotMainGame()

Only match worlds that are not the main game

isRequirementsMet

WorldQuery isRequirementsMet()

Only match worlds where the requirements to enter are met

isRequirementsNotMet

WorldQuery isRequirementsNotMet()

Only match worlds where the requirements to enter are not met

isType

WorldQuery isType(Array<World.Type> types)

Only match worlds that contain all of the specified types

isTypesAny

WorldQuery isTypesAny(Array<World.Type> types)

Only match worlds that contain any of the specified types param types the world types

isTypesExactly

WorldQuery isTypesExactly(Array<World.Type> types)

Only match worlds that contain exactly the specified types

isTypesNotExactly

WorldQuery isTypesNotExactly(Array<World.Type> types)

Only match worlds that do not contain exactly the specified types

itemDefinitions

static ItemDefinitionQuery itemDefinitions()

Creates a new ItemDefinitionQuery

locationEquals

WorldQuery locationEquals(Array<World.Location> location)

Only match worlds with one of the specified locations

locationNotEquals

WorldQuery locationNotEquals(Array<World.Location> location)

Only match worlds that do not have one of the specified locations

maxPing

WorldQuery maxPing(int max)

Only match worlds whose ping is less than or equal to the max ping

maxPlayerCount

WorldQuery maxPlayerCount(int max)

Only matches worlds whose player count is less than or equal to the max player count

maxTotalLevelRequirement

WorldQuery maxTotalLevelRequirement(int max)

Only match worlds whose total level requirement is at most the specified max threshold

maxWorldNumber

WorldQuery maxWorldNumber(int max)

Only matches worlds whose world number is less than or equal to the max world number

minPing

WorldQuery minPing(int min)

Only match worlds whose ping is greater than or equal to the min ping

minPlayerCount

WorldQuery minPlayerCount(int min)

Only matches worlds whose player count is greater than or equal to the min player count

minTotalLevelRequirement

WorldQuery minTotalLevelRequirement(int min)

Only match worlds whose total level requirement is at least the specified min threshold

minWorldNumber

WorldQuery minWorldNumber(int min)

Only matches worlds whose world number is greater than or equal to the min world number

npcs

static NpcQuery npcs()

Creates a new NpcQuery

players

static PlayerQuery players()

Creates a new PlayerQuery

projectiles

static ProjectileQuery projectiles()

Creates a new ProjectileQuery

shop

static ShopItemQuery shop()

Creates a new ShopItemQuery

sorted

QueryType sorted(Comparator<EntityType> comparator)

Orders the query by the specified comparator.

stream

Stream<EntityType> stream()

Returns this query as a stream.

tiles

static TileQuery tiles()

Creates a new TileQuery

toList

List<EntityType> toList()

Executes this query, and gets the results

trade

static TradeQuery trade()

Creates a new TradeQuery

widgets

static WidgetQuery widgets()

Creates a new WidgetQuery

worldNumberEquals

WorldQuery worldNumberEquals(Array<int> worldNumber)

Only matches worlds with the specified world number

worldNumberNotEquals

WorldQuery worldNumberNotEquals(Array<int> worldNumber)

Only matches worlds that do not have the specified world number

worlds

static WorldQuery worlds()

Creates a new WorldQuery

WorldQuery

See also

Functions