bugfix(physics): Fix diagonal movement speed discrepancy

[xezon]

• Fixes Locomotor makes units move faster diagonally #123

This change fixes the diagonal movement speed discrepancy.

The new 2d and 3d speeds are scaled to the average of the former min and max speeds.

TODO

• Replicate in Generals

[greptile-apps]

Greptile Summary

Introduces compatibility-gated 2D and 3D forward-speed compensation while preserving retail behavior for scripted movement.

• Adds global and scripted physics compatibility flags.
• Replaces direction-dependent forward-speed calculations with scaled dot products when compatibility mode is disabled.

Confidence Score: 5/5

The PR appears safe to merge in this follow-up review because no new blocking failure distinct from the existing thread remains.

No blocking failure remains beyond the issue already captured by the previous inline thread.

Important Files Changed

Filename	Overview
Core/GameEngine/Include/Common/GameDefines.h	Adds default compatibility flags controlling corrected forward-speed behavior globally and for scripted objects.
GeneralsMD/Code/GameEngine/Source/GameLogic/Object/Update/PhysicsUpdate.cpp	Adds compatibility-gated, direction-independent forward-speed calculations for 2D and 3D physics.

_{Reviews (2): Last reviewed commit: "Preserve legacy speeds for scripted move..." | Re-trigger Greptile}

[gamezerve]

Why is the horizontal movement speed being increased? In retail, units already move at their locomotor-defined speed when traveling horizontally or vertically. Wouldn't slowing down diagonal movement be the more appropriate solution? Also, changing movement speeds will inevitably alter the timing of scripted in-game cinematics.

[xezon]

Why is the horizontal movement speed being increased? In retail, units already move at their locomotor-defined speed when traveling horizontally or vertically. Wouldn't slowing down diagonal movement be the more appropriate solution?

Because then on average the game unit movements will be around 20% slower than originally, noticably making the game play with less pace.

Also, changing movement speeds will inevitably alter the timing of scripted in-game cinematics.

That is a fair point we probably need to think about.

[Mauller]

This is wrong, the speed is not the dot product, the dot product tells you the difference in direction between the two vectors. If it goes negative then it means your vectors are going in opposite directions.

The speed of a vector is the magnitude of the vector.

The speed for 2D is:
speed = sqrtf( sqr(m_vel.x) + sqr(m_vel.y) ); which you can then scale with a constant

The speed for 3D is:
speed = sqrtf( sqr(m_vel.x) + sqr(m_vel.y) + sqr(m_vel.z) ); then the same can be scaled with a constant.

you still need to check the dot product and negate the speed if the dot product is negative.

[xezon]

dot is correct.

Chat Gippy

Here's a side-by-side comparison using a true velocity magnitude of 100 in each case.

Facing	Moving	dir	vel	Original Function	Dot Product
East	East	(1.000, 0.000)	(100.00, 0.00)	100.00	100.00
North	North	(0.000, 1.000)	(0.00, 100.00)	100.00	100.00
45°	45°	(0.707, 0.707)	(70.71, 70.71)	70.71	100.00
East	Northeast	(1.000, 0.000)	(70.71, 70.71)	70.71	70.71
45°	East	(0.707, 0.707)	(100.00, 0.00)	70.71	70.71
30°	30°	(0.866, 0.500)	(86.60, 50.00)	79.06	100.00
60°	60°	(0.500, 0.866)	(50.00, 86.60)	79.06	100.00
15°	15°	(0.966, 0.259)	(96.59, 25.88)	93.54	100.00
75°	75°	(0.259, 0.966)	(25.88, 96.59)	93.54	100.00

This reveals that the original function is effectively applying a heading-dependent scale factor:

• 0° / 90°: ×1.000

• 15° / 75°: ×0.935

• 30° / 60°: ×0.791

• 45°: ×0.707

So if getForwardSpeed2D() is used in movement logic rather than just for display, the old code was inherently reducing the reported speed whenever the unit faced away from the world axes. That could explain why replacing it with the mathematically correct dot product changed the feel of movement.

[Mauller]

The dot product is not correct for calculating the speed. The only relation the dot product has with the speed is the direction of the movement in relation to the orientation of the model/hull. So whether it is forwards or backwards etc.

in the code, Dir is the direction vector for the objects model/hull to tell which way it is facing and m_vel is the motion vector for the movement of the objects.

the dot product is used to tell the difference in angle between Dir and m_vel so we can determine if the object is moving backwards in relation to the direction it is facing. If the dot product is negative then the two vectors are facing in opposite directions and the speed will be negative relative to the objects orientation.

You have to workout the magnitude of m_vel to determine the speed of the object, which is the equivalent to using Pythagoras theorem to workout the hypotenuse of a triangle.

The flaw in the original code is that they used vy and vx which are intermediate products of calculating the dot product between Dir and m_vel. These should never be used outside of that calculation as they are meaningless outside of that context.

Since these intermediate products are not unit scaled they give the faster motion in the diagonal direction, but they also don't give the true speed either.

[xezon]

Problem is speed = sqrtf( sqr(m_vel.x) + sqr(m_vel.y) ); does not account for object direction. If the object is facing sideways then it will not produce the same direction drag (or lack thereof). What the proposed solution does is eliminate the diagonal speed variance, but otherwise preserve the original average speed.

I tested it in game and it looked right, but I did not do a lab test. Maybe it needs a lab test.

[Mauller]

The m_vel value is already normalised, which means it correctly scales in all directions without the diagonal calculated vector magnitudes being larger than expected. The flaw in the original code is that they don't correctly calculate the speed since they use the intermediate dot product values which are not normalised values.

This function is just returning speed which is only a scalar value, it has no direction information within it apart from forwards and backwards.

