Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[wpilib] Update getAlliance() docs (NFC) #5971

Merged
merged 1 commit into from
Nov 28, 2023
Merged

[wpilib] Update getAlliance() docs (NFC) #5971

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions wpilibc/src/main/native/include/frc/DriverStation.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -274,14 +274,13 @@ class DriverStation final {
static int GetReplayNumber();

/**
* Return the alliance that the driver station says it is on from the FMS.
* Get the current alliance from the FMS.
*
* If the FMS is not connected, it is set from the team alliance setting on
* the driver station.
*
* This could return kRed or kBlue.
*
* @return The Alliance enum (kRed, kBlue or kInvalid)
* @return The alliance (red or blue) or an empty optional if the alliance is
* invalid
*/
static std::optional<Alliance> GetAlliance();

Expand Down
2 changes: 1 addition & 1 deletion wpilibj/src/main/java/edu/wpi/first/wpilibj/DriverStation.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1113,7 +1113,7 @@ public static int getReplayNumber() {
*
* <p>If the FMS is not connected, it is set from the team alliance setting on the driver station.
*
* @return the current alliance
* @return The alliance (red or blue) or an empty optional if the alliance is invalid
*/
public static Optional<Alliance> getAlliance() {
AllianceStationID allianceStationID = DriverStationJNI.getAllianceStation();
Expand Down