Team2890/allwpilib
4
0
Fork 0
mirror of https://github.com/wpilibsuite/allwpilib synced 2026-06-19 00:41:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

[wpilib] Add explanation for HID GetBumper/Touchpad deprecations (#7304)

Browse Source
This commit is contained in:
Ryan Blue
2024-10-28 22:29:42 -04:00
committed by GitHub
parent 412c042c6c
commit f03e0cdf6a
18 changed files with 190 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

33
wpilibj/src/generate/main/java/hid.java.jinja
View File

@@ -193,7 +193,8 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable
* Read the value of the left bumper (LB) button on the controller.
*
* @return The state of the button.
* @deprecated Use {@link getLeftBumperButton} instead
* @deprecated Use {@link getLeftBumperButton} instead. This function is deprecated for removal
* to make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getLeftBumper() {
@@ -204,7 +205,8 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable
* Read the value of the right bumper (RB) button on the controller.
*
* @return The state of the button.
* @deprecated Use {@link getRightBumperButton} instead
* @deprecated Use {@link getRightBumperButton} instead. This function is deprecated for removal
* to make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getRightBumper() {
@@ -215,7 +217,9 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable
* Whether the left bumper (LB) was pressed since the last check.
*
* @return Whether the button was pressed since the last check.
* @deprecated Use {@link getLeftBumperButtonPressed} instead
* @deprecated Use {@link getLeftBumperButtonPressed} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getLeftBumperPressed() {
@@ -226,7 +230,9 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable
* Whether the right bumper (RB) was pressed since the last check.
*
* @return Whether the button was pressed since the last check.
* @deprecated Use {@link getRightBumperButtonPressed} instead
* @deprecated Use {@link getRightBumperButtonPressed} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getRightBumperPressed() {
@@ -237,7 +243,9 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable
* Whether the left bumper (LB) was released since the last check.
*
* @return Whether the button was released since the last check.
* @deprecated Use {@link getLeftBumperButtonReleased} instead
* @deprecated Use {@link getLeftBumperButtonReleased} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getLeftBumperReleased() {
@@ -248,7 +256,9 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable
* Whether the right bumper (RB) was released since the last check.
*
* @return Whether the button was released since the last check.
* @deprecated Use {@link getRightBumperButtonReleased} instead
* @deprecated Use {@link getRightBumperButtonReleased} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getRightBumperReleased() {
@@ -259,7 +269,8 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable
* Read the value of the touchpad on the controller.
*
* @return The state of the touchpad.
* @deprecated Use {@link getTouchpadButton} instead
* @deprecated Use {@link getTouchpadButton} instead. This function is deprecated for removal to
* make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getTouchpad() {
@@ -270,7 +281,9 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable
* Whether the touchpad was pressed since the last check.
*
* @return Whether the touchpad was pressed since the last check.
* @deprecated Use {@link getTouchpadButtonPressed} instead
* @deprecated Use {@link getTouchpadButtonPressed} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getTouchpadPressed() {
@@ -281,7 +294,9 @@ public class {{ ConsoleName }}Controller extends GenericHID implements Sendable
* Whether the touchpad was released since the last check.
*
* @return Whether the touchpad was released since the last check.
* @deprecated Use {@link getTouchpadButtonReleased} instead
* @deprecated Use {@link getTouchpadButtonReleased} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getTouchpadReleased() {

12
wpilibj/src/generate/main/java/hidsim.java.jinja
View File

@@ -72,7 +72,8 @@ public class {{ ConsoleName }}ControllerSim extends GenericHIDSim {
* Change the value of the left bumper on the joystick.
*
* @param state the new value
* @deprecated Use {@link setLeftBumperButton} instead
* @deprecated Use {@link setLeftBumperButton} instead. This function is deprecated for removal
* to make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public void setLeftBumper(boolean state) {
@@ -83,7 +84,8 @@ public class {{ ConsoleName }}ControllerSim extends GenericHIDSim {
* Change the value of the right bumper on the joystick.
*
* @param state the new value
* @deprecated Use {@link setRightBumperButton} instead
* @deprecated Use {@link setRightBumperButton} instead. This function is deprecated for removal
* to make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public void setRightBumper(boolean state) {
@@ -94,7 +96,8 @@ public class {{ ConsoleName }}ControllerSim extends GenericHIDSim {
* Change the value of the touchpad button on the controller.
*
* @param value the new value
* @deprecated Use {@link setTouchpadButton} instead
* @deprecated Use {@link setTouchpadButton} instead. This function is deprecated for removal to
* make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public void setTouchpad(boolean value) {
@@ -105,7 +108,8 @@ public class {{ ConsoleName }}ControllerSim extends GenericHIDSim {
* Change the value of the touchpad button on the controller.
*
* @param value the new value
* @deprecated Use {@link setTouchpadButton} instead
* @deprecated Use {@link setTouchpadButton} instead. This function is deprecated for removal to
* make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public void setTouchpad(boolean value) {

11
wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/PS4Controller.java generated
View File

@@ -720,7 +720,8 @@ public class PS4Controller extends GenericHID implements Sendable {
* Read the value of the touchpad on the controller.
*
* @return The state of the touchpad.
* @deprecated Use {@link getTouchpadButton} instead
* @deprecated Use {@link getTouchpadButton} instead. This function is deprecated for removal to
* make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getTouchpad() {
@@ -731,7 +732,9 @@ public class PS4Controller extends GenericHID implements Sendable {
* Whether the touchpad was pressed since the last check.
*
* @return Whether the touchpad was pressed since the last check.
* @deprecated Use {@link getTouchpadButtonPressed} instead
* @deprecated Use {@link getTouchpadButtonPressed} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getTouchpadPressed() {
@@ -742,7 +745,9 @@ public class PS4Controller extends GenericHID implements Sendable {
* Whether the touchpad was released since the last check.
*
* @return Whether the touchpad was released since the last check.
* @deprecated Use {@link getTouchpadButtonReleased} instead
* @deprecated Use {@link getTouchpadButtonReleased} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getTouchpadReleased() {

11
wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/PS5Controller.java generated
View File

@@ -720,7 +720,8 @@ public class PS5Controller extends GenericHID implements Sendable {
* Read the value of the touchpad on the controller.
*
* @return The state of the touchpad.
* @deprecated Use {@link getTouchpadButton} instead
* @deprecated Use {@link getTouchpadButton} instead. This function is deprecated for removal to
* make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getTouchpad() {
@@ -731,7 +732,9 @@ public class PS5Controller extends GenericHID implements Sendable {
* Whether the touchpad was pressed since the last check.
*
* @return Whether the touchpad was pressed since the last check.
* @deprecated Use {@link getTouchpadButtonPressed} instead
* @deprecated Use {@link getTouchpadButtonPressed} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getTouchpadPressed() {
@@ -742,7 +745,9 @@ public class PS5Controller extends GenericHID implements Sendable {
* Whether the touchpad was released since the last check.
*
* @return Whether the touchpad was released since the last check.
* @deprecated Use {@link getTouchpadButtonReleased} instead
* @deprecated Use {@link getTouchpadButtonReleased} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getTouchpadReleased() {

22
wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/StadiaController.java generated
View File

@@ -736,7 +736,8 @@ public class StadiaController extends GenericHID implements Sendable {
* Read the value of the left bumper (LB) button on the controller.
*
* @return The state of the button.
* @deprecated Use {@link getLeftBumperButton} instead
* @deprecated Use {@link getLeftBumperButton} instead. This function is deprecated for removal
* to make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getLeftBumper() {
@@ -747,7 +748,8 @@ public class StadiaController extends GenericHID implements Sendable {
* Read the value of the right bumper (RB) button on the controller.
*
* @return The state of the button.
* @deprecated Use {@link getRightBumperButton} instead
* @deprecated Use {@link getRightBumperButton} instead. This function is deprecated for removal
* to make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getRightBumper() {
@@ -758,7 +760,9 @@ public class StadiaController extends GenericHID implements Sendable {
* Whether the left bumper (LB) was pressed since the last check.
*
* @return Whether the button was pressed since the last check.
* @deprecated Use {@link getLeftBumperButtonPressed} instead
* @deprecated Use {@link getLeftBumperButtonPressed} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getLeftBumperPressed() {
@@ -769,7 +773,9 @@ public class StadiaController extends GenericHID implements Sendable {
* Whether the right bumper (RB) was pressed since the last check.
*
* @return Whether the button was pressed since the last check.
* @deprecated Use {@link getRightBumperButtonPressed} instead
* @deprecated Use {@link getRightBumperButtonPressed} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getRightBumperPressed() {
@@ -780,7 +786,9 @@ public class StadiaController extends GenericHID implements Sendable {
* Whether the left bumper (LB) was released since the last check.
*
* @return Whether the button was released since the last check.
* @deprecated Use {@link getLeftBumperButtonReleased} instead
* @deprecated Use {@link getLeftBumperButtonReleased} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getLeftBumperReleased() {
@@ -791,7 +799,9 @@ public class StadiaController extends GenericHID implements Sendable {
* Whether the right bumper (RB) was released since the last check.
*
* @return Whether the button was released since the last check.
* @deprecated Use {@link getRightBumperButtonReleased} instead
* @deprecated Use {@link getRightBumperButtonReleased} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getRightBumperReleased() {

22
wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/XboxController.java generated
View File

@@ -612,7 +612,8 @@ public class XboxController extends GenericHID implements Sendable {
* Read the value of the left bumper (LB) button on the controller.
*
* @return The state of the button.
* @deprecated Use {@link getLeftBumperButton} instead
* @deprecated Use {@link getLeftBumperButton} instead. This function is deprecated for removal
* to make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getLeftBumper() {
@@ -623,7 +624,8 @@ public class XboxController extends GenericHID implements Sendable {
* Read the value of the right bumper (RB) button on the controller.
*
* @return The state of the button.
* @deprecated Use {@link getRightBumperButton} instead
* @deprecated Use {@link getRightBumperButton} instead. This function is deprecated for removal
* to make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getRightBumper() {
@@ -634,7 +636,9 @@ public class XboxController extends GenericHID implements Sendable {
* Whether the left bumper (LB) was pressed since the last check.
*
* @return Whether the button was pressed since the last check.
* @deprecated Use {@link getLeftBumperButtonPressed} instead
* @deprecated Use {@link getLeftBumperButtonPressed} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getLeftBumperPressed() {
@@ -645,7 +649,9 @@ public class XboxController extends GenericHID implements Sendable {
* Whether the right bumper (RB) was pressed since the last check.
*
* @return Whether the button was pressed since the last check.
* @deprecated Use {@link getRightBumperButtonPressed} instead
* @deprecated Use {@link getRightBumperButtonPressed} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getRightBumperPressed() {
@@ -656,7 +662,9 @@ public class XboxController extends GenericHID implements Sendable {
* Whether the left bumper (LB) was released since the last check.
*
* @return Whether the button was released since the last check.
* @deprecated Use {@link getLeftBumperButtonReleased} instead
* @deprecated Use {@link getLeftBumperButtonReleased} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getLeftBumperReleased() {
@@ -667,7 +675,9 @@ public class XboxController extends GenericHID implements Sendable {
* Whether the right bumper (RB) was released since the last check.
*
* @return Whether the button was released since the last check.
* @deprecated Use {@link getRightBumperButtonReleased} instead
* @deprecated Use {@link getRightBumperButtonReleased} instead. This function is deprecated for
* removal to make function names consistent to allow the HID classes to be automatically
* generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public boolean getRightBumperReleased() {

3
wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/PS4ControllerSim.java generated
View File

@@ -220,7 +220,8 @@ public class PS4ControllerSim extends GenericHIDSim {
* Change the value of the touchpad button on the controller.
*
* @param value the new value
* @deprecated Use {@link setTouchpadButton} instead
* @deprecated Use {@link setTouchpadButton} instead. This function is deprecated for removal to
* make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public void setTouchpad(boolean value) {

3
wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/PS5ControllerSim.java generated
View File

@@ -220,7 +220,8 @@ public class PS5ControllerSim extends GenericHIDSim {
* Change the value of the touchpad button on the controller.
*
* @param value the new value
* @deprecated Use {@link setTouchpadButton} instead
* @deprecated Use {@link setTouchpadButton} instead. This function is deprecated for removal to
* make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public void setTouchpad(boolean value) {

6
wpilibj/src/generated/main/java/edu/wpi/first/wpilibj/simulation/XboxControllerSim.java generated
View File

@@ -184,7 +184,8 @@ public class XboxControllerSim extends GenericHIDSim {
* Change the value of the left bumper on the joystick.
*
* @param state the new value
* @deprecated Use {@link setLeftBumperButton} instead
* @deprecated Use {@link setLeftBumperButton} instead. This function is deprecated for removal
* to make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public void setLeftBumper(boolean state) {
@@ -195,7 +196,8 @@ public class XboxControllerSim extends GenericHIDSim {
* Change the value of the right bumper on the joystick.
*
* @param state the new value
* @deprecated Use {@link setRightBumperButton} instead
* @deprecated Use {@link setRightBumperButton} instead. This function is deprecated for removal
* to make function names consistent to allow the HID classes to be automatically generated.
*/
@Deprecated(since = "2025", forRemoval = true)
public void setRightBumper(boolean state) {