org.spongepowered.api.command.source

Interface CommandBlockSource

All Superinterfaces:

CommandSource, CompositeValueStore<DataHolder,DataManipulator<?,?>>, Contextual, DataHolder, DataSerializable, Locatable, MessageReceiver, PropertyHolder, Subject, ValueContainer<DataHolder>

All Known Subinterfaces:

CommandBlock, CommandBlockMinecart

public interface CommandBlockSource
extends Locatable, CommandSource, DataHolder

Represents a CommandBlock source, either a placed block or a CommandBlockMinecart.

Method Summary

Modifier and Type	Method and Description
default Value<Boolean>	doesTrackOutput() Gets whether this command block will keep track of the output from the last command it executed.
default CommandData	getCommandData() Gets the CommandData for this source.
default OptionalValue<Text>	lastOutput() Gets the last command output.
default Value<String>	storedCommand() Gets the currently stored command.
default Value<Integer>	successCount() Gets the success count of the last executed command.

Methods inherited from interface org.spongepowered.api.world.Locatable

getLocation, getWorld

Methods inherited from interface org.spongepowered.api.command.CommandSource

getLocale, getName

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

Methods inherited from interface org.spongepowered.api.data.DataHolder

setRawData, validateRawData

Methods inherited from interface org.spongepowered.api.data.DataSerializable

getContentVersion, toContainer

Methods inherited from interface org.spongepowered.api.data.property.PropertyHolder

getApplicableProperties, getProperty

Methods inherited from interface org.spongepowered.api.data.value.mutable.CompositeValueStore

copyFrom, copyFrom, get, getContainers, getOrCreate, offer, offer, offer, offer, offer, offer, remove, remove, remove, require, supports, transform, tryOffer, tryOffer, tryOffer, tryOffer, undo

Methods inherited from interface org.spongepowered.api.data.value.ValueContainer

copy, get, getKeys, getOrElse, getOrNull, getValue, getValues, require, supports, supports

Method Detail

getCommandData

default CommandData getCommandData()

Gets the CommandData for this source.

Returns:

The command data

storedCommand

default Value<String> storedCommand()

Gets the currently stored command.

Returns:

The command

successCount

default Value<Integer> successCount()

Gets the success count of the last executed command.

The success count is the number of times the most recently used command of this command block succeeded. Most commands can only succeed once per execution, but certain commands (such as those which accept players as arguments) can succeed multiple times, and this value will be set accordingly. This success count can also be polled via a redstone comparator.

Returns:

The last success count

doesTrackOutput

default Value<Boolean> doesTrackOutput()

Gets whether this command block will keep track of the output from the last command it executed.

Returns:

Whether the command output is tracked

lastOutput

default OptionalValue<Text> lastOutput()

Gets the last command output.

This will only be available if doesTrackOutput() is set to true, otherwise Optional.empty() will be returned.

Returns:

The last command output, if available