Interface CommandBlock
-
- All Superinterfaces:
BlockEntity
,Contextual
,CopyableDataHolder
,DataHolder
,DataHolder.Mutable
,DataSerializable
,LocaleSource
,Locatable
,Nameable
,SerializableDataHolder
,SerializableDataHolder.Mutable
,Subject
,ValueContainer
public interface CommandBlock extends BlockEntity, Subject, LocaleSource, Nameable
Represents a Command Block.
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface org.spongepowered.api.data.DataHolder
DataHolder.Immutable<I extends DataHolder.Immutable<I>>, DataHolder.Mutable
-
Nested classes/interfaces inherited from interface org.spongepowered.api.data.SerializableDataHolder
SerializableDataHolder.Immutable<I extends SerializableDataHolder.Immutable<I>>, SerializableDataHolder.Mutable
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Value.Mutable<Boolean>
doesTrackOutput()
Gets whether this command block will keep track of the output from the last command it executed.void
execute()
Executes the currently stored command.default Optional<Value.Mutable<Component>>
lastOutput()
Gets the last command output.default Value.Mutable<String>
storedCommand()
Gets the currently stored command.default Value.Mutable<Integer>
successCount()
Gets the success count of the last executed command.-
Methods inherited from interface org.spongepowered.api.block.entity.BlockEntity
block, copy, createArchetype, isValid, locatableBlock, mirror, mirror, rotate, rotate, setValid, type
-
Methods inherited from interface org.spongepowered.api.service.context.Contextual
friendlyIdentifier, identifier
-
Methods inherited from interface org.spongepowered.api.data.DataHolder.Mutable
copyFrom, copyFrom, offer, offer, offer, offer, offerAll, offerAll, offerAll, offerAll, offerAll, offerAll, offerSingle, offerSingle, offerSingle, offerSingle, remove, remove, remove, removeAll, removeAll, removeAll, removeAll, removeAll, removeAll, removeKey, removeKey, removeSingle, removeSingle, transform, transform, tryOffer, tryOffer, tryOffer, undo
-
Methods inherited from interface org.spongepowered.api.data.persistence.DataSerializable
contentVersion, toContainer
-
Methods inherited from interface org.spongepowered.api.util.locale.LocaleSource
locale
-
Methods inherited from interface org.spongepowered.api.world.Locatable
blockPosition, location, serverLocation, world
-
Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder
validateRawData
-
Methods inherited from interface org.spongepowered.api.data.SerializableDataHolder.Mutable
setRawData
-
Methods inherited from interface org.spongepowered.api.service.permission.Subject
associatedObject, asSubjectReference, containingCollection, contextCause, hasPermission, hasPermission, hasPermission, isChildOf, isChildOf, isChildOf, isSubjectDataPersisted, option, option, option, parents, parents, parents, permissionValue, permissionValue, permissionValue, subjectData, transientSubjectData
-
-
-
-
Method Detail
-
execute
void execute()
Executes the currently stored command.
-
storedCommand
default Value.Mutable<String> storedCommand()
Gets the currently stored command.- Returns:
- The command
-
successCount
default Value.Mutable<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.Mutable<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 Optional<Value.Mutable<Component>> lastOutput()
Gets the last command output.This will only be available if
doesTrackOutput()
is set to true, otherwiseOptional.empty()
will be returned.- Returns:
- The last command output, if available
-
-