org.spongepowered.api.data.manipulator.immutable

Interface ImmutableCommandData

All Superinterfaces:

DataSerializable, ImmutableDataManipulator<ImmutableCommandData,CommandData>, ValueContainer<ImmutableCommandData>

public interface ImmutableCommandData
extends ImmutableDataManipulator<ImmutableCommandData,CommandData>

An ImmutableDataManipulator handling all related ImmutableValues for command related DataHolders, such as CommandBlocks and CommandBlockMinecarts.

Method Summary

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

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

asMutable, copy, with, with

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

ImmutableValue<String> storedCommand()

Gets the currently stored command.

Returns:

The command

successCount

ImmutableValue<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

ImmutableValue<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

ImmutableOptionalValue<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