An ArgumentType that parses booleans. More...

Inheritance diagram for com.mojang.brigadier.arguments.BoolArgumentType:

Public Member Functions
Boolean	parse (final StringReader reader) throws CommandSyntaxException

Collection< String >	getExamples ()

Static Public Member Functions
static BoolArgumentType	bool ()
	A factory method as a simple way to get an instance. More...

static boolean	getBool (final CommandContext<?> context, final String name)
	Retrieves the argument with the given name from the context and casts it to a boolean. More...

Detailed Description

An ArgumentType that parses booleans.

Member Function Documentation

static BoolArgumentType com.mojang.brigadier.arguments.BoolArgumentType.bool ( )

static

A factory method as a simple way to get an instance.

It is recommended to statically import this method to provide an interface similar to:
argument("name", bool())

static boolean com.mojang.brigadier.arguments.BoolArgumentType.getBool	(	final CommandContext<?>	context,
		final String	name
	)

static

Retrieves the argument with the given name from the context and casts it to a boolean.

Parameters

context	the context to get the argument from, calls `CommandContext#getArgument`
name	the name of the argument to retrieve