Skip to content

Commit ddf1ee9

Browse files
committed
Improve documentation for MotionInput
1 parent 4e97b7b commit ddf1ee9

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

protobuf_definitions/message_formats.proto

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,15 +26,20 @@ message BinlogRecord {
2626
// Used to indicate the desired motion in each direction.
2727
// Typically these values map to the left and right joystick for motion,
2828
// and the left and right trigger for the slow and boost modifiers.
29+
//
30+
// You can use the slow and boost modifiers to increase or decrease the speed
31+
// of the motion, from the default baseline.
32+
33+
// If you use both values at the same time they cancel each other out.
2934
message MotionInput {
3035
float surge = 1; // Forward (positive) and backwards (negative) movement. (-1..1)
3136
float sway = 2; // Right (positive) and left (negative) lateral movement (-1..1)
3237
float heave = 3; // Descend (positive) and ascend (negative) movement (-1..1)
3338
float roll = 7; // Roll left (negative) or right (positive). (-1..1)
3439
float pitch = 8; // Pitch down (negative) or up (positive). (-1..1)
3540
float yaw = 4; // Left (positive) and right (negative) movement (-1..1)
36-
float slow = 5; // Multiplier used to reduce the speed of the motion (0..1)
37-
float boost = 6; // Multiplier used to increase the speed of the motion (0..1)
41+
float slow = 5; // Modifier used to reduce the speed of the motion (0..1)
42+
float boost = 6; // Modifier used to increase the speed of the motion (0..1)
3843
}
3944

4045
// Lights message used to represent the intensity of the main light or external lights.

0 commit comments

Comments
 (0)