dallasgroot/0ad
1
0
Fork 0
mirror of https://gitea.wildfiregames.com/0ad/0ad synced 2026-06-16 05:13:58 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions 3
0ad/source/simulation2/components/tests/test_Position.h
josue fc6a908775 Don't send redundant PositionChanged messages 
UnitAI constantly calls FaceTowardsTarget while attacking or gathering,
broadcasting an MT_PositionChanged message each time even when the
entity already faces the target. With many units fighting, that floods
the message bus (range manager, obstruction, minimap, AI proxy, ...)
every turn.

This was attempted in 080599442f by returning early from TurnTo, but
MoveAndTurnTo relies on TurnTo to advertise the movement, so units
walking in a straight line stopped advertising their position and LOS
broke (#6844), which led to the revert in 3fb7319df7.

Instead, deduplicate in AdvertisePositionChanges itself: remember the
data of the last message sent and skip the message when it wouldn't
change anything. Since the comparison covers the whole message data, a
movement with an unchanged angle is still advertised.

Add a regression test covering both #7654 and the #6844 scenario.

Fixes: #7654

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-06-12 15:32:07 +02:00

324 lines
12 KiB
C++
Raw Blame History

/* Copyright (C) 2026 Wildfire Games.
* This file is part of 0 A.D.
*
* 0 A.D. is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2 of the License, or
* (at your option) any later version.
*
* 0 A.D. is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with 0 A.D. If not, see <http://www.gnu.org/licenses/>.
*/
#include "lib/self_test.h"
#include "maths/Fixed.h"
#include "maths/FixedVector3D.h"
#include "maths/Matrix3D.h"
#include "maths/Vector3D.h"
#include "ps/XML/Xeromyces.h"
#include "scriptinterface/ScriptInterface.h"
#include "simulation2/MessageTypes.h"
#include "simulation2/components/ICmpPosition.h"
#include "simulation2/components/ICmpWaterManager.h"
#include "simulation2/helpers/Position.h"
#include "simulation2/system/Component.h"
#include "simulation2/system/ComponentTest.h"
#include "simulation2/system/Entity.h"
#include <memory>
#include <string>
class MockWater : public ICmpWaterManager
{
public:
DEFAULT_MOCK_COMPONENT()
entity_pos_t GetWaterLevel(entity_pos_t /*x*/, entity_pos_t /*z*/) const override
{
return entity_pos_t::FromInt(100);
}
float GetExactWaterLevel(float /*x*/, float /*z*/) const override
{
return 100.f;
}
void RecomputeWaterData() override
{
}
void SetWaterLevel(entity_pos_t /*h*/) override
{
}
};
class MockPositionChangedListener : public IComponent
{
public:
DEFAULT_MOCK_COMPONENT()
JS::HandleValue GetJSInstance() const override
{
return JS::UndefinedHandleValue;
}
bool NewJSObject(const ScriptInterface&, JS::MutableHandleObject) const override
{
return false;
}
int m_Count = 0;
bool m_LastInWorld = false;
entity_pos_t m_LastX, m_LastZ;
entity_angle_t m_LastRotY;
void HandleMessage(const CMessage& msg, bool /*global*/) override
{
if (msg.GetType() != MT_PositionChanged)
return;
const CMessagePositionChanged& msgData = static_cast<const CMessagePositionChanged&>(msg);
++m_Count;
m_LastInWorld = msgData.inWorld;
m_LastX = msgData.x;
m_LastZ = msgData.z;
m_LastRotY = msgData.a;
}
};
class TestCmpPosition : public CxxTest::TestSuite
{
public:
static CFixedVector3D fixedvec(int x, int y, int z)
{
return CFixedVector3D(fixed::FromInt(x), fixed::FromInt(y), fixed::FromInt(z));
}
void test_basic()
{
CXeromycesEngine xeromycesEngine;
ComponentTestHelper test(*g_ScriptContext);
MockTerrain terrain;
test.AddMock(SYSTEM_ENTITY, IID_Terrain, terrain);
ICmpPosition* cmp = test.Add<ICmpPosition>(CID_Position, "<Anchor>upright</Anchor><Altitude>23</Altitude><Floating>false</Floating>");
// Defaults
TS_ASSERT(!cmp->IsInWorld());
TS_ASSERT_EQUALS(cmp->GetHeightOffset(), entity_pos_t::FromInt(23));
TS_ASSERT_EQUALS(cmp->GetRotation(), fixedvec(0, 0, 0));
// Change height offset
cmp->SetHeightOffset(entity_pos_t::FromInt(10));
TS_ASSERT_EQUALS(cmp->GetHeightOffset(), entity_pos_t::FromInt(10));
// Move out of world, while currently out of world
cmp->MoveOutOfWorld();
TS_ASSERT(!cmp->IsInWorld());
// Jump into world
cmp->JumpTo(entity_pos_t::FromInt(0), entity_pos_t::FromInt(0));
TS_ASSERT(cmp->IsInWorld());
// Move out of world, while currently in world
cmp->MoveOutOfWorld();
TS_ASSERT(!cmp->IsInWorld());
// Move into world
cmp->MoveTo(entity_pos_t::FromInt(100), entity_pos_t::FromInt(200));
TS_ASSERT(cmp->IsInWorld());
// Position computed from move plus terrain
TS_ASSERT_EQUALS(cmp->GetPosition(), fixedvec(100, 60, 200));
// Interpolated position should be constant
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(0.0f).GetTranslation(), CVector3D(100, 60, 200));
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(0.5f).GetTranslation(), CVector3D(100, 60, 200));
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(1.0f).GetTranslation(), CVector3D(100, 60, 200));
// No TurnStart message, so this move doesn't affect the interpolation
cmp->MoveTo(entity_pos_t::FromInt(0), entity_pos_t::FromInt(0));
// Move smoothly to new position
cmp->MoveTo(entity_pos_t::FromInt(200), entity_pos_t::FromInt(0));
// Position computed from move plus terrain
TS_ASSERT_EQUALS(cmp->GetPosition(), fixedvec(200, 60, 0));
// Interpolated position should vary, from original move into world to new move
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(0.0f).GetTranslation(), CVector3D(100, 60, 200));
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(0.5f).GetTranslation(), CVector3D(150, 60, 100));
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(1.0f).GetTranslation(), CVector3D(200, 60, 0));
// Latch new position for interpolation
CMessageTurnStart msg;
test.HandleMessage(cmp, msg, false);
// Move smoothly to new position
cmp->MoveTo(entity_pos_t::FromInt(400), entity_pos_t::FromInt(300));
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(0.0f).GetTranslation(), CVector3D(200, 60, 0));
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(0.5f).GetTranslation(), CVector3D(300, 60, 150));
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(1.0f).GetTranslation(), CVector3D(400, 60, 300));
// Jump to new position
cmp->JumpTo(entity_pos_t::FromInt(300), entity_pos_t::FromInt(100));
// Position computed from jump plus terrain
TS_ASSERT_EQUALS(cmp->GetPosition(), fixedvec(300, 60, 100));
// Interpolated position should be constant after jump
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(0.0f).GetTranslation(), CVector3D(300, 60, 100));
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(0.5f).GetTranslation(), CVector3D(300, 60, 100));
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(1.0f).GetTranslation(), CVector3D(300, 60, 100));
// TODO: Test the rotation methods
}
void test_water()
{
CXeromycesEngine xeromycesEngine;
ComponentTestHelper test(*g_ScriptContext);
MockTerrain terrain;
test.AddMock(SYSTEM_ENTITY, IID_Terrain, terrain);
MockWater water;
test.AddMock(SYSTEM_ENTITY, IID_WaterManager, water);
ICmpPosition* cmp = test.Add<ICmpPosition>(CID_Position, "<Anchor>upright</Anchor><Altitude>23</Altitude><Floating>true</Floating><FloatDepth>1</FloatDepth>");
// Move into the world, the fixed height uses the water level minus the float depth as a base
cmp->JumpTo(entity_pos_t::FromInt(0), entity_pos_t::FromInt(0));
TS_ASSERT(cmp->IsInWorld());
TS_ASSERT(cmp->CanFloat());
TS_ASSERT_EQUALS(cmp->GetHeightOffset(), entity_pos_t::FromInt(23));
TS_ASSERT_EQUALS(cmp->GetHeightFixed(), entity_pos_t::FromInt(122));
// Change height offset, the fixed height changes too
cmp->SetHeightOffset(entity_pos_t::FromInt(11));
TS_ASSERT_EQUALS(cmp->GetHeightOffset(), entity_pos_t::FromInt(11));
TS_ASSERT_EQUALS(cmp->GetHeightFixed(), entity_pos_t::FromInt(110));
TS_ASSERT_EQUALS(cmp->GetPosition(), fixedvec(0, 110, 0));
// Move
cmp->MoveTo(entity_pos_t::FromInt(100), entity_pos_t::FromInt(200));
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(0.0f).GetTranslation(), CVector3D(0, 122, 0));
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(0.5f).GetTranslation(), CVector3D(50, 116, 100));
TS_ASSERT_EQUALS(cmp->GetInterpolatedTransform(1.0f).GetTranslation(), CVector3D(100, 110, 200));
// Change fixed height, the height offset changes too
cmp->SetHeightFixed(entity_pos_t::FromInt(122));
TS_ASSERT_EQUALS(cmp->GetHeightFixed(), entity_pos_t::FromInt(122));
TS_ASSERT_EQUALS(cmp->GetHeightOffset(), entity_pos_t::FromInt(23));
TS_ASSERT_EQUALS(cmp->GetPosition(), fixedvec(100, 122, 200));
// The entity can't float anymore, the fixed height is computed from the terrain base
cmp->SetFloating(false);
TS_ASSERT(!cmp->CanFloat());
TS_ASSERT_EQUALS(cmp->GetHeightFixed(), entity_pos_t::FromInt(73));
TS_ASSERT_EQUALS(cmp->GetHeightOffset(), entity_pos_t::FromInt(23));
TS_ASSERT_EQUALS(cmp->GetPosition(), fixedvec(100, 73, 200));
// The entity can float again
cmp->SetFloating(true);
TS_ASSERT_EQUALS(cmp->GetHeightFixed(), entity_pos_t::FromInt(122));
TS_ASSERT_EQUALS(cmp->GetHeightOffset(), entity_pos_t::FromInt(23));
TS_ASSERT_EQUALS(cmp->GetPosition(), fixedvec(100, 122, 200));
// Use non relative height, entity will not follow terrain/water height.
TS_ASSERT(cmp->IsHeightRelative());
cmp->SetHeightRelative(false);
TS_ASSERT(!cmp->IsHeightRelative());
cmp->SetHeightOffset(entity_pos_t::FromInt(11));
TS_ASSERT_EQUALS(cmp->GetHeightOffset(), entity_pos_t::FromInt(11));
TS_ASSERT_EQUALS(cmp->GetHeightFixed(), entity_pos_t::FromInt(110));
TS_ASSERT_EQUALS(cmp->GetPosition(), fixedvec(100, 110, 200));
cmp->SetHeightFixed(entity_pos_t::FromInt(122));
TS_ASSERT_EQUALS(cmp->GetHeightFixed(), entity_pos_t::FromInt(122));
TS_ASSERT_EQUALS(cmp->GetHeightOffset(), entity_pos_t::FromInt(23));
TS_ASSERT_EQUALS(cmp->GetPosition(), fixedvec(100, 122, 200));
// The entity can't float anymore and height is not relative, fixed height doesn't change
cmp->SetFloating(false);
TS_ASSERT(!cmp->CanFloat());
TS_ASSERT_EQUALS(cmp->GetHeightFixed(), entity_pos_t::FromInt(122));
TS_ASSERT_EQUALS(cmp->GetHeightOffset(), entity_pos_t::FromInt(72));
TS_ASSERT_EQUALS(cmp->GetPosition(), fixedvec(100, 122, 200));
}
void test_advertise_position_changes()
{
CXeromycesEngine xeromycesEngine;
ComponentTestHelper test(*g_ScriptContext);
MockTerrain terrain;
test.AddMock(SYSTEM_ENTITY, IID_Terrain, terrain);
ICmpPosition* cmp = test.Add<ICmpPosition>(CID_Position, "<Anchor>upright</Anchor><Altitude>0</Altitude><Floating>false</Floating>");
MockPositionChangedListener listener;
test.GetSimContext().GetComponentManager().DynamicSubscriptionNonsync(MT_PositionChanged, &listener, true);
// Moving out of the world while already out of it doesn't send a message.
cmp->MoveOutOfWorld();
TS_ASSERT_EQUALS(listener.m_Count, 0);
// Entering the world does.
cmp->JumpTo(entity_pos_t::FromInt(100), entity_pos_t::FromInt(200));
TS_ASSERT_EQUALS(listener.m_Count, 1);
TS_ASSERT(listener.m_LastInWorld);
TS_ASSERT_EQUALS(listener.m_LastX, entity_pos_t::FromInt(100));
TS_ASSERT_EQUALS(listener.m_LastZ, entity_pos_t::FromInt(200));
// Turning to a new angle sends a message.
cmp->TurnTo(entity_angle_t::FromInt(1));
TS_ASSERT_EQUALS(listener.m_Count, 2);
TS_ASSERT_EQUALS(listener.m_LastRotY, entity_angle_t::FromInt(1));
// Turning to the angle the entity already faces doesn't (#7654).
cmp->TurnTo(entity_angle_t::FromInt(1));
TS_ASSERT_EQUALS(listener.m_Count, 2);
// Moving without turning still advertises the movement (#6844).
cmp->MoveAndTurnTo(entity_pos_t::FromInt(110), entity_pos_t::FromInt(200), entity_angle_t::FromInt(1));
TS_ASSERT_EQUALS(listener.m_Count, 3);
TS_ASSERT_EQUALS(listener.m_LastX, entity_pos_t::FromInt(110));
TS_ASSERT_EQUALS(listener.m_LastZ, entity_pos_t::FromInt(200));
TS_ASSERT_EQUALS(listener.m_LastRotY, entity_angle_t::FromInt(1));
// Moving to the position the entity already has doesn't send a message.
cmp->MoveTo(entity_pos_t::FromInt(110), entity_pos_t::FromInt(200));
TS_ASSERT_EQUALS(listener.m_Count, 3);
// Leaving the world sends an out-of-world message, but only once.
cmp->MoveOutOfWorld();
TS_ASSERT_EQUALS(listener.m_Count, 4);
TS_ASSERT(!listener.m_LastInWorld);
cmp->MoveOutOfWorld();
TS_ASSERT_EQUALS(listener.m_Count, 4);
}
void test_serialize()
{
CXeromycesEngine xeromycesEngine;
ComponentTestHelper test(*g_ScriptContext);
MockTerrain terrain;
test.AddMock(SYSTEM_ENTITY, IID_Terrain, terrain);
ICmpPosition* cmp = test.Add<ICmpPosition>(CID_Position, "<Anchor>upright</Anchor><Altitude>5</Altitude><Floating>false</Floating>");
test.Roundtrip();
cmp->SetHeightOffset(entity_pos_t::FromInt(20));
cmp->SetXZRotation(entity_angle_t::FromInt(1), entity_angle_t::FromInt(2));
cmp->SetYRotation(entity_angle_t::FromInt(3));
test.Roundtrip();
cmp->JumpTo(entity_pos_t::FromInt(10), entity_pos_t::FromInt(20));
cmp->MoveTo(entity_pos_t::FromInt(123), entity_pos_t::FromInt(456));
test.Roundtrip();
}
};
Reference in a new issue View git blame Copy permalink