Skip to content

refactor(pathfinding): simplify functions to improve readability - Part 2 #1620

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Oct 1, 2025
Merged

refactor(pathfinding): simplify functions to improve readability - Part 2 #1620

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
533eff8
refactor(pathfinder): Simplify and improve readability of Pathfinder:…
Mauller Sep 22, 2025
a85af69
refactor(pathfinder): Simplify and improve readability of Pathfinder:…
Mauller Sep 22, 2025
d230f33
refactor(pathfinder): Simplify and improve readability of Pathfinder:…
Mauller Sep 22, 2025
6892d82
refactor(pathfinder): Simplify and improve readability of Pathfinder:…
Mauller Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
150 changes: 67 additions & 83 deletions Generals/Code/GameEngine/Source/GameLogic/AI/AIPathfind.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4204,25 +4204,27 @@ Locomotor* Pathfinder::chooseBestLocomotorForPosition(PathfindLayerEnum layer, L

/*static*/ LocomotorSurfaceTypeMask Pathfinder::validLocomotorSurfacesForCellType(PathfindCell::CellType t)
{
if (t == PathfindCell::CELL_OBSTACLE) {
return LOCOMOTORSURFACE_AIR;
}
if (t == PathfindCell::CELL_IMPASSABLE) {
return LOCOMOTORSURFACE_AIR;
}
if (t==PathfindCell::CELL_CLEAR) {
return LOCOMOTORSURFACE_GROUND | LOCOMOTORSURFACE_AIR;
}
if (t == PathfindCell::CELL_WATER) {
return LOCOMOTORSURFACE_WATER | LOCOMOTORSURFACE_AIR;
}
if (t == PathfindCell::CELL_RUBBLE) {
return LOCOMOTORSURFACE_RUBBLE | LOCOMOTORSURFACE_AIR;
}
if ( t == PathfindCell::CELL_CLIFF ) {
return LOCOMOTORSURFACE_CLIFF | LOCOMOTORSURFACE_AIR;
switch (t)
{
case PathfindCell::CELL_CLEAR:
return LOCOMOTORSURFACE_GROUND | LOCOMOTORSURFACE_AIR;

case PathfindCell::CELL_WATER:
return LOCOMOTORSURFACE_WATER | LOCOMOTORSURFACE_AIR;

case PathfindCell::CELL_CLIFF:
return LOCOMOTORSURFACE_CLIFF | LOCOMOTORSURFACE_AIR;

case PathfindCell::CELL_RUBBLE:
return LOCOMOTORSURFACE_RUBBLE | LOCOMOTORSURFACE_AIR;

case PathfindCell::CELL_OBSTACLE:
case PathfindCell::CELL_IMPASSABLE:
return LOCOMOTORSURFACE_AIR;

default:
return NO_SURFACES;
}
return NO_SURFACES;
}

//
Expand Down Expand Up @@ -5829,30 +5831,14 @@ Path *Pathfinder::internalFindPath( Object *obj, const LocomotorSet& locomotorSe
// to ignore obstacle cells until it reaches a cell that is no longer
// classified as an obstacle. At that point, the pathfind behaves normally.
//
if (parentCell->getType() == PathfindCell::CELL_OBSTACLE) {
m_isTunneling = true;
}
else {
m_isTunneling = false;
}
m_isTunneling = parentCell->getType() == PathfindCell::CELL_OBSTACLE;

Int zone1, zone2;
Bool isCrusher = obj ? obj->getCrusherLevel() > 0 : false;
zone1 = m_zoneManager.getEffectiveZone(locomotorSet.getValidSurfaces(), isCrusher, parentCell->getZone());
zone2 = m_zoneManager.getEffectiveZone(locomotorSet.getValidSurfaces(), isCrusher, goalCell->getZone());

if (layer==LAYER_WALL && zone1 == 0) {
#if RETAIL_COMPATIBLE_PATHFINDING
if (s_useFixedPathfinding)
#endif
{
goalCell->releaseInfo();
parentCell->releaseInfo();
}
return NULL;
}

if (destinationLayer==LAYER_WALL && zone2 == 0) {
if ( (layer==LAYER_WALL && zone1 == 0) || (destinationLayer==LAYER_WALL && zone2 == 0) ) {
#if RETAIL_COMPATIBLE_PATHFINDING
if (s_useFixedPathfinding)
#endif
Expand Down Expand Up @@ -5881,15 +5867,15 @@ Path *Pathfinder::internalFindPath( Object *obj, const LocomotorSet& locomotorSe
}

// sanity check - if destination is invalid, can't path there
if (validMovementPosition( isCrusher, destinationLayer, locomotorSet, to ) == false) {
if (!validMovementPosition( isCrusher, destinationLayer, locomotorSet, to )) {
m_isTunneling = false;
goalCell->releaseInfo();
parentCell->releaseInfo();
return NULL;
}

// sanity check - if source is invalid, we have to cheat
if (validMovementPosition( isCrusher, layer, locomotorSet, from ) == false) {
if (!validMovementPosition( isCrusher, layer, locomotorSet, from )) {
// somehow we got to an impassable location.
m_isTunneling = true;
}
Expand Down Expand Up @@ -9610,7 +9596,9 @@ if (g_UT_startTiming) return false;
Path *Pathfinder::getMoveAwayFromPath(Object* obj, Object *otherObj,
Path *pathToAvoid, Object *otherObj2, Path *pathToAvoid2)
{
if (m_isMapReady == false) return NULL; // Should always be ok.
if (!m_isMapReady)
return NULL; // Should always be ok.

#ifdef DEBUG_LOGGING
Int startTimeMS = ::GetTickCount();
#endif
Expand Down Expand Up @@ -9641,11 +9629,12 @@ Path *Pathfinder::getMoveAwayFromPath(Object* obj, Object *otherObj,
}
worldToCell(&startPos, &startCellNdx);
PathfindCell *parentCell = getClippedCell( obj->getLayer(), obj->getPosition() );
if (parentCell == NULL)
if (!parentCell)
return NULL;
if (!obj->getAIUpdateInterface()) {
return NULL; // shouldn't happen, but can't move it without an ai.
}

if (!obj->getAIUpdateInterface()) // shouldn't happen, but can't move it without an ai.
return NULL;

const LocomotorSet& locomotorSet = obj->getAIUpdateInterface()->getLocomotorSet();

m_isTunneling = false;
Expand Down Expand Up @@ -9700,12 +9689,7 @@ Path *Pathfinder::getMoveAwayFromPath(Object* obj, Object *otherObj,
bounds.hi.y = cellCenter.y+boxHalfWidth;
PathNode *node;
Bool overlap = false;
if (obj) {
if (bounds.lo.x<obj->getPosition()->x && bounds.hi.x>obj->getPosition()->x &&
bounds.lo.y<obj->getPosition()->y && bounds.hi.y>obj->getPosition()->y) {
//overlap = true;
}
}

for( node = pathToAvoid->getFirstNode(); node && node->getNextOptimized(); node = node->getNextOptimized() ) {
Coord2D start, end;
start.x = node->getPosition()->x;
Expand All @@ -9717,12 +9701,7 @@ Path *Pathfinder::getMoveAwayFromPath(Object* obj, Object *otherObj,
break;
}
}
if (otherObj) {
if (bounds.lo.x<otherObj->getPosition()->x && bounds.hi.x>otherObj->getPosition()->x &&
bounds.lo.y<otherObj->getPosition()->y && bounds.hi.y>otherObj->getPosition()->y) {
//overlap = true;
}
}

if (!overlap && pathToAvoid2) {
for( node = pathToAvoid2->getFirstNode(); node && node->getNextOptimized(); node = node->getNextOptimized() ) {
Coord2D start, end;
Expand Down Expand Up @@ -10021,7 +10000,8 @@ Path *Pathfinder::patchPath( const Object *obj, const LocomotorSet& locomotorSet
Path *Pathfinder::findAttackPath( const Object *obj, const LocomotorSet& locomotorSet, const Coord3D *from,
const Object *victim, const Coord3D* victimPos, const Weapon *weapon )
{
if (m_isMapReady == false) return NULL; // Should always be ok.
if (!m_isMapReady)
return NULL; // Should always be ok.

Bool isCrusher = obj ? obj->getCrusherLevel() > 0 : false;
Int radius;
Expand All @@ -10046,26 +10026,30 @@ Path *Pathfinder::findAttackPath( const Object *obj, const LocomotorSet& locomot
ICoord2D cellNdx;
worldToCell(&testPos, &cellNdx);
PathfindCell *aCell = getCell(obj->getLayer(), cellNdx.x, cellNdx.y);
if (aCell==NULL) break;
if (!validMovementPosition( isCrusher, locomotorSet.getValidSurfaces(), aCell )) {
if (!aCell)
break;
}
if (!checkDestination(obj, cellNdx.x, cellNdx.y, obj->getLayer(), radius, centerInCell)) {

if (!validMovementPosition(isCrusher, locomotorSet.getValidSurfaces(), aCell))
break;

if (!checkDestination(obj, cellNdx.x, cellNdx.y, obj->getLayer(), radius, centerInCell))
break;

if (!weapon->isGoalPosWithinAttackRange(obj, &testPos, victim, victimPos))
continue;

if (isAttackViewBlockedByObstacle(obj, testPos, victim, *victimPos))
continue;

// return path.
Path *path = newInstance(Path);
path->prependNode( &testPos, obj->getLayer() );
path->prependNode( &curPos, obj->getLayer() );
path->getFirstNode()->setNextOptimized(path->getFirstNode()->getNext());
if (TheGlobalData->m_debugAI==AI_DEBUG_PATHS) {
setDebugPath(path);
}
if (weapon->isGoalPosWithinAttackRange(obj, &testPos, victim, victimPos)) {
if (!isAttackViewBlockedByObstacle(obj, testPos, victim, *victimPos)) {
// return path.
Path *path = newInstance(Path);
path->prependNode( &testPos, obj->getLayer() );
path->prependNode( &curPos, obj->getLayer() );
path->getFirstNode()->setNextOptimized(path->getFirstNode()->getNext());
if (TheGlobalData->m_debugAI==AI_DEBUG_PATHS) {
setDebugPath(path);
}
return path;
}
}
return path;
}
}

Expand Down Expand Up @@ -10098,18 +10082,19 @@ Path *Pathfinder::findAttackPath( const Object *obj, const LocomotorSet& locomot
objPos.x += PATHFIND_CELL_SIZE_F/2.0f;
objPos.y += PATHFIND_CELL_SIZE_F/2.0f;
}

if (!obj->getAIUpdateInterface()) // shouldn't happen, but can't move without an ai.
return NULL;

worldToCell(&objPos, &startCellNdx);
PathfindCell *parentCell = getClippedCell( obj->getLayer(), &objPos );
if (parentCell == NULL)
if (!parentCell)
return NULL;
if (!obj->getAIUpdateInterface()) {
return NULL; // shouldn't happen, but can't move it without an ai.
}
const PathfindCell *startCell = parentCell;

if (!parentCell->allocateInfo(startCellNdx)) {
if (!parentCell->allocateInfo(startCellNdx))
return NULL;
}

const PathfindCell *startCell = parentCell;
parentCell->startPathfind(NULL);

// determine start cell
Expand All @@ -10118,7 +10103,7 @@ Path *Pathfinder::findAttackPath( const Object *obj, const LocomotorSet& locomot

// determine goal cell
PathfindCell *goalCell = getCell( LAYER_GROUND, victimCellNdx.x, victimCellNdx.y );
if (goalCell == NULL)
if (!goalCell)
return NULL;

if (!goalCell->allocateInfo(victimCellNdx)) {
Expand Down Expand Up @@ -10229,8 +10214,7 @@ Path *Pathfinder::findAttackPath( const Object *obj, const LocomotorSet& locomot
return path;
}
}
if (checkDestination(obj, parentCell->getXIndex(), parentCell->getYIndex(),
parentCell->getLayer(), radius, centerInCell)) {
if (checkDestination(obj, parentCell->getXIndex(), parentCell->getYIndex(), parentCell->getLayer(), radius, centerInCell)) {
if (validMovementPosition( isCrusher, locomotorSet.getValidSurfaces(), parentCell )) {
Real dx = IABS(victimCellNdx.x-parentCell->getXIndex());
Real dy = IABS(victimCellNdx.y-parentCell->getYIndex());
Expand Down
Loading
Loading