Package org.spongepowered.api.command.selector

Interface Selector

public interface Selector

Allows for the selection of entities in a world based on given criteria.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Selector.Builder	Creates a Selector based on the provided criteria.
static interface	Selector.Factory

Method Summary

Modifier and Type	Method	Description
static Selector.Builder	builder()	Provides a Selector.Builder to build a Selector.
int	limit()	Gets the maximum number of entities that this selector can select.
static Selector	parse(java.lang.String string)	Attempts to parse the given string into a selector.
boolean	playersOnly()	Gets whether this selector will only select players, or if it will select any Entity.
java.util.Collection<Entity>	select(CommandCause cause)	Select entities based on the criteria of this selector and a given CommandCause
java.util.Collection<Entity>	select(Entity entity)	Select entities based on the criteria of this selector and a given Entity
java.util.Collection<Entity>	select(ServerLocation location)	Select entities based on the criteria of this selector and a given ServerLocation

Method Detail

parse

static Selector parse(java.lang.String string)
               throws java.lang.IllegalArgumentException

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:

java.lang.IllegalArgumentException - if the string could not be parsed.

builder

static Selector.Builder builder()

Provides a Selector.Builder to build a Selector.

If you wish to create a selector based on a provided string, use parse(String) instead.

Returns:

The builder

select

java.util.Collection<Entity> select(ServerLocation location)
                             throws java.lang.IllegalStateException

Select entities based on the criteria of this selector and a given ServerLocation

Parameters:

location - The ServerLocation

Returns:

A Collection of selected entities

Throws:

java.lang.IllegalStateException - if this selector cannot select based on a ServerLocation

select

java.util.Collection<Entity> select(Entity entity)
                             throws java.lang.IllegalStateException

Select entities based on the criteria of this selector and a given Entity

Parameters:

entity - The Entity

Returns:

A Collection of selected entities

Throws:

java.lang.IllegalStateException - if this selector cannot select based on a Entity

select

java.util.Collection<Entity> select(CommandCause cause)

Select entities based on the criteria of this selector and a given CommandCause

Parameters:

cause - The CommandCause

Returns:

A Collection of selected entities

limit

int limit()

Gets the maximum number of entities that this selector can select.

Returns:

The limit

playersOnly

boolean playersOnly()

Gets whether this selector will only select players, or if it will select any Entity.

Returns:

Whether this selector will only select players