strafehud: improve some descriptions and variable names

diff --git a/_hud_common.cfg b/_hud_common.cfg
index f5415dd828c97a5553a30593f60c4181046da9b6..8bd81ef3c2a318f392078d5b135d706c50bc2c34 100644 (file)
--- a/_hud_common.cfg
+++ b/_hud_common.cfg
@@ -179,11 +179,11 @@ seta hud_panel_strafehud_angle_arrow_size "0.5" "size of the arrow (relative to
 seta hud_panel_strafehud_bestangle "1" "set to \"1\" to enable a ghost angle indicator showing the best angle to gain maximum acceleration"
 seta hud_panel_strafehud_bestangle_color "1 1 1" "color of the indicator showing the best angle to gain maximum acceleration"
 seta hud_panel_strafehud_bestangle_alpha "0.5" "opacity of the indicator showing the best angle to gain maximum acceleration"
-seta hud_panel_strafehud_switch "1" "set to \"1\" to enable the switch indicator showing the angle to move to when switching sides"
-seta hud_panel_strafehud_switch_minspeed "-1" "minimum speed in qu/s at which switch indicator(s) which are used to aid changing strafe direction will be shown (set to -1 for dynamic minspeed)"
-seta hud_panel_strafehud_switch_color "1 1 0" "color of the switch indicator"
-seta hud_panel_strafehud_switch_alpha "1" "opacity of the switch indicator"
-seta hud_panel_strafehud_switch_width "0.003" "width of the strafe angle indicator(s) (relative to the strafe bar width)"
+seta hud_panel_strafehud_switch "1" "set to \"1\" to enable the strafe angle indicator showing the angle to move to when changing side"
+seta hud_panel_strafehud_switch_minspeed "-1" "minimum speed in qu/s at which angle indicator(s) which are used to aid changing strafe direction will be shown (set to -1 for dynamic minspeed)"
+seta hud_panel_strafehud_switch_color "1 1 0" "color of the strafe angle indicators for changing strafe direction"
+seta hud_panel_strafehud_switch_alpha "1" "opacity of the strafe angle indicators for changing strafe direction"
+seta hud_panel_strafehud_switch_width "0.003" "width of the strafe angle indicators for changing strafe direction (relative to the strafe bar width)"
 seta hud_panel_strafehud_direction "0" "set to \"1\" to enable the direction caps to see in which direction you are currently strafing"
 seta hud_panel_strafehud_direction_color "0 0.5 1" "color of the direction caps which indicate the direction the player is currently strafing towards"
 seta hud_panel_strafehud_direction_alpha "1" "opacity of the direction caps which indicate the direction the player is currently strafing towards"

diff --git a/qcsrc/client/hud/panel/strafehud.qc b/qcsrc/client/hud/panel/strafehud.qc
index 6c717e82ffa8f0b379b3aa9dd23fe3d7b9160f54..d704457df6be4f58e2d0ff686da2335b8525d05f 100644 (file)
--- a/qcsrc/client/hud/panel/strafehud.qc
+++ b/qcsrc/client/hud/panel/strafehud.qc
@@ -170,12 +170,12 @@ void HUD_StrafeHUD()
                vector currentangle_size;
                float  bestangle;
                float  prebestangle;
-               float  odd_bestangle;
+               float  opposite_bestangle;
                float  bestangle_offset;
-               float  switch_bestangle_offset;
-               bool   odd_angles                    = false;
-               float  odd_bestangle_offset          = 0;
-               float  switch_odd_bestangle_offset   = 0;
+               float  changeangle_offset;
+               bool   opposite_direction            = false;
+               float  opposite_bestangle_offset     = 0;
+               float  opposite_changeangle_offset   = 0;
                float  bestangle_width;
                float  accelzone_left_offset;
                float  accelzone_right_offset;
@@ -560,16 +560,16 @@ void HUD_StrafeHUD()
                // best angle to strafe at
                // in case of ground friction we may decelerate if the acceleration is smaller than the speed loss from friction
                real_bestangle = bestangle = (strafespeed > bestspeed ? acos(bestspeed / strafespeed) * RAD2DEG : 0);
-               odd_bestangle = -bestangle;
+               opposite_bestangle = -bestangle;
                real_prebestangle = prebestangle = (strafespeed > movespeed ? acos(movespeed / strafespeed) * RAD2DEG : 0);
                if(direction == STRAFEHUD_DIRECTION_LEFT) // the angle becomes negative in case we strafe left
                {
                        bestangle *= -1;
-                       odd_bestangle *= -1;
+                       opposite_bestangle *= -1;
                        prebestangle *= -1;
                }
                bestangle -= wishangle;
-               odd_bestangle -= wishangle;
+               opposite_bestangle -= wishangle;
                prebestangle -= wishangle;
 
                // various offsets and size calculations of hud indicator elements
@@ -587,15 +587,15 @@ void HUD_StrafeHUD()
                        currentangle_offset = bound(-hudangle / 2, angle, hudangle / 2) / hudangle * panel_size.x + panel_size.x / 2;
 
                // best strafe acceleration angle
