MCRootCommandNode - 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.MCRootCommandNode;

Extending MCCommandNode

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

Casters

Result type	Is Implicit
Result type string	Is Implicit true

Methods

addChild

Name: addChild

Return Type: void

ZenScript
 Copy
MCRootCommandNode.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
MCRootCommandNode.canUse(source as MCCommandSource) as boolean

Parameter	Type	Description
Parameter source	Type MCCommandSource	Description No Description Provided

createBuilder

Name: createBuilder

Return Type: MCArgumentBuilder

ZenScript
 Copy
// MCRootCommandNode.createBuilder() as MCArgumentBuilder

myMCRootCommandNode.createBuilder();

equals

Name: equals

Return Type: boolean

ZenScript
 Copy
MCRootCommandNode.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
MCRootCommandNode.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
MCRootCommandNode.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
// MCRootCommandNode.getChildren() as Collection<MCCommandNode>

myMCRootCommandNode.getChildren();

getCommand

Name: getCommand

Return Type: MCCommand

ZenScript
 Copy
// MCRootCommandNode.getCommand() as MCCommand

myMCRootCommandNode.getCommand();

getExamples

Name: getExamples

Return Type: Collection<string>

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

myMCRootCommandNode.getExamples();

getName

Name: getName

Return Type: string

ZenScript
 Copy
// MCRootCommandNode.getName() as string

myMCRootCommandNode.getName();

getRedirect

Name: getRedirect

Return Type: MCCommandNode

ZenScript
 Copy
// MCRootCommandNode.getRedirect() as MCCommandNode

myMCRootCommandNode.getRedirect();

getRedirectModifier

Name: getRedirectModifier

Return Type: MCRedirectModifier

ZenScript
 Copy
// MCRootCommandNode.getRedirectModifier() as MCRedirectModifier

myMCRootCommandNode.getRedirectModifier();

getRelevantNodes

Name: getRelevantNodes

Return Type: Collection<MCCommandNode>

ZenScript
 Copy
MCRootCommandNode.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
// MCRootCommandNode.getRequirement() as Predicate<MCCommandSource>

myMCRootCommandNode.getRequirement();

getUsageText

Name: getUsageText

Return Type: string

ZenScript
 Copy
// MCRootCommandNode.getUsageText() as string

myMCRootCommandNode.getUsageText();

hashCode

Name: hashCode

Return Type: int

ZenScript
 Copy
// MCRootCommandNode.hashCode() as int

myMCRootCommandNode.hashCode();

isFork

Name: isFork

Return Type: boolean

ZenScript
 Copy
// MCRootCommandNode.isFork() as boolean

myMCRootCommandNode.isFork();

isValidInput

Name: isValidInput

Return Type: boolean

ZenScript
 Copy
MCRootCommandNode.isValidInput(input as string) as boolean

Parameter	Type	Description
Parameter input	Type string	Description No Description Provided

listSuggestions

Name: listSuggestions

Return Type: MCSuggestions

ZenScript
 Copy
MCRootCommandNode.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
MCRootCommandNode.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
// MCRootCommandNode.toString() as string

myMCRootCommandNode.toString();

Operators

COMPARE

Name: COMPARE

ZenScript
 Copy
myMCRootCommandNode < o as MCCommandNode

EQUALS

Name: EQUALS

ZenScript
 Copy
myMCRootCommandNode == o as Object