ProxyCommand

class commands2.ProxyCommand(*args, **kwargs)

Bases: Command

Schedules a given command when this command is initialized and ends when it ends, but does not directly run it. Use this for including a command in a composition without adding its requirements, but only if you know what you are doing. If you are unsure, see the WPILib docs for a complete explanation of proxy semantics. Do not proxy a command from a subsystem already required by the composition, or else the composition will cancel itself when the proxy is reached. If this command is interrupted, it will cancel the command.

Creates a new ProxyCommand that schedules the given command when initialized, and ends when it is no longer scheduled.

Parameters:

command – the command to run by proxy

end(interrupted: bool)

The action to take when the command ends. Called when either the command finishes normally, or when it interrupted/canceled.

Do not schedule commands here that share requirements with this command. Use andThen() instead.

Parameters:

interrupted – whether the command was interrupted/canceled

execute()

The main body of a command. Called repeatedly while the command is scheduled.

initSendable(builder: wpiutil._wpiutil.SendableBuilder) → None

Initializes this Sendable object.

Parameters:

builder – sendable builder

initialize()

The initial subroutine of a command. Called once when the command is initially scheduled.

isFinished() → bool

Whether the command has finished. Once a command finishes, the scheduler will call its commands2.Command.end() method and un-schedule it.

Returns:

whether the command has finished.

runsWhenDisabled() → bool

Whether the given command should run when the robot is disabled. Override to return true if the command should run when disabled.

Returns:

true. Otherwise, this proxy would cancel commands that do run when disabled.