CommandAPI 12.1.0
An API for the command UI introduced in Minecraft 1.13
Loading...
Searching...
No Matches
dev.jorel.commandapi.arguments.FunctionArgument Class Reference

An argument that represents Minecraft functions and tags. More...

Inheritance diagram for dev.jorel.commandapi.arguments.FunctionArgument:

Public Member Functions

 FunctionArgument (String nodeName)
 A Minecraft function.
Class< FunctionWrapper[]> getPrimitiveType ()
SuggestionProviders getSuggestionProvider ()
 Returns the suggestion provider that this argument is populated with.
CommandAPIArgumentType getArgumentType ()
Function< S, String > getMapper ()

Static Public Member Functions

static< S > Function< S, String > fromKey (Function< S, NamespacedKey > mapper)

Detailed Description

An argument that represents Minecraft functions and tags.

Since
1.6

Constructor & Destructor Documentation

◆ FunctionArgument()

dev.jorel.commandapi.arguments.FunctionArgument.FunctionArgument ( String nodeName)

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!

Parameters
nodeNamethe name of the node for this argument

Member Function Documentation

◆ fromKey()

static< S > Function< S, String > dev.jorel.commandapi.arguments.SafeOverrideableArgument< T, S >.fromKey ( Function< S, NamespacedKey > mapper)
staticinherited

Composes a S to a NamespacedKey mapping function to convert S to a String

Parameters
mapperthe mapping function from S to NamespacedKey
Returns
a composed function that converts S to String

◆ getSuggestionProvider()

SuggestionProviders dev.jorel.commandapi.arguments.FunctionArgument.getSuggestionProvider ( )

Returns the suggestion provider that this argument is populated with.

Returns
the suggestion provider that this argument is populated with

Implements dev.jorel.commandapi.arguments.CustomProvidedArgument.