-               bestangle_offset        =  bestangle / hudangle * panel_size.x + panel_size.x / 2;
-               switch_bestangle_offset = -bestangle / hudangle * panel_size.x + panel_size.x / 2;
+               bestangle_offset   =  bestangle / hudangle * panel_size.x + panel_size.x / 2;
+               changeangle_offset = -bestangle / hudangle * panel_size.x + panel_size.x / 2;
                bestangle_width = max(panel_size.x * autocvar_hud_panel_strafehud_switch_width, 1);
 
                if((angle > -wishangle && direction == STRAFEHUD_DIRECTION_LEFT) || (angle < -wishangle && direction == STRAFEHUD_DIRECTION_RIGHT))
                {
-                       odd_angles = true;
-                       odd_bestangle_offset = odd_bestangle / hudangle * panel_size.x + panel_size.x / 2;
-                       switch_odd_bestangle_offset = (odd_bestangle + bestangle * 2) / hudangle * panel_size.x + panel_size.x / 2;
+                       opposite_direction = true;
+                       opposite_bestangle_offset = opposite_bestangle / hudangle * panel_size.x + panel_size.x / 2;
+                       opposite_changeangle_offset = (opposite_bestangle + bestangle * 2) / hudangle * panel_size.x + panel_size.x / 2;
                }
                // direction indicator
                direction_size_vertical.x = autocvar_hud_panel_strafehud_direction_width;
@@ -669,9 +669,9 @@ void HUD_StrafeHUD()
                        {
                                shift_offset = -currentangle_offset;
                                bestangle_offset += shift_offset;
-                               switch_bestangle_offset += shift_offset;
-                               odd_bestangle_offset += shift_offset;
-                               switch_odd_bestangle_offset += shift_offset;
+                               changeangle_offset += shift_offset;
+                               opposite_bestangle_offset += shift_offset;
+                               opposite_changeangle_offset += shift_offset;
                        }
                        if(direction == STRAFEHUD_DIRECTION_LEFT)
                                shift_offset += -360 / hudangle * panel_size.x;
@@ -741,31 +741,31 @@ void HUD_StrafeHUD()
                        // only draw indicators if minspeed is reached
                        if(autocvar_hud_panel_strafehud_switch && speed >= minspeed && bestangle_width > 0 && autocvar_hud_panel_strafehud_switch_alpha > 0)
                        {
-                               // draw the switch indicator(s)
-                               float offset = !odd_angles ? bestangle_offset : odd_bestangle_offset;
-                               float switch_offset = !odd_angles ? switch_bestangle_offset : switch_odd_bestangle_offset;
+                               // draw the change indicator(s)
+                               float offset = !opposite_direction ? changeangle_offset : opposite_changeangle_offset;
+                               float opposite_offset = !opposite_direction ? bestangle_offset : opposite_bestangle_offset;
 
                                offset = StrafeHUD_projectOffset(offset, hudangle, false);
-                               switch_offset = StrafeHUD_projectOffset(switch_offset, hudangle, false);
+                               opposite_offset = StrafeHUD_projectOffset(opposite_offset, hudangle, false);
 
-                               // remove switch indicator width from offset
+                               // remove change indicator width from offset
                                if(direction == STRAFEHUD_DIRECTION_LEFT)
                                {
-                                       if(!odd_angles)
-                                               offset -= bestangle_width;
+                                       if(!opposite_direction)
+                                               opposite_offset -= bestangle_width;
                                        else
-                                               switch_offset -= bestangle_width;
+                                               offset -= bestangle_width;
                                }
                                else
                                {
-                                       if(!odd_angles)
-                                               switch_offset -= bestangle_width;
-                                       else
+                                       if(!opposite_direction)
                                                offset -= bestangle_width;
+                                       else
+                                               opposite_offset -= bestangle_width;
                                }
 
                                HUD_Panel_DrawStrafeHUD(
-                                       switch_offset, bestangle_width, hidden_width,
+                                       offset, bestangle_width, hidden_width,
                                        autocvar_hud_panel_strafehud_switch_color,
                                        autocvar_hud_panel_strafehud_switch_alpha * panel_fg_alpha,
                                        STRAFEHUD_STYLE_DRAWFILL, STRAFEHUD_GRADIENT_NONE,
@@ -773,7 +773,7 @@ void HUD_StrafeHUD()
 
                                if(direction == STRAFEHUD_DIRECTION_NONE)
                                        HUD_Panel_DrawStrafeHUD(
-                                               offset, bestangle_width, hidden_width,
+                                               opposite_offset, bestangle_width, hidden_width,
                                                autocvar_hud_panel_strafehud_switch_color,
                                                autocvar_hud_panel_strafehud_switch_alpha * panel_fg_alpha,
                                                STRAFEHUD_STYLE_DRAWFILL, STRAFEHUD_GRADIENT_NONE,
@@ -852,7 +852,7 @@ void HUD_StrafeHUD()
                        bool indicator_direction = direction == STRAFEHUD_DIRECTION_LEFT;
                        // invert left/right when strafing backwards or when strafing towards the opposite side indicated by the direction variable
                        // if both conditions are true then it's inverted twice hence not inverted at all
-                       if(!fwd != odd_angles)
+                       if(!fwd != opposite_direction)
                                indicator_direction = !indicator_direction;
 
                        // draw the direction indicator caps at the sides of the hud
@@ -964,7 +964,7 @@ void HUD_StrafeHUD()
                float angleheight_offset = currentangle_size.y;
                float ghost_offset = 0;
                if(autocvar_hud_panel_strafehud_bestangle && direction != STRAFEHUD_DIRECTION_NONE)
-                       ghost_offset = bound(0, (odd_angles ? odd_bestangle_offset : bestangle_offset), panel_size.x);
+                       ghost_offset = bound(0, (opposite_direction ? opposite_bestangle_offset : bestangle_offset), panel_size.x);
 
                currentangle_offset = StrafeHUD_projectOffset(currentangle_offset, hudangle, false);
                ghost_offset = StrafeHUD_projectOffset(ghost_offset, hudangle, false);