Module net.botwithus.rs3

Package net.botwithus.rs3.game.queries.builders.components

Class ComponentQuery

java.lang.Object

net.botwithus.rs3.game.queries.builders.components.ComponentQuery

All Implemented Interfaces:

BiPredicate<MemoryLayoutPREVIEW,MemorySegmentPREVIEW>, QueryBuilderPREVIEW

public final class ComponentQuery
extends Object
implements QueryBuilderPREVIEW

ComponentQuery relies on preview features of the Java platform:

• ComponentQuery refers to one or more preview APIs: MemoryLayout, MemorySegment.

Programs can only use ComponentQuery when preview features are enabled.

Preview features may be removed in a future release, or upgraded to permanent features of the Java platform.

Field Summary

Fields inherited from interface net.botwithus.rs3.game.queries.builders.QueryBuilder^PREVIEW

DEFAULT

Constructor Summary

Constructors

Constructor	Description
ComponentQuery(int... interfaceIds)

Method Summary

Modifier and Type	Method	Description
ComponentQuery	alpha(int alpha)
@NotNull ComponentQuery	and(@NotNull BiPredicate<? super MemoryLayoutPREVIEW,? super MemorySegmentPREVIEW> other)
ComponentQuery	componentIndex(int... indices)
ComponentQuery	font(int fontId)
int[]	getInterfaceIds()
ComponentQuery	hasDefaultOption()	Filters component if they have default option, eg close, select etc
ComponentQuery	hidden(boolean hidden)
ComponentQuery	item(int itemId)
ComponentQuery	item(int itemId, int amount)
ComponentQuery	itemAmount(int min, int max)
ComponentQuery	itemCategory(int category)
ComponentQuery	itemName(String name)
ComponentQuery	itemName(String name, BiFunction<String,CharSequence,Boolean> spred)
ComponentQuery	itemName(Pattern... namePatterns)
ComponentQuery	itemName(Pattern[] names, Predicate<Matcher> pred)
<T extends QueryBuilderPREVIEW> T	mark()
@NotNull ComponentQuery	negate()
static ComponentQuery	newQuery(int... interfaceIds)
ComponentQuery	option(String option)
ComponentQuery	option(String option, BiFunction<String,CharSequence,Boolean> spred)
@NotNull BiPredicate<MemoryLayoutPREVIEW,MemorySegmentPREVIEW>	or(@NotNull BiPredicate<? super MemoryLayoutPREVIEW,? super MemorySegmentPREVIEW> other)
ComponentQuery	param(int id)
ComponentQuery	parent(int componentId)
ComponentQuery	reset()
ResultSet<Component>	results()
static ResultSet<Component>	select(int interfaceId, int... parents)	Selects all components from the given interface.
static Optional<Component>	selectInteractableFrom(Component comp)	Tries to select an component that is interactable from the given component.
ComponentQuery	spriteId(int alpha)
ComponentQuery	subComponentIndex(int... subComps)
boolean	test(MemoryLayoutPREVIEW memoryLayout, MemorySegmentPREVIEW segment)
ComponentQuery	text(String text)
ComponentQuery	text(String text, BiFunction<String,CharSequence,Boolean> spred)
ComponentQuery	textColor(int color)
ComponentQuery	type(int... ids)
<T> ComponentQuery	withOptionMapper(Function<Integer,T> mapper)	Sets the option mapper for this ComponentQuery.
ComponentQuery	withSubComponentMapper(Function<Integer,Integer> mapper)

Methods inherited from class java.lang.Object

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

Constructor Details

ComponentQuery

public ComponentQuery(int... interfaceIds)

Method Details

withOptionMapper

public <T> ComponentQuery withOptionMapper(Function<Integer,T> mapper)

Sets the option mapper for this ComponentQuery.

Type Parameters:

T - the type of the option mapper

Parameters:

mapper - the option mapper to set

Returns:

this ComponentQuery

withSubComponentMapper

public ComponentQuery withSubComponentMapper(Function<Integer,Integer> mapper)

componentIndex

public ComponentQuery componentIndex(int... indices)

subComponentIndex

public ComponentQuery subComponentIndex(int... subComps)

type

public ComponentQuery type(int... ids)

option

public ComponentQuery option(String option)

option

public ComponentQuery option(String option,
 BiFunction<String,CharSequence,Boolean> spred)

text

public ComponentQuery text(String text,
 BiFunction<String,CharSequence,Boolean> spred)

text

public ComponentQuery text(String text)

font

public ComponentQuery font(int fontId)

textColor

public ComponentQuery textColor(int color)

alpha

public ComponentQuery alpha(int alpha)

spriteId

public ComponentQuery spriteId(int alpha)

itemName

public ComponentQuery itemName(String name)

itemName

public ComponentQuery itemName(String name,
 BiFunction<String,CharSequence,Boolean> spred)

itemName

public ComponentQuery itemName(Pattern... namePatterns)

itemName

public ComponentQuery itemName(Pattern[] names,
 Predicate<Matcher> pred)

item

public ComponentQuery item(int itemId,
 int amount)

itemAmount

public ComponentQuery itemAmount(int min,
 int max)

itemCategory

public ComponentQuery itemCategory(int category)

parent

public ComponentQuery parent(int componentId)

hasDefaultOption

public ComponentQuery hasDefaultOption()

Filters component if they have default option, eg close, select etc

Returns:

The ComponentQuery

hidden

public ComponentQuery hidden(boolean hidden)

param

public ComponentQuery param(int id)

item

public ComponentQuery item(int itemId)

getInterfaceIds

public int[] getInterfaceIds()

test

public boolean test(MemoryLayoutPREVIEW memoryLayout,
 MemorySegmentPREVIEW segment)

Specified by:

test in interface BiPredicate<MemoryLayoutPREVIEW,MemorySegmentPREVIEW>

and

@NotNull
public @NotNull ComponentQuery and(@NotNull
 @NotNull BiPredicate<? super MemoryLayoutPREVIEW,? super MemorySegmentPREVIEW> other)

Specified by:

and in interface BiPredicate<MemoryLayoutPREVIEW,MemorySegmentPREVIEW>

negate

@NotNull
public @NotNull ComponentQuery negate()

Specified by:

negate in interface BiPredicate<MemoryLayoutPREVIEW,MemorySegmentPREVIEW>

or

@NotNull
public @NotNull BiPredicate<MemoryLayoutPREVIEW,MemorySegmentPREVIEW> or(@NotNull
 @NotNull BiPredicate<? super MemoryLayoutPREVIEW,? super MemorySegmentPREVIEW> other)

Specified by:

or in interface BiPredicate<MemoryLayoutPREVIEW,MemorySegmentPREVIEW>

reset

public ComponentQuery reset()

Specified by:

reset in interface QueryBuilderPREVIEW

newQuery

public static ComponentQuery newQuery(int... interfaceIds)

select

public static ResultSet<Component> select(int interfaceId,
 int... parents)

Selects all components from the given interface.

Parameters:

interfaceId - the interface id to select components from

parents - the parent component ids to select components from

Returns:

a ResultSet of Components

selectInteractableFrom

public static Optional<Component> selectInteractableFrom(Component comp)

Tries to select an component that is interactable from the given component.

Parameters:

comp - the component to select from

Returns:

an Optional of the interactable component

results

public ResultSet<Component> results()

mark

public <T extends QueryBuilderPREVIEW> T mark()

Specified by:

mark in interface QueryBuilderPREVIEW