org.spongepowered.api.command

Interface CommandSource

All Superinterfaces:

Contextual, MessageReceiver, Subject

All Known Subinterfaces:

CommandBlock, CommandBlockMinecart, CommandBlockSource, ConsoleSource, Player, ProxySource, RconSource, RemoteSource, SignSource

public interface CommandSource
extends MessageReceiver, Subject

Something that can execute commands.

Examples of potential implementations include players, the server console, Rcon clients, web-based clients, command blocks, and so on.

Method Summary

Modifier and Type	Method and Description
default Locale	getLocale() Gets the locale used by this command source.
String	getName() Gets the name identifying this command source.

Methods inherited from interface org.spongepowered.api.text.channel.MessageReceiver

getMessageChannel, sendMessage, sendMessage, sendMessage, sendMessages, sendMessages, setMessageChannel

Methods inherited from interface org.spongepowered.api.service.permission.Subject

asSubjectReference, getCommandSource, getContainingCollection, getOption, getOption, getParents, getParents, getPermissionValue, getSubjectData, getTransientSubjectData, hasPermission, hasPermission, isChildOf, isChildOf, isSubjectDataPersisted

Methods inherited from interface org.spongepowered.api.service.context.Contextual

getActiveContexts, getFriendlyIdentifier, getIdentifier

Method Detail

getName

String getName()

Gets the name identifying this command source.

Returns:

The name of this command source

getLocale

default Locale getLocale()

Gets the locale used by this command source. If this CommandSource does have a Locale configured or does not support configuring a Locale, Locales.DEFAULT is used.

Returns:

The locale used by this command source