Interface Selector
public interface Selector
Allows for the selection of
entities
in a world based on given
criteria.-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic interface
Creates aSelector
based on the provided criteria.static interface
-
Method Summary
Modifier and TypeMethodDescriptionstatic Selector.Builder
builder()
Provides aSelector.Builder
to build aSelector
.int
limit()
Gets the maximum number of entities that this selector can select.static Selector
Attempts to parse the given string into a selector.boolean
select
(CommandCause cause) Select entities based on the criteria of this selector and a givenCommandCause
Select entities based on the criteria of this selector and a givenEntity
select
(ServerLocation location) Select entities based on the criteria of this selector and a givenServerLocation
-
Method Details
-
parse
Attempts to parse the given string into a selector. It must start with an @ symbol.- Parameters:
string
- The string to parse- Returns:
- The
Selector
- Throws:
IllegalArgumentException
- if the string could not be parsed.
-
builder
Provides aSelector.Builder
to build aSelector
.If you wish to create a selector based on a provided string, use
parse(String)
instead.- Returns:
- The builder
-
select
Select entities based on the criteria of this selector and a givenServerLocation
- Parameters:
location
- TheServerLocation
- Returns:
- A
Collection
of selectedentities
- Throws:
IllegalStateException
- if this selector cannot select based on aServerLocation
-
select
Select entities based on the criteria of this selector and a givenEntity
- Parameters:
entity
- TheEntity
- Returns:
- A
Collection
of selectedentities
- Throws:
IllegalStateException
- if this selector cannot select based on aEntity
-
select
Select entities based on the criteria of this selector and a givenCommandCause
- Parameters:
cause
- TheCommandCause
- Returns:
- A
Collection
of selectedentities
-
limit
int limit()Gets the maximum number of entities that this selector can select.- Returns:
- The limit
-
playersOnly
boolean playersOnly()- Returns:
- Whether this selector will only select players
-