Command/com.amarcolini.joos.command/ListenerCommand

ListenerCommand

public final class ListenerCommand extends Command

A command useful for adding listeners to other commands.

Parameters

command

the command to be run.

onInit

the action to run when this command initializes.

onExecute

the action to run whenever this command updates.

onEnd

the action to run when this command is ended. Takes in whether it was interrupted as a parameter.

Constructors

ListenerCommand

@JvmOverloads()

public ListenerCommand ListenerCommand(Command command, Runnable onInit, Runnable onExecute, Consumer<Boolean> onEnd)

@JvmOverloads()

public ListenerCommand ListenerCommand(Command command, Runnable onInit, Runnable onExecute)

@JvmOverloads()

public ListenerCommand ListenerCommand(Command command, Runnable onInit)

@JvmOverloads()

public ListenerCommand ListenerCommand(Command command)

@JvmOverloads()

public ListenerCommand ListenerCommand()

Properties

isInterruptable

private final Boolean isInterruptable

Whether this command can be interrupted by another command.

onEnd

@JvmField()

public Consumer<Boolean> onEnd

onExecute

@JvmField()

public Runnable onExecute

onInit

@JvmField()

public Runnable onInit

requirements

private final Set<Component> requirements

The set of components that this command uses.

Functions

end

public Unit end(Boolean interrupted)

Runs once when this command finishes or is interrupted.

execute

public Unit execute()

Runs repeatedly until isFinished returns true.

getRequirements

public Set<Component> getRequirements()

The set of components that this command uses.

init

public Unit init()

Runs once when first scheduled.

isFinished

public Boolean isFinished()

Returns whether this command is finished.

isInterruptable

public Boolean isInterruptable()

Whether this command can be interrupted by another command.