Package net.minecraftforge.client.event

Class RegisterClientCommandsEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.client.event.RegisterClientCommandsEvent

public class RegisterClientCommandsEvent
extends net.minecraftforge.eventbus.api.Event

Fired to allow mods to register client commands.

Some command arguments behave differently for the client commands dispatcher:

• ResourceLocationArgument.getAdvancement(com.mojang.brigadier.context.CommandContext, String) only returns advancements that are shown on the advancements screen.
• ObjectiveArgument.getObjective(com.mojang.brigadier.context.CommandContext, String) only returns objectives that are displayed to the player.

This event is not cancellable, and does not have a result.

This event is fired on the main Forge event bus, only on the logical client.

See Also:

• RegisterCommandsEvent

Nested Class Summary

Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event

net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

Field Summary

Fields

Modifier and Type	Field	Description
private final CommandBuildContext	context
private final com.mojang.brigadier.CommandDispatcher<CommandSourceStack>	dispatcher

Constructor Summary

Constructors

Constructor	Description
RegisterClientCommandsEvent(com.mojang.brigadier.CommandDispatcher<CommandSourceStack> dispatcher, CommandBuildContext context)

Method Summary

Modifier and Type	Method	Description
CommandBuildContext	getBuildContext()	Returns the context to build the commands for.
com.mojang.brigadier.CommandDispatcher<CommandSourceStack>	getDispatcher()	Returns the command dispatcher for registering commands to be executed on the client.

Methods inherited from class net.minecraftforge.eventbus.api.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

dispatcher

private final com.mojang.brigadier.CommandDispatcher<CommandSourceStack> dispatcher

context

private final CommandBuildContext context

Constructor Details

RegisterClientCommandsEvent

@Internal
public RegisterClientCommandsEvent(com.mojang.brigadier.CommandDispatcher<CommandSourceStack> dispatcher,
 CommandBuildContext context)

Method Details

getDispatcher

public com.mojang.brigadier.CommandDispatcher<CommandSourceStack> getDispatcher()

Returns the command dispatcher for registering commands to be executed on the client.

Returns:

the command dispatcher for registering commands to be executed on the client

getBuildContext

public CommandBuildContext getBuildContext()

Returns the context to build the commands for.

Returns:

the context to build the commands for