net.minecraftforge.common.command

Interface SelectorHandler

public interface SelectorHandler

Handler for custom types of selectors registered with SelectorHandlerManager

Method Summary

Modifier and Type	Method and Description
boolean	isSelector(java.lang.String selectorStr) Returns whether the string matches the overall syntax of the selector Note: If this returns false, matchEntities(net.minecraft.command.ICommandSender, java.lang.String, java.lang.Class<? extends T>) should return an empty list
<T extends Entity> java.util.List<T>	matchEntities(ICommandSender sender, java.lang.String token, java.lang.Class<? extends T> targetClass) Returns a List of Entities of class targetClass (T) represented by token Note: If token does not match the overall syntax defined by isSelector(java.lang.String), this method should return an empty list.
boolean	matchesMultiplePlayers(java.lang.String selectorStr) Returns whether the selector string potentially matches multiple entities

Method Detail

matchEntities

<T extends Entity> java.util.List<T> matchEntities(ICommandSender sender,
                                                   java.lang.String token,
                                                   java.lang.Class<? extends T> targetClass)
                                            throws CommandException

Returns a List of Entities of class targetClass (T) represented by token
Note: If token does not match the overall syntax defined by isSelector(java.lang.String), this method should return an empty list. For any other error, an exception should be thrown

Parameters:

sender - The ICommandSender that initiated the query

Throws:

CommandException

matchesMultiplePlayers

boolean matchesMultiplePlayers(java.lang.String selectorStr)
                        throws CommandException

Returns whether the selector string potentially matches multiple entities

Throws:

CommandException

isSelector

boolean isSelector(java.lang.String selectorStr)

Returns whether the string matches the overall syntax of the selector
Note: If this returns false, matchEntities(net.minecraft.command.ICommandSender, java.lang.String, java.lang.Class<? extends T>) should return an empty list