Package org.geysermc.geyser.command.defaults

Class HelpCommand

java.lang.Object

org.geysermc.geyser.command.GeyserCommand

org.geysermc.geyser.command.defaults.HelpCommand

All Implemented Interfaces:

org.geysermc.geyser.api.command.Command

public class HelpCommand
extends GeyserCommand

Nested Class Summary

Nested classes/interfaces inherited from interface org.geysermc.geyser.api.command.Command

org.geysermc.geyser.api.command.Command.Builder<T extends org.geysermc.geyser.api.command.CommandSource>

Field Summary

Fields inherited from class org.geysermc.geyser.command.GeyserCommand

description, name, permission

Constructor Summary

Constructors

Constructor	Description
HelpCommand(GeyserImpl geyser, String name, String description, String permission, String baseCommand, Map<String,org.geysermc.geyser.api.command.Command> commands)

Method Summary

Modifier and Type	Method	Description
void	execute(GeyserSession session, GeyserCommandSource sender, String[] args)	Sends the help menu to a command sender.

Methods inherited from class org.geysermc.geyser.command.GeyserCommand

aliases, description, isExecutableOnConsole, isSuggestedOpOnly, name, permission, setAliases, subCommands

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.geysermc.geyser.api.command.Command

isBedrockOnly

Constructor Details

HelpCommand

public HelpCommand(GeyserImpl geyser,
 String name,
 String description,
 String permission,
 String baseCommand,
 Map<String,org.geysermc.geyser.api.command.Command> commands)

Method Details

execute

public void execute(GeyserSession session,
 GeyserCommandSource sender,
 String[] args)

Sends the help menu to a command sender. Will not show certain commands depending on the command sender and session.

Specified by:

execute in class GeyserCommand

Parameters:

session - The Geyser session of the command sender, if it is a bedrock player. If null, bedrock-only commands will be hidden.

sender - The CommandSender to send the help message to.

args - Not used.