Add information about using selectors in command elements. #744
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dualspiral
force-pushed
the
feature/selector
branch
from
d68cd9c
to
cf41cb6
Compare
|
A preview for this pull request is available at https://cdn.rawgit.com/Spongy/SpongeDocs-PRs/67e0a4a/. Here are some links to the pages that were modified: Since the preview frequently changes, please link to this comment, not to the direct url to the preview. |
ST-DDT
requested changes
Aug 18, 2018
source/plugin/commands/arguments.rst
Outdated
|
|
||
| .. tip:: | ||
|
|
||
| Look at the `SelectorCommandElement source code <https://github.com/SpongePowered/SpongeAPI/blob/stable-7/src/main/java/org/spongepowered/api/command/args/SelectorCommandElement.java>`_ |
There was a problem hiding this comment.
Maybe link to https://github.com/SpongePowered/SpongeAPI/blob/stable-7/src/main/java/org/spongepowered/api/command/args/SelectorCommandElement.java#L40 to omit the license header stuff.
source/plugin/commands/arguments.rst
Outdated
| @@ -10,7 +10,11 @@ Argument Parsing | |||
| org.spongepowered.api.command.args.CommandContext | |||
| org.spongepowered.api.command.args.CommandElement | |||
| org.spongepowered.api.command.args.GenericArguments | |||
| org.spongepowered.api.command.args.SelectorCommandElement | |||
There was a problem hiding this comment.
To you use this import somewhere?
There was a problem hiding this comment.
My original version did, just left this in.
ST-DDT
approved these changes
Aug 18, 2018
Inscrutable
reviewed
Aug 19, 2018
source/plugin/commands/arguments.rst
Outdated
| (getting a set of :javadoc:`Entity` objects selected by the selector). | ||
|
|
||
| To **parse** a selector string, use the :javadoc:`Selector#parse(String)` method, passing the entire selector, | ||
| including the ``@`` symbol. This will turn the string into a ``Selector`` object that can be quieried or resolved. |
source/plugin/commands/arguments.rst
Outdated
|
|
||
| The following ``parseValue`` method from the ``CommandElement`` class attempts to parse a selector and return a set of | ||
| entities based on the location of the ``CommandSource``. If the passed string does not start with ``@``, an exception | ||
| is thrown indicating the passed argument is not a selector. |
There was a problem hiding this comment.
is thrown -> "will be thrown"
|
@Inscrutable All sorted. |
ST-DDT
approved these changes
Aug 19, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Just added information about how to use it with command elements. Also changed an example to avoid the use of a class-based variable.
See #238