diff --git a/wpilibc/src/main/native/include/frc/DriverStation.h b/wpilibc/src/main/native/include/frc/DriverStation.h index 4cbf6daabb..99723d2335 100644 --- a/wpilibc/src/main/native/include/frc/DriverStation.h +++ b/wpilibc/src/main/native/include/frc/DriverStation.h @@ -227,6 +227,9 @@ class DriverStation final { /** * Returns the game specific message provided by the FMS. * + * If the FMS is not connected, it is set from the game data setting on the + * driver station. + * * @return A string containing the game specific message. */ static std::string GetGameSpecificMessage(); @@ -262,7 +265,10 @@ class DriverStation final { static int GetReplayNumber(); /** - * Return the alliance that the driver station says it is on. + * Return the alliance that the driver station says it is on 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. * @@ -271,7 +277,10 @@ class DriverStation final { static Alliance GetAlliance(); /** - * Return the driver station location on the field. + * Return the driver station location from the FMS. + * + * If the FMS is not connected, it is set from the team alliance setting on + * the driver station. * * This could return 1, 2, or 3. * diff --git a/wpilibj/src/main/java/edu/wpi/first/wpilibj/DriverStation.java b/wpilibj/src/main/java/edu/wpi/first/wpilibj/DriverStation.java index e9d593cd1d..035c754edd 100644 --- a/wpilibj/src/main/java/edu/wpi/first/wpilibj/DriverStation.java +++ b/wpilibj/src/main/java/edu/wpi/first/wpilibj/DriverStation.java @@ -970,7 +970,9 @@ public final class DriverStation { } /** - * Get the game specific message. + * Get the game specific message from the FMS. + * + *

If the FMS is not connected, it is set from the game data setting on the driver station. * * @return the game specific message */ @@ -984,7 +986,7 @@ public final class DriverStation { } /** - * Get the event name. + * Get the event name from the FMS. * * @return the event name */ @@ -998,7 +1000,7 @@ public final class DriverStation { } /** - * Get the match type. + * Get the match type from the FMS. * * @return the match type */ @@ -1023,7 +1025,7 @@ public final class DriverStation { } /** - * Get the match number. + * Get the match number from the FMS. * * @return the match number */ @@ -1037,7 +1039,7 @@ public final class DriverStation { } /** - * Get the replay number. + * Get the replay number from the FMS. * * @return the replay number */ @@ -1053,6 +1055,8 @@ public final class DriverStation { /** * 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. + * * @return the current alliance */ public static Alliance getAlliance() { @@ -1078,7 +1082,9 @@ public final class DriverStation { } /** - * Gets the location of the team's driver station controls. + * Gets the location of the team's driver station controls from the FMS. + * + *

If the FMS is not connected, it is set from the team alliance setting on the driver station. * * @return the location of the team's driver station controls: 1, 2, or 3 */