core/com.asiankoala.koawalib.command.group/SequentialGroup

SequentialGroup

open class SequentialGroup(cmds: Cmd) : Cmd, Group

Run multiple commands sequentially, finishing when the last one finishes

Parameters

cmds

Commands to run sequentially

Constructors

SequentialGroup

fun SequentialGroup(vararg cmds: Cmd)

Properties

isFinished

open override val isFinished: Boolean

Finish state of command

Inherited properties

name

val name: String

The name of the command

Functions

addCommands

override fun addCommands(vararg cmds: Cmd)

end

open override fun end()

Final part of a command, called when command finishes.

execute

open override fun execute()

Main part of a command, called while command is running.

initialize

open override fun initialize()

First part of running a command, called on start of command.

Inherited functions

alongWith

fun alongWith(vararg parallel: Cmd): ParallelGroup

Run n commands in parallel with this command, ending when all commands have ended

andPause

fun andPause(seconds: Double): SequentialGroup

Pause for n seconds after this command ends

andThen

fun andThen(vararg next: Cmd): SequentialGroup

Runs n commands sequentially after this command

cancel

fun cancel()

Cancel command. KScheduler.cancel

cancelIf

fun cancelIf(condition: () -> Boolean): RaceGroup

Cancels this command upon fulfilling a condition

deadlineWith

fun deadlineWith(vararg parallel: Cmd): DeadlineGroup

Runs n commands in parallel with this command, ending when this command ends

raceWith

fun raceWith(vararg parallel: Cmd): RaceGroup

Run n commands in parallel with this command, ending when any of the commands has ended

schedule

fun schedule()

Schedule command. Syntax sugar for KScheduler.schedule

toString

open override fun toString(): String

unaryPlus

operator fun unaryPlus()

waitUntil

fun waitUntil(condition: () -> Boolean): SequentialGroup

Wait until a condition has been fulfilled to run this command

withName

fun withName(commandName: String): Cmd

Name the current command, which shows up in the logger.

withTimeout

fun withTimeout(time: Double): RaceGroup

Cancels this command after some time if not finished