Package dev.jorel.commandapi.arguments

Class SoundArgument

java.lang.Object

dev.jorel.commandapi.AbstractArgumentTree<Argument<org.bukkit.Sound>,Argument<?>,org.bukkit.command.CommandSender>

dev.jorel.commandapi.arguments.AbstractArgument<org.bukkit.Sound,Argument<org.bukkit.Sound>,Argument<?>,org.bukkit.command.CommandSender>

dev.jorel.commandapi.arguments.Argument<org.bukkit.Sound>

dev.jorel.commandapi.arguments.SafeOverrideableArgument<org.bukkit.Sound,org.bukkit.Sound>

dev.jorel.commandapi.arguments.SoundArgument

All Implemented Interfaces:

CustomProvidedArgument, SafeOverrideable<org.bukkit.Sound,org.bukkit.Sound,Argument<org.bukkit.Sound>,Argument<?>,org.bukkit.command.CommandSender>, BukkitExecutable<Argument<org.bukkit.Sound>>, ChainableBuilder<Argument<org.bukkit.Sound>>, PlatformExecutable<Argument<org.bukkit.Sound>,org.bukkit.command.CommandSender>

public class SoundArgument
extends SafeOverrideableArgument<org.bukkit.Sound,org.bukkit.Sound>
implements CustomProvidedArgument

An argument that represents the Bukkit Sound object

Since:

2.1

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	SoundArgument.NamespacedKey	An argument that represents the Bukkit Sound object

Field Summary

Fields

Modifier and Type	Field	Description
protected CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	executor

Constructor Summary

Constructors

Constructor	Description
SoundArgument(String nodeName)	A Sound argument.

Method Summary

Modifier and Type	Method	Description
Argument<org.bukkit.Sound>	clearExecutors()
CommandAPIArgumentType	getArgumentType()
CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>>	getExecutor()
Class<org.bukkit.Sound>	getPrimitiveType()
SuggestionProviders	getSuggestionProvider()
<CommandSourceStack> org.bukkit.Sound	parseArgument(com.mojang.brigadier.context.CommandContext<CommandSourceStack> cmdCtx, String key, CommandArguments previousArgs)
void	setExecutor(CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> arg0)

Methods inherited from class dev.jorel.commandapi.arguments.SafeOverrideableArgument

fromKey, getMapper

Methods inherited from class dev.jorel.commandapi.arguments.Argument

instance

Methods inherited from class dev.jorel.commandapi.arguments.AbstractArgument

combineWith, copyPermissionsAndRequirements, getArgumentPermission, getCombinedArguments, getEntityNames, getHelpString, getIncludedSuggestions, getNodeName, getOverriddenSuggestions, getRawType, getRequirements, hasCombinedArguments, includeSuggestions, isListed, isOptional, replaceSuggestions, setListed, setOptional, toString, withPermission, withPermission, withRequirement

Methods inherited from class dev.jorel.commandapi.AbstractArgumentTree

then

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface dev.jorel.commandapi.BukkitExecutable

executes, executes, executes, executes, executesCommandBlock, executesCommandBlock, executesCommandBlock, executesCommandBlock, executesConsole, executesConsole, executesConsole, executesConsole, executesEntity, executesEntity, executesEntity, executesEntity, executesFeedbackForwarding, executesFeedbackForwarding, executesFeedbackForwarding, executesFeedbackForwarding, executesNative, executesNative, executesNative, executesNative, executesPlayer, executesPlayer, executesPlayer, executesPlayer, executesProxy, executesProxy, executesProxy, executesProxy, executesRemoteConsole, executesRemoteConsole, executesRemoteConsole, executesRemoteConsole

Methods inherited from interface dev.jorel.commandapi.ChainableBuilder

instance

Methods inherited from interface dev.jorel.commandapi.PlatformExecutable

getExecutor

Methods inherited from interface dev.jorel.commandapi.arguments.SafeOverrideable

includeSafeSuggestions, includeSuggestions, replaceSafeSuggestions, replaceSuggestions

Field Details

executor

protected CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> executor

Constructor Details

SoundArgument

public SoundArgument(String nodeName)

A Sound argument. Represents Bukkit's Sound object

Parameters:

nodeName - the name of the node for this argument

Method Details

getPrimitiveType

public Class<org.bukkit.Sound> getPrimitiveType()

Specified by:

getPrimitiveType in class AbstractArgument<org.bukkit.Sound,Argument<org.bukkit.Sound>,Argument<?>,org.bukkit.command.CommandSender>

getSuggestionProvider

public SuggestionProviders getSuggestionProvider()

Specified by:

getSuggestionProvider in interface CustomProvidedArgument

getArgumentType

public CommandAPIArgumentType getArgumentType()

Specified by:

getArgumentType in class AbstractArgument<org.bukkit.Sound,Argument<org.bukkit.Sound>,Argument<?>,org.bukkit.command.CommandSender>

parseArgument

public <CommandSourceStack> org.bukkit.Sound parseArgument(com.mojang.brigadier.context.CommandContext<CommandSourceStack> cmdCtx,
 String key,
 CommandArguments previousArgs)
                                                    throws com.mojang.brigadier.exceptions.CommandSyntaxException

Specified by:

parseArgument in class AbstractArgument<org.bukkit.Sound,Argument<org.bukkit.Sound>,Argument<?>,org.bukkit.command.CommandSender>

Throws:

com.mojang.brigadier.exceptions.CommandSyntaxException

getExecutor

public CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> getExecutor()

setExecutor

public void setExecutor(CommandAPIExecutor<org.bukkit.command.CommandSender,AbstractCommandSender<? extends org.bukkit.command.CommandSender>> arg0)

clearExecutors

public Argument<org.bukkit.Sound> clearExecutors()