Skip to content

Commit 167d1c6

Browse files
committed
Clarify sequential shift position docs
1 parent 1d13cfd commit 167d1c6

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

src/SimRacing.h

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1154,18 +1154,24 @@ namespace SimRacing {
11541154
bool inSequentialMode() const;
11551155

11561156
/**
1157-
* Check if the sequential shifter is shifted up
1157+
* Check if the sequential shifter is in the shift up position
1158+
*
1159+
* When in sequential mode, the shifter is considered to be in the
1160+
* "shift up" position when it is pulled towards the user.
11581161
*
1159-
* @returns 'true' if the sequential shifter is shifted up,
1160-
* 'false' otherwise
1162+
* @returns 'true' if the sequential shifter is in the shift up
1163+
* position, 'false' otherwise
11611164
*/
11621165
bool getShiftUp() const;
11631166

11641167
/**
1165-
* Check if the sequential shifter is shifted down
1168+
* Check if the sequential shifter is in the shift down position
11661169
*
1167-
* @returns 'true' if the sequential shifter is shifted down,
1168-
* 'false' otherwise
1170+
* When in sequential mode, the shifter is considered to be in the
1171+
* "shift down" position when it is pushed away from the user.
1172+
*
1173+
* @returns 'true' if the sequential shifter is in the shift down
1174+
* position, 'false' otherwise
11691175
*/
11701176
bool getShiftDown() const;
11711177

0 commit comments

Comments
 (0)