MCArgumentCommandNode - CraftTweaker Documentation

Version:

Language:

Home Migration Guide Getting Started With Scripts Commands Examples

Importing the class

It might be required for you to import the package if you encounter any issues (like casting an Array), so better be safe than sorry and add the import at the very top of the file.

ZenScript
 Copy
import crafttweaker.api.commands.custom.MCArgumentCommandNode;

Extending MCCommandNode

MCArgumentCommandNode extends MCCommandNode. That means all methods available in MCCommandNode are also available in MCArgumentCommandNode

Casters

Result type	Is Implicit
Result type string	Is Implicit true

Methods

addChild

Name: addChild

Return Type: void

ZenScript
 Copy
MCArgumentCommandNode.addChild(node as MCCommandNode) as void

Parameter	Type	Description
Parameter node	Type MCCommandNode	Description No Description Provided

canUse

Name: canUse

Return Type: boolean

ZenScript
 Copy
MCArgumentCommandNode.canUse(source as MCCommandSource) as boolean

Parameter	Type	Description
Parameter source	Type MCCommandSource	Description No Description Provided

createBuilder

Name: createBuilder

Return Type: MCRequiredArgumentBuilder

ZenScript
 Copy
// MCArgumentCommandNode.createBuilder() as MCRequiredArgumentBuilder

myMCArgumentCommandNode.createBuilder();

equals

Name: equals

Return Type: boolean

ZenScript
 Copy
MCArgumentCommandNode.equals(o as Object) as boolean

Parameter	Type	Description
Parameter o	Type Object	Description No Description Provided

findAmbiguities

Name: findAmbiguities

Return Type: void

ZenScript
 Copy
MCArgumentCommandNode.findAmbiguities(consumer as MCAmbiguityConsumer) as void

Parameter	Type	Description
Parameter consumer	Type MCAmbiguityConsumer	Description No Description Provided

getChild

Name: getChild

Return Type: MCCommandNode

ZenScript
 Copy
MCArgumentCommandNode.getChild(name as string) as MCCommandNode

Parameter	Type	Description
Parameter name	Type string	Description No Description Provided

getChildren

Name: getChildren

Return Type: Collection<MCCommandNode>

ZenScript
 Copy
// MCArgumentCommandNode.getChildren() as Collection<MCCommandNode>

myMCArgumentCommandNode.getChildren();

getCommand

Name: getCommand

Return Type: MCCommand

ZenScript
 Copy
// MCArgumentCommandNode.getCommand() as MCCommand

myMCArgumentCommandNode.getCommand();

getCustomSuggestions

Name: getCustomSuggestions

Return Type: MCSuggestionProvider

ZenScript
 Copy
// MCArgumentCommandNode.getCustomSuggestions() as MCSuggestionProvider

myMCArgumentCommandNode.getCustomSuggestions();

getExamples

Name: getExamples

Return Type: Collection<string>

ZenScript
 Copy
// MCArgumentCommandNode.getExamples() as Collection<string>

myMCArgumentCommandNode.getExamples();

getName

Name: getName

Return Type: string

ZenScript
 Copy
// MCArgumentCommandNode.getName() as string

myMCArgumentCommandNode.getName();

getRedirect

Name: getRedirect

Return Type: MCCommandNode

ZenScript
 Copy
// MCArgumentCommandNode.getRedirect() as MCCommandNode

myMCArgumentCommandNode.getRedirect();

getRedirectModifier

Name: getRedirectModifier

Return Type: MCRedirectModifier

ZenScript
 Copy
// MCArgumentCommandNode.getRedirectModifier() as MCRedirectModifier

myMCArgumentCommandNode.getRedirectModifier();

getRelevantNodes

Name: getRelevantNodes

Return Type: Collection<MCCommandNode>

ZenScript
 Copy
MCArgumentCommandNode.getRelevantNodes(input as string) as Collection<MCCommandNode>

Parameter	Type	Description
Parameter input	Type string	Description No Description Provided

getRequirement

Name: getRequirement

Return Type: Predicate<MCCommandSource>

ZenScript
 Copy
// MCArgumentCommandNode.getRequirement() as Predicate<MCCommandSource>

myMCArgumentCommandNode.getRequirement();

getUsageText

Name: getUsageText

Return Type: string

ZenScript
 Copy
// MCArgumentCommandNode.getUsageText() as string

myMCArgumentCommandNode.getUsageText();

hashCode

Name: hashCode

Return Type: int

ZenScript
 Copy
// MCArgumentCommandNode.hashCode() as int

myMCArgumentCommandNode.hashCode();

isFork

Name: isFork

Return Type: boolean

ZenScript
 Copy
// MCArgumentCommandNode.isFork() as boolean

myMCArgumentCommandNode.isFork();

listSuggestions

Name: listSuggestions

Return Type: MCSuggestions

ZenScript
 Copy
MCArgumentCommandNode.listSuggestions(context as MCCommandContext, builder as MCSuggestionsBuilder) as MCSuggestions

Parameter	Type	Description
Parameter context	Type MCCommandContext	Description No Description Provided
Parameter builder	Type MCSuggestionsBuilder	Description No Description Provided

parse

Name: parse

Return Type: void

ZenScript
 Copy
MCArgumentCommandNode.parse(input as string, contextBuilder as MCCommandContextBuilder) as void

Parameter	Type	Description
Parameter input	Type string	Description No Description Provided
Parameter contextBuilder	Type MCCommandContextBuilder	Description No Description Provided

toString

Name: toString

Return Type: string

ZenScript
 Copy
// MCArgumentCommandNode.toString() as string

myMCArgumentCommandNode.toString();

Operators

COMPARE

Name: COMPARE

ZenScript
 Copy
myMCArgumentCommandNode < o as MCCommandNode

EQUALS

Name: EQUALS

ZenScript
 Copy
myMCArgumentCommandNode == o as Object