Both calculations need to be done, speed = sqrtf( sqr(m_vel.x) + sqr(m_vel.y) ); and the dot product is used to determine if the speed is positive or negative.

Beyond this, to make the speeds, on average, closer to the original flawed speeds you can then scale the calculated speed just by multiplying it with a constant. This will scale in all directions due to m_vel already being normalised.

so finalSpeed = scalingValue * speed * dotProductDirection the dot product direction just being if it's positive or negative.

[xezon]

I am convinced implementation A is correct. The functions are for forward speed, not sideways speed. Dot product does exactly this. Keep in mind that Dot product also has a magnitude, but only forwards and backwards. As for the avg speed, I need to check why C is reported to be faster than both A and B in this test case.

[Skyaero42]

Ok, I think that both @Mauller and I misinterpreted the meaning of final speed. It is not supposed to be the magnitude of the speed vector, but the component of the speed vector that faces forward.

This function is effectively a vector rotation that returns the x-component of the rotated vector.

Given a vector v = (vx, vy) in a coordinate frame (x, y).
Now we rotate the coordinate frame into (x', y') such that the x-axis lines up with the direction of the object, i.e. d` = (1, 0) by definition. In the (x,y) frame the direction vector d = (cos a, sin a)

Rotating a vector with angle a yields:

v` = (vx cos a + vy sin a, -vx sin a + vy cos a)

note that rotating the direction vector yields our desired result
d` = (cos a cos a + sin a sin a, - cos a sin a + sin a cos a) = (1, 0).

Now v` represents the velocity vector in the direction coordinate frame, where the x-direction is the forward/backward speed and y-direction represent the sideways movement.

So for this function to return the forward speed component, it has to return v`x = vx cos a + vy sin a. This equals v * d ('*' being the dot product here).

So solution (A) is correct.

That does leave the discussion about DiagonalCompensation in my other post that - while statistically may yield correct average speeds - it can have major consequences on the gameplay and could be highly controversial.

[xezon]

speedAvgs | {2.0779447383905580, 1.9905874710383378, 1.9912092029274284}

I think the explanation for this is the discrepancy between Acceleration and Braking (aka Deceleration). When Acceleration is higher, then top speeds will be reached quicker than low speeds and therefore in certain circumstances, such as the circling planes, the average speed of EA's speed (C) will be higher (or lower).

Locomotor RaptorJetLocomotor
  Acceleration = 120.0 ; in dist/(sec^2)
  Braking = 10.0 ; in dist/(sec^2)

[Mauller]

So looking into this further, a bit like @Skyaero42 mentioned, it really comes down to what this function is meant to do and original intentions.

So i have not come across it being used in this way before, but when looking into it the use of the velocity vector and direction vector in a dot product is a bit of a special case. And it only works when the direction vector is properly normalised.

The dot product then gives the proportion of the speed in the direction of the direction vector. But only when |d| = 1 at all times.

So for the equation we start with v.x = |v||d| cosθ. If |d| = 1 at all times, then this simplifies to v.x = |v|cosθ which gives the speed in the direction of the direction vector in this case.

But with the way the original function was written, they appear to want to use the absolute speed rather than the component the speed in the direction of the object. The dot product is then only used to determine the direction of the sign of the speed.

The original calculation was wrong since they used the intermediate products of the dot product which are not normalised and cannot be used beyond calculating the dot product. So they cannot be used in the Pythagoras theorem to determine the speed.

So this function has two issues.

1. The true intent of the function needs determining in a wider context.
2. The original intent in the code and the name of the function can be interpreted in different ways.

And if it was meant to be using the component of the speed in the direction the object is facing, then this function also needs a debug check to make sure the direction vector is always normalised. The moment the direction vector is not normalised then the dot product cannot be used to determine the component of the speed in the direction the object is facing.

[xezon]

The intent of the function is clear by its name: GetForwardSpeed2D. It aims to return forward speed (and backwards speed). Its usage is also quite clear; used to find the delta between current and goal speed, and then apply the delta to accelerate or brake an object with.

[Skyaero42]

Because then on average the game unit movements will be around 20% slower than originally, noticably making the game play with less pace.

The amount of diagonal and straight movements is highly map dependent. A 2-player game where players start in the corners will have relatively more diagonal movements - therefore the game will be slower than before - than on a map where players start in the (middle) top and bottom - and increases the game speed compared to before.

I feel like this solution is too crude. It is such a major hack that has significant impact on how the game feels.

IF this solution is considered, it will need extensive testing among the community on different maps..

Also, as Pathfinding uses a grid based algorithm, therefore most movements are either horizontal/vertical or diagonal, but rarely any other angle.

[Float1ngFree]

Hell yeah, long time due!
Will need to adjust deliveries of transport payloads for OCLs and some other movement related properties, but this must be done regardless of any naysayers.

[xezon]

The amount of diagonal and straight movements is highly map dependent. A 2-player game where players start in the corners will have relatively more diagonal movements - therefore the game will be slower than before - than on a map where players start in the (middle) top and bottom - and increases the game speed compared to before.

Yes. But the total average of all movements will be right between former min and max speeds.

IF this solution is considered, it will need extensive testing among the community on different maps..

I would like to have this run as a trial.

Also, as Pathfinding uses a grid based algorithm, therefore most movements are either horizontal/vertical or diagonal, but rarely any other angle.

I do not understand this statement. Movements are free into any direction, for both ground and air units.

[xezon]

Also, changing movement speeds will inevitably alter the timing of scripted in-game cinematics.

I have addressed this and confirmed that it works correctly in mission cinematics.

From my POV this change is final right now.

[xezon]

TheSuperHackers ...