Package frc.robot.subsystems.gameplaystate

Enum Class GameplayState

java.lang.Object

java.lang.Enum<GameplayState>

frc.robot.subsystems.gameplaystate.GameplayState

All Implemented Interfaces:

Serializable, Comparable<GameplayState>, Constable

public enum GameplayState
extends Enum<GameplayState>

Enumerates the high-level operating modes the robot can be in during a match.

Each state describes a coordinated configuration of multiple subsystems. When the robot transitions into a state, the GameplayStateSubsystem publishes the new value and the command factory schedules the appropriate parallel command group so every mechanism moves into position together.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
AUTO_CYCLE	Combined harvest and fire mode for maximum autonomous throughput.
EJECT	Reverses the ball path to clear a jam.
FIRE_READY	Robot is primed to shoot Fuel.
HARVEST_READY	Robot is configured to collect Fuel from the field.
IDLE	All mechanisms at rest.
TRAVEL	Safe transit mode for moving across the field.
TRENCH_TRAVEL	Low-profile transit mode for passing under field obstacles such as the trench.

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Returns a human-readable name for dashboard display and telemetry logging.
static GameplayState	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GameplayState[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

IDLE

public static final GameplayState IDLE

All mechanisms at rest. Harvester stowed, turret centered, shooter at idle RPM, ball-path subsystems idle.

This is the default state when no specific action is requested.

HARVEST_READY

public static final GameplayState HARVEST_READY

Robot is configured to collect Fuel from the field. Harvester deployed, intake and feeder running forward, indexer in feed mode, shooter at idle RPM, turret tracking the field target.

FIRE_READY

public static final GameplayState FIRE_READY

Robot is primed to shoot Fuel. Shooter spun up to distance-based RPM, turret tracking the field target, indexer and feeder primed to feed on command. Harvester stowed.

AUTO_CYCLE

public static final GameplayState AUTO_CYCLE

Combined harvest and fire mode for maximum autonomous throughput. Turret tracks the target while the intake collects Fuel simultaneously. All ball-path subsystems run forward and the shooter stays spun up.

EJECT

public static final GameplayState EJECT

Reverses the ball path to clear a jam. Intake, feeder, and indexer run in reverse. Shooter stops. Harvester stays in its current position.

TRAVEL

public static final GameplayState TRAVEL

Safe transit mode for moving across the field. The harvester stows to stay inside the frame perimeter while all other mechanisms idle.

TRENCH_TRAVEL

public static final GameplayState TRENCH_TRAVEL

Low-profile transit mode for passing under field obstacles such as the trench. The harvester deploys so the robot's profile clears the trench opening while all other mechanisms idle.

Method Details

values

public static GameplayState[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static GameplayState valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getDisplayName

public String getDisplayName()

Returns a human-readable name for dashboard display and telemetry logging.

Returns:

display-friendly state name