org.spongepowered.api.data.manipulator.mutable

Interface CommandData

All Superinterfaces:

DataManipulator<CommandData,ImmutableCommandData>, DataSerializable, ValueContainer<CommandData>

public interface CommandData
extends DataManipulator<CommandData,ImmutableCommandData>

An DataManipulator handling all related Values for command related DataHolders, such as CommandBlocks and CommandBlockMinecarts.

Method Summary

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

Methods inherited from interface org.spongepowered.api.data.manipulator.DataManipulator

asImmutable, copy, fill, fill, from, set, set, set, set, transform

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

getContentVersion, toContainer

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

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

Method Detail

storedCommand

Value<String> storedCommand()

Gets the currently stored command.

Returns:

The command

See Also:

Keys.COMMAND

successCount

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

See Also:

Keys.SUCCESS_COUNT

doesTrackOutput

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

See Also:

Keys.TRACKS_OUTPUT

lastOutput

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

See Also:

Keys.LAST_COMMAND_OUTPUT