Package rs.kreme.ksbot.api.queries

Class WidgetQuery

java.lang.Object

rs.kreme.ksbot.api.queries.Query<KSWidget,WidgetQuery>

rs.kreme.ksbot.api.queries.WidgetQuery

public class WidgetQuery
extends Query<KSWidget,WidgetQuery>

A query class for filtering and retrieving KSWidget objects based on various criteria.

Field Summary

Fields inherited from class rs.kreme.ksbot.api.queries.Query

ctx

Constructor Summary

Constructors

Constructor	Description
WidgetQuery(java.util.Collection<KSWidget> widgets)	Constructs a WidgetQuery with the specified collection of widgets.

Method Summary

Modifier and Type	Method	Description
WidgetQuery	filterUnique()	Filters widgets to include only unique ones based on their item ID.
WidgetQuery	hidden()	Filters for hidden widgets.
WidgetQuery	inGroup(int group)	Filters widgets by their group.
WidgetQuery	qtyAbove(int value)	Filters widgets with quantity above a specified value.
WidgetQuery	qtyBelow(int value)	Filters widgets with quantity below a specified value.
WidgetQuery	visible()	Filters for visible widgets.
WidgetQuery	withIndex(int index)	Filters widgets by a specific index.
WidgetQuery	withoutIndex(int index)	Filters out widgets by a specific index.
WidgetQuery	withoutPackedId(int id)	Filters out widgets by their packed ID.
WidgetQuery	withoutSprite(int sprite)	Filters out widgets by their sprite ID.
WidgetQuery	withoutText(java.lang.String text)	Filters out widgets by their text content using wildcard matching.
WidgetQuery	withPackedId(int id)	Filters widgets by their packed ID.
WidgetQuery	withParentId(int parent)	Filters widgets by their parent ID.
WidgetQuery	withSprite(int sprite)	Filters widgets by their sprite ID.
WidgetQuery	withText(java.lang.String text)	Filters widgets by their text content using wildcard matching.

Methods inherited from class rs.kreme.ksbot.api.queries.Query

count, empty, exists, filter, first, first, last, list, list, max, min, omit, omit, omit, random, shuffledList, shuffledList, sorted, stream, unique, withId, withName, withNameOrId, withOption, withoutId, withoutName, withoutNameOrId, withoutOption

Methods inherited from class java.lang.Object

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

Constructor Detail

WidgetQuery

public WidgetQuery(java.util.Collection<KSWidget> widgets)

Constructs a WidgetQuery with the specified collection of widgets.

Parameters:

widgets - the collection of widgets to query.

Method Detail

withIndex

public WidgetQuery withIndex(int index)

Filters widgets by a specific index.

Parameters:

index - the index to filter by.

Returns:

This WidgetQuery instance.

withoutIndex

public WidgetQuery withoutIndex(int index)

Filters out widgets by a specific index.

Parameters:

index - the index to exclude.

Returns:

This WidgetQuery instance.

withParentId

public WidgetQuery withParentId(int parent)

Filters widgets by their parent ID.

Parameters:

parent - the parent ID to filter by.

Returns:

This WidgetQuery instance.

withPackedId

public WidgetQuery withPackedId(int id)

Filters widgets by their packed ID.

Parameters:

id - the packed ID to filter by.

Returns:

This WidgetQuery instance.

withoutPackedId

public WidgetQuery withoutPackedId(int id)

Filters out widgets by their packed ID.

Parameters:

id - the packed ID to exclude.

Returns:

This WidgetQuery instance.

withText

public WidgetQuery withText(java.lang.String text)

Filters widgets by their text content using wildcard matching.

Parameters:

text - the text to match.

Returns:

This WidgetQuery instance.

withoutText

public WidgetQuery withoutText(java.lang.String text)

Filters out widgets by their text content using wildcard matching.

Parameters:

text - the text to exclude.

Returns:

This WidgetQuery instance.

hidden

public WidgetQuery hidden()

Filters for hidden widgets.

Returns:

This WidgetQuery instance.

visible

public WidgetQuery visible()

Filters for visible widgets.

Returns:

This WidgetQuery instance.

withSprite

public WidgetQuery withSprite(int sprite)

Filters widgets by their sprite ID.

Parameters:

sprite - the sprite ID to filter by.

Returns:

This WidgetQuery instance.

withoutSprite

public WidgetQuery withoutSprite(int sprite)

Filters out widgets by their sprite ID.

Parameters:

sprite - the sprite ID to exclude.

Returns:

This WidgetQuery instance.

inGroup

public WidgetQuery inGroup(int group)

Filters widgets by their group.

Parameters:

group - the group ID to filter by.

Returns:

This WidgetQuery instance.

filterUnique

public WidgetQuery filterUnique()

Filters widgets to include only unique ones based on their item ID.

Returns:

This WidgetQuery instance.

qtyAbove

public WidgetQuery qtyAbove(int value)

Filters widgets with quantity above a specified value.

Parameters:

value - the minimum quantity.

Returns:

This WidgetQuery instance.

qtyBelow

public WidgetQuery qtyBelow(int value)

Filters widgets with quantity below a specified value.

Parameters:

value - the maximum quantity.

Returns:

This WidgetQuery instance.