script-sdk/org.tribot.script.sdk.query/WorldQuery

WorldQuery

open class WorldQuery : StreamBackedQuery<World, WorldQuery>

A query to search over all available game worlds

Functions

activityContains

open fun activityContains(activity: Array<String>): WorldQuery

Only matches worlds whose activity contains one of the specified activities

activityEquals

open fun activityEquals(activity: Array<String>): WorldQuery

Only matches worlds whose activity equals one of the specified activities

activityNotContains

open fun activityNotContains(activity: Array<String>): WorldQuery

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

activityNotEquals

open fun activityNotEquals(activity: Array<String>): WorldQuery

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

asQueryType

protected fun asQueryType(): QueryType

bank

open fun bank(): BankQuery

Creates a new BankQuery

count

open fun count(): Int

Executes this query and gets the number of results

createSourceStream

protected open fun createSourceStream(): Stream<World>

equipment

open fun equipment(): EquipmentQuery

Creates a new EquipmentQuery

filter

open fun filter(filter: Predicate<EntityType>): QueryType

Applies the specified filter to this query.

findFirst

open fun findFirst(): Optional<EntityType>

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

findRandom

open fun findRandom(): Optional<EntityType>

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

forEach

open fun forEach(consumer: Consumer<EntityType>)

Executes this query and passes each result to the specified consumer

gameObjects

open fun gameObjects(): GameObjectQuery

Creates a new GameObjectQuery

grandExchangeOffers

open fun grandExchangeOffers(): GrandExchangeOfferQuery

Creates a new GrandExchangeOfferQuery

graphicObjects

open fun graphicObjects(): GraphicObjectQuery

Creates a new GraphicObjectQuery

groundItems

open fun groundItems(): GroundItemQuery

Creates a new GroundItemQuery

hostAddressContains

open fun hostAddressContains(address: Array<String>): WorldQuery

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

hostAddressEquals

open fun hostAddressEquals(address: Array<String>): WorldQuery

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

hostAddressNotContains

open fun hostAddressNotContains(address: Array<String>): WorldQuery

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

hostAddressNotEquals

open fun hostAddressNotEquals(address: Array<String>): WorldQuery

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

inventory

open fun inventory(): InventoryQuery

Creates a new InventoryQuery

isAny

open fun isAny(): Boolean

Executes this query and checks if any result exists

isDangerous

open fun isDangerous(): WorldQuery

Only match worlds that are dangerous

isLowPing

open fun isLowPing(): WorldQuery

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

isMainGame

open fun isMainGame(): WorldQuery

Only match worlds that are the main game

isMembers

open fun isMembers(): WorldQuery

Only matches worlds that are members worlds

isNonMembers

open fun isNonMembers(): WorldQuery

Only matches worlds that are non members worlds

isNotAllTypes

open fun isNotAllTypes(types: Array<World.Type>): WorldQuery

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

isNotAnyType

open fun isNotAnyType(types: Array<World.Type>): WorldQuery

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

isNotCurrentWorld

open fun isNotCurrentWorld(): WorldQuery

Only match worlds that are not the current world

isNotDangerous

open fun isNotDangerous(): WorldQuery

Only match worlds that are not dangerous

isNotMainGame

open fun isNotMainGame(): WorldQuery

Only match worlds that are not the main game

isRequirementsMet

open fun isRequirementsMet(): WorldQuery

Only match worlds where the requirements to enter are met

isRequirementsNotMet

open fun isRequirementsNotMet(): WorldQuery

Only match worlds where the requirements to enter are not met

isType

open fun isType(types: Array<World.Type>): WorldQuery

Only match worlds that contain all of the specified types

isTypesAny

open fun isTypesAny(types: Array<World.Type>): WorldQuery

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

isTypesExactly

open fun isTypesExactly(types: Array<World.Type>): WorldQuery

Only match worlds that contain exactly the specified types

isTypesNotExactly

open fun isTypesNotExactly(types: Array<World.Type>): WorldQuery

Only match worlds that do not contain exactly the specified types

itemDefinitions

open fun itemDefinitions(): ItemDefinitionQuery

Creates a new ItemDefinitionQuery

locationEquals

open fun locationEquals(location: Array<World.Location>): WorldQuery

Only match worlds with one of the specified locations

locationNotEquals

open fun locationNotEquals(location: Array<World.Location>): WorldQuery

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

maxPing

open fun maxPing(max: Int): WorldQuery

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

maxPlayerCount

open fun maxPlayerCount(max: Int): WorldQuery

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

maxTotalLevelRequirement

open fun maxTotalLevelRequirement(max: Int): WorldQuery

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

maxWorldNumber

open fun maxWorldNumber(max: Int): WorldQuery

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

minPing

open fun minPing(min: Int): WorldQuery

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

minPlayerCount

open fun minPlayerCount(min: Int): WorldQuery

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

minTotalLevelRequirement

open fun minTotalLevelRequirement(min: Int): WorldQuery

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

minWorldNumber

open fun minWorldNumber(min: Int): WorldQuery

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

npcs

open fun npcs(): NpcQuery

Creates a new NpcQuery

players

open fun players(): PlayerQuery

Creates a new PlayerQuery

projectiles

open fun projectiles(): ProjectileQuery

Creates a new ProjectileQuery

shop

open fun shop(): ShopItemQuery

Creates a new ShopItemQuery

sorted

open fun sorted(comparator: Comparator<EntityType>): QueryType

Orders the query by the specified comparator.

stream

open fun stream(): Stream<EntityType>

Returns this query as a stream.

tiles

open fun tiles(): TileQuery

Creates a new TileQuery

toList

open fun toList(): List<EntityType>

Executes this query, and gets the results

trade

open fun trade(): TradeQuery

Creates a new TradeQuery

widgets

open fun widgets(): WidgetQuery

Creates a new WidgetQuery

worldNumberEquals

open fun worldNumberEquals(worldNumber: Array<Int>): WorldQuery

Only matches worlds with the specified world number

worldNumberNotEquals

open fun worldNumberNotEquals(worldNumber: Array<Int>): WorldQuery

Only matches worlds that do not have the specified world number

worlds

open fun worlds(): WorldQuery

Creates a new WorldQuery

WorldQuery

See also

Functions