Malefix/xyz.malefic.frc.swerve.command/LockSwerve

LockSwerve

class LockSwerve(swerveDrive: SwerveDrive) : Command

Command that locks the swerve modules in an X formation to prevent pushing.

This command is useful for defense or when the robot needs to resist being pushed. All modules are oriented at 45-degree angles forming an X pattern.

Usage Example:

val lockCommand = LockSwerve(drive)
controller.x().onTrue(lockCommand)

Constructors

LockSwerve

constructor(swerveDrive: SwerveDrive)

Properties

interruptionBehavior

open val interruptionBehavior: Command.InterruptionBehavior?

isFinished

open override val isFinished: Boolean

isScheduled

open val isScheduled: Boolean

name

open var name: String?

requirements

open val requirements: Set<Subsystem?>?

subsystem

open var subsystem: String?

Functions

addRequirements

fun addRequirements(vararg requirements: Subsystem?)

fun addRequirements(requirements: Collection<Subsystem?>?)

alongWith

open fun alongWith(vararg parallel: Command?): ParallelCommandGroup?

andThen

open fun andThen(vararg next: Command?): SequentialCommandGroup?

open fun andThen(toRun: Runnable?, vararg requirements: Subsystem?): SequentialCommandGroup?

asProxy

open fun asProxy(): ProxyCommand?

beforeStarting

open fun beforeStarting(before: Command?): SequentialCommandGroup?

open fun beforeStarting(toRun: Runnable?, vararg requirements: Subsystem?): SequentialCommandGroup?

cancel

open fun cancel()

deadlineFor

open fun deadlineFor(vararg parallel: Command?): ParallelDeadlineGroup?

deadlineWith

open fun ~~deadlineWith~~(vararg parallel: Command?): ParallelDeadlineGroup?

end

open override fun end(interrupted: Boolean)

execute

open override fun execute()

finallyDo

open fun finallyDo(end: BooleanConsumer?): WrapperCommand?

open fun finallyDo(end: Runnable?): WrapperCommand?

handleInterrupt

open fun handleInterrupt(handler: Runnable?): WrapperCommand?

hasRequirement

open fun hasRequirement(requirement: Subsystem?): Boolean

ignoringDisable

open fun ignoringDisable(doesRunWhenDisabled: Boolean): WrapperCommand?

initialize

open override fun initialize()

initSendable

open fun initSendable(builder: SendableBuilder?)

invoke

operator fun Command.invoke()

Operator invoke implementation for Command.

isFinished

open override fun isFinished(): Boolean

onlyIf

open fun onlyIf(condition: BooleanSupplier?): ConditionalCommand?

onlyWhile

open fun onlyWhile(condition: BooleanSupplier?): ParallelRaceGroup?

raceWith

open fun raceWith(vararg parallel: Command?): ParallelRaceGroup?

repeatedly

open fun repeatedly(): RepeatCommand?

runsWhenDisabled

open fun runsWhenDisabled(): Boolean

schedule

open fun ~~schedule~~()

scheduleIf

fun Command.scheduleIf(condition: Boolean)

Schedule this command when the provided condition is true.

unless

open fun unless(condition: BooleanSupplier?): ConditionalCommand?

until

open fun until(condition: BooleanSupplier?): ParallelRaceGroup?

withDeadline

open fun withDeadline(deadline: Command?): ParallelDeadlineGroup?

withInterruptBehavior

open fun withInterruptBehavior(interruptBehavior: Command.InterruptionBehavior?): WrapperCommand?

withName

open fun withName(name: String?): WrapperCommand?

withTimeout

open fun withTimeout(time: Time?): ParallelRaceGroup?

open fun withTimeout(seconds: Double): ParallelRaceGroup?