dev.jorel.commandapi.arguments.FunctionArgument Maven / Gradle / Ivy
/*******************************************************************************
* Copyright 2018, 2020 Jorel Ali (Skepter) - MIT License
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*******************************************************************************/
package dev.jorel.commandapi.arguments;
import com.mojang.brigadier.context.CommandContext;
import com.mojang.brigadier.exceptions.CommandSyntaxException;
import dev.jorel.commandapi.CommandAPIBukkit;
import dev.jorel.commandapi.executors.CommandArguments;
import dev.jorel.commandapi.wrappers.FunctionWrapper;
import org.bukkit.NamespacedKey;
/**
* An argument that represents Minecraft functions and tags
*
* @since 1.6
*/
public class FunctionArgument extends SafeOverrideableArgument implements CustomProvidedArgument {
/**
* A Minecraft function. Plugin commands which plan to be used INSIDE a Minecraft
* a function MUST be registered in the onLoad() method of your plugin, NOT
* in the onEnable() method!
* @param nodeName the name of the node for this argument
*/
public FunctionArgument(String nodeName) {
super(nodeName, CommandAPIBukkit.get()._ArgumentTag(), fromKey(n -> n));
}
@Override
public Class getPrimitiveType() {
return FunctionWrapper[].class;
}
@Override
public SuggestionProviders getSuggestionProvider() {
return SuggestionProviders.FUNCTION;
}
@Override
public CommandAPIArgumentType getArgumentType() {
return CommandAPIArgumentType.FUNCTION;
}
@Override
public FunctionWrapper[] parseArgument(CommandContext cmdCtx, String key, CommandArguments previousArgs) throws CommandSyntaxException {
return CommandAPIBukkit.get().getFunction(cmdCtx, key);
}
}