org.spongepowered.api.text.selector

Interface Selector

public interface Selector

Represents an immutable selector of targets, as used in commands.

In Vanilla, selectors are mostly represented as plain text, starting with an @ symbol and followed by a single character signifying the type, and finally the (optional) arguments in brackets.

As an example, the all player selector is @a, and with a radius of 20 it would be @a[r=20].

See Also:

Target selectors on the Minecraft Wiki

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Selector.Builder

Method Summary

Modifier and Type	Method and Description
static Selector.Builder	builder() Creates a Selector.Builder.
static List<String>	complete(String selector) Fetch completions for a selector command argument.
<T> Optional<T>	get(ArgumentType<T> type) Returns the argument value for the specified ArgumentType in this Selector.
<T> Optional<Argument.Invertible<T>>	getArgument(ArgumentType.Invertible<T> type) Returns the Argument.Invertible for the specified ArgumentType.Invertible in this Selector.
<T> Optional<Argument<T>>	getArgument(ArgumentType<T> type) Returns the Argument for the specified ArgumentType in this Selector.
List<Argument<?>>	getArguments() Returns the arguments for this Selector.
SelectorType	getType() Returns the type of this Selector.
boolean	has(ArgumentType<?> type) Checks for the presence of type in this Selector.
boolean	isInverted(ArgumentType.Invertible<?> type) Checks for the inversion state of type in this Selector.
static Selector	parse(String selector) Parses a Selector from the given selector string.
Set<Entity>	resolve(Collection<? extends Extent> extent) Resolves this Selector to a list of entities around (0|0|0) in the given Extent(s).
Set<Entity>	resolve(CommandSource origin) Resolves this Selector to a list of entities around the origin.
Set<Entity>	resolve(Extent... extent) Resolves this Selector to a list of entities around (0|0|0) in the given Extent(s).
Set<Entity>	resolve(Location<World> location) Resolves this Selector to a list of entities around the given Location.
default Set<Entity>	resolveForce(Collection<? extends Extent> extent) Deprecated. Use resolve(Collection)
default Set<Entity>	resolveForce(CommandSource origin) Deprecated. Use resolve(CommandSource)
default Set<Entity>	resolveForce(Extent... extent) Deprecated. Use resolve(Extent[])
default Set<Entity>	resolveForce(Location<World> location) Deprecated. Use resolve(Location)
Selector.Builder	toBuilder() Returns a new Selector.Builder with the content of this selector.
String	toPlain() Converts this Selector to a valid selector string.

Method Detail

builder

static Selector.Builder builder()

Creates a Selector.Builder.

Returns:

A new selector builder with the specified type

parse

static Selector parse(String selector)

Parses a Selector from the given selector string.

Parameters:

selector - The raw selector string

Returns:

A new selector containing the given selector data

complete

static List<String> complete(String selector)

Fetch completions for a selector command argument.

Parameters:

selector - The partial selector

Returns:

Tab completions for the next part of the selector

getType

SelectorType getType()

Returns the type of this Selector.

Returns:

The type of this selector

get

<T> Optional<T> get(ArgumentType<T> type)

Returns the argument value for the specified ArgumentType in this Selector. May be used for ArgumentType.Invertible, but the inverted state must be checked with isInverted(ArgumentType.Invertible).

Type Parameters:

T - The type of the value

Parameters:

type - The argument type

Returns:

The value of the argument, if available

getArgument

<T> Optional<Argument<T>> getArgument(ArgumentType<T> type)

Returns the Argument for the specified ArgumentType in this Selector.

Type Parameters:

T - The type of the argument value

Parameters:

type - The argument type

Returns:

The argument, if available

getArgument

<T> Optional<Argument.Invertible<T>> getArgument(ArgumentType.Invertible<T> type)

Returns the Argument.Invertible for the specified ArgumentType.Invertible in this Selector.

Type Parameters:

T - The type of the argument value

Parameters:

type - The argument type

Returns:

The argument, if available

getArguments

List<Argument<?>> getArguments()

Returns the arguments for this Selector.

Returns:

The arguments for this Selector

has

boolean has(ArgumentType<?> type)

Checks for the presence of type in this Selector.

Parameters:

type - - The ArgumentType to check for

Returns:

true if the given type is present in this Selector, otherwise false

isInverted

boolean isInverted(ArgumentType.Invertible<?> type)

Checks for the inversion state of type in this Selector.

Parameters:

type - - The invertible ArgumentType to check inversion status on

Returns:

true if the given type is inverted in this Selector, otherwise false

resolve

Set<Entity> resolve(CommandSource origin)

Resolves this Selector to a list of entities around the origin.

The returned set may be ordered based on distance from the origin (with the nearest first).

Parameters:

origin - The source that should be considered the origin of this selector

Returns:

The matched entities

resolve

Set<Entity> resolve(Extent... extent)

Resolves this Selector to a list of entities around (0|0|0) in the given Extent(s).

The returned set may be ordered based on distance from the origin (with the nearest first).

Parameters:

extent - The extents to search for targets

Returns:

The matched entities

resolve

Set<Entity> resolve(Collection<? extends Extent> extent)

Resolves this Selector to a list of entities around (0|0|0) in the given Extent(s).

The returned set may be ordered based on distance from the origin (with the nearest first).

Parameters:

extent - The extents to search for targets

Returns:

The matched entities

resolve

Set<Entity> resolve(Location<World> location)

Resolves this Selector to a list of entities around the given Location.

The returned set may be ordered based on distance from the origin (with the nearest first).

Parameters:

location - The location to resolve the selector around

Returns:

The matched entities

resolveForce

@Deprecated
default Set<Entity> resolveForce(CommandSource origin)

Deprecated. Use resolve(CommandSource)

Resolves this Selector to a list of entities around the origin.

Parameters:

origin - The source that should be considered the origin of this selector

Returns:

The matched entities

resolveForce

@Deprecated
default Set<Entity> resolveForce(Extent... extent)

Deprecated. Use resolve(Extent[])

Resolves this Selector to a list of entities around (0|0|0) in the given Extent(s).

Parameters:

extent - The extents to search for targets

Returns:

The matched entities

resolveForce

@Deprecated
default Set<Entity> resolveForce(Collection<? extends Extent> extent)

Deprecated. Use resolve(Collection)

Resolves this Selector to a list of entities around (0|0|0) in the given Extent(s).

Parameters:

extent - The extents to search for targets

Returns:

The matched entities

resolveForce

@Deprecated
default Set<Entity> resolveForce(Location<World> location)

Deprecated. Use resolve(Location)

Resolves this Selector to a list of entities around the given Location.

Parameters:

location - The location to resolve the selector around

Returns:

The matched entities

toPlain

String toPlain()

Converts this Selector to a valid selector string.

Returns:

A valid Selector string that can be inserted into a command

toBuilder

Selector.Builder toBuilder()

Returns a new Selector.Builder with the content of this selector. This can be used to edit an immutable Selector instance.

Returns:

A new selector builder with the content of this selector