diff --git a/src/openrct2/peep/Guest.cpp b/src/openrct2/peep/Guest.cpp index a85bb9366b..f90aac737a 100644 --- a/src/openrct2/peep/Guest.cpp +++ b/src/openrct2/peep/Guest.cpp @@ -1677,7 +1677,7 @@ loc_69B221: UmbrellaColour = ride->track_colour[0].main; if (shopItem == SHOP_ITEM_MAP) - peep_reset_pathfind_goal(this); + ResetPathfindGoal(); uint16_t consumptionTime = item_consumption_time[shopItem]; TimeToConsume = std::min((TimeToConsume + consumptionTime), 255); @@ -1814,7 +1814,7 @@ void Guest::OnExitRide(ride_id_t rideIndex) { GuestHeadingToRideId = rideIndex; GuestIsLostCountdown = 200; - peep_reset_pathfind_goal(this); + ResetPathfindGoal(); WindowInvalidateFlags |= PEEP_INVALIDATE_PEEP_ACTION; } @@ -1877,7 +1877,7 @@ void Guest::PickRideToGoOn() // Head to that ride GuestHeadingToRideId = ride->id; GuestIsLostCountdown = 200; - peep_reset_pathfind_goal(this); + ResetPathfindGoal(); WindowInvalidateFlags |= PEEP_INVALIDATE_PEEP_ACTION; // Make peep look at their map if they have one @@ -3254,7 +3254,7 @@ template static void peep_head_for_nearest_ride(Guest* peep, bool co // Head to that ride peep->GuestHeadingToRideId = closestRide->id; peep->GuestIsLostCountdown = 200; - peep_reset_pathfind_goal(peep); + peep->ResetPathfindGoal(); peep->WindowInvalidateFlags |= PEEP_INVALIDATE_PEEP_ACTION; peep->TimeLost = 0; } diff --git a/src/openrct2/peep/GuestPathfinding.cpp b/src/openrct2/peep/GuestPathfinding.cpp index 57f17e95db..ca827d2153 100644 --- a/src/openrct2/peep/GuestPathfinding.cpp +++ b/src/openrct2/peep/GuestPathfinding.cpp @@ -255,7 +255,7 @@ static uint8_t footpath_element_next_in_direction(TileCoordsXYZ loc, PathElement continue; if (nextTileElement->GetType() != TILE_ELEMENT_TYPE_PATH) continue; - if (!is_valid_path_z_and_direction(nextTileElement, loc.z, chosenDirection)) + if (!IsValidPathZAndDirection(nextTileElement, loc.z, chosenDirection)) continue; if (nextTileElement->AsPath()->IsWide()) return PATH_SEARCH_WIDE; @@ -348,7 +348,7 @@ static uint8_t footpath_element_dest_in_dir( } break; case TILE_ELEMENT_TYPE_PATH: - if (!is_valid_path_z_and_direction(tileElement, loc.z, chosenDirection)) + if (!IsValidPathZAndDirection(tileElement, loc.z, chosenDirection)) continue; if (tileElement->AsPath()->IsWide()) return PATH_SEARCH_WIDE; @@ -776,7 +776,7 @@ static void peep_pathfind_heuristic_search( * queue path. * Otherwise, peeps walk on path tiles to get to the goal. */ - if (!is_valid_path_z_and_direction(tileElement, loc.z, test_edge)) + if (!IsValidPathZAndDirection(tileElement, loc.z, test_edge)) continue; // Path may be sloped, so set z to path base height. @@ -1739,13 +1739,13 @@ static int32_t guest_path_find_park_entrance(Peep* peep, uint8_t edges) gPeepPathFindQueueRideIndex = RIDE_ID_NULL; #if defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 - pathfind_logging_enable(peep); + PathfindLoggingEnable(peep); #endif // defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 Direction chosenDirection = peep_pathfind_choose_direction(TileCoordsXYZ{ peep->NextLoc }, peep); #if defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 - pathfind_logging_disable(); + PathfindLoggingDisable(); #endif // defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 if (chosenDirection == INVALID_DIRECTION) @@ -1942,7 +1942,7 @@ static StationIndex guest_pathfinding_select_random_station( int32_t guest_path_finding(Guest* peep) { #if defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 - pathfind_logging_enable(peep); + PathfindLoggingEnable(peep); if (gPathFindDebug) { log_info("Starting guest_path_finding for %s", gPathFindDebugPeepName); @@ -2019,7 +2019,7 @@ int32_t guest_path_finding(Guest* peep) "Completed guest_path_finding for %s - taking only direction available: %d.", gPathFindDebugPeepName, direction); } - pathfind_logging_disable(); + PathfindLoggingDisable(); #endif // defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 return peep_move_one_tile(direction, peep); } @@ -2035,7 +2035,7 @@ int32_t guest_path_finding(Guest* peep) { log_info("Completed guest_path_finding for %s - peep is outside the park.", gPathFindDebugPeepName); } - pathfind_logging_disable(); + PathfindLoggingDisable(); #endif // defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 switch (peep->State) { @@ -2105,7 +2105,7 @@ int32_t guest_path_finding(Guest* peep) { log_info("Completed guest_path_finding for %s - peep is leaving the park.", gPathFindDebugPeepName); } - pathfind_logging_disable(); + PathfindLoggingDisable(); #endif // defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 return guest_path_find_park_entrance(peep, edges); } @@ -2117,7 +2117,7 @@ int32_t guest_path_finding(Guest* peep) { log_info("Completed guest_path_finding for %s - peep is aimless.", gPathFindDebugPeepName); } - pathfind_logging_disable(); + PathfindLoggingDisable(); #endif // defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 return guest_path_find_aimless(peep, edges); } @@ -2133,7 +2133,7 @@ int32_t guest_path_finding(Guest* peep) log_info( "Completed guest_path_finding for %s - peep is heading to closed ride == aimless.", gPathFindDebugPeepName); } - pathfind_logging_disable(); + PathfindLoggingDisable(); #endif // defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 return guest_path_find_aimless(peep, edges); } @@ -2209,14 +2209,14 @@ int32_t guest_path_finding(Guest* peep) * This lets the heuristic search "try again" in case the player has * edited the path layout or the mechanic was already stuck in the * save game (e.g. with a worse version of the pathfinding). */ - peep_reset_pathfind_goal(peep); + peep->ResetPathfindGoal(); #if defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 if (gPathFindDebug) { log_info("Completed guest_path_finding for %s - failed to choose a direction == aimless.", gPathFindDebugPeepName); } - pathfind_logging_disable(); + PathfindLoggingDisable(); #endif // defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 return guest_path_find_aimless(peep, edges); @@ -2226,12 +2226,12 @@ int32_t guest_path_finding(Guest* peep) { log_info("Completed guest_path_finding for %s - direction chosen: %d.", gPathFindDebugPeepName, direction); } - pathfind_logging_disable(); + PathfindLoggingDisable(); #endif // defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 return peep_move_one_tile(direction, peep); } -bool is_valid_path_z_and_direction(TileElement* tileElement, int32_t currentZ, int32_t currentDirection) +bool IsValidPathZAndDirection(TileElement* tileElement, int32_t currentZ, int32_t currentDirection) { if (tileElement->AsPath()->IsSloped()) { @@ -2262,7 +2262,7 @@ bool is_valid_path_z_and_direction(TileElement* tileElement, int32_t currentZ, i * * rct2: 0x0069A98C */ -void peep_reset_pathfind_goal(Peep* peep) +void Peep::ResetPathfindGoal() { #if defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 if (gPathFindDebug) @@ -2271,14 +2271,14 @@ void peep_reset_pathfind_goal(Peep* peep) } #endif // defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 - peep->PathfindGoal.x = 0xFF; - peep->PathfindGoal.y = 0xFF; - peep->PathfindGoal.z = 0xFF; - peep->PathfindGoal.direction = INVALID_DIRECTION; + PathfindGoal.x = 0xFF; + PathfindGoal.y = 0xFF; + PathfindGoal.z = 0xFF; + PathfindGoal.direction = INVALID_DIRECTION; } #if defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 -void pathfind_logging_enable([[maybe_unused]] Peep* peep) +void PathfindLoggingEnable([[maybe_unused]] Peep* peep) { # if defined(PATHFIND_DEBUG) && PATHFIND_DEBUG /* Determine if the pathfinding debugging is wanted for this peep. */ @@ -2301,7 +2301,7 @@ void pathfind_logging_enable([[maybe_unused]] Peep* peep) # endif // defined(PATHFIND_DEBUG) && PATHFIND_DEBUG } -void pathfind_logging_disable() +void PathfindLoggingDisable() { # if defined(PATHFIND_DEBUG) && PATHFIND_DEBUG gPathFindDebug = false; diff --git a/src/openrct2/peep/GuestPathfinding.h b/src/openrct2/peep/GuestPathfinding.h index 990463e972..7804e2de60 100644 --- a/src/openrct2/peep/GuestPathfinding.h +++ b/src/openrct2/peep/GuestPathfinding.h @@ -7,8 +7,7 @@ * OpenRCT2 is licensed under the GNU General Public License version 3. *****************************************************************************/ -#ifndef _GUESTPATHFINDING_H_ -#define _GUESTPATHFINDING_H_ +#pragma once #include "../common.h" #include "../ride/RideTypes.h" @@ -42,13 +41,9 @@ extern bool gPeepPathFindIgnoreForeignQueues; // the direction the peep should walk in from the current tile. Direction peep_pathfind_choose_direction(const TileCoordsXYZ& loc, Peep* peep); -// Reset the peep's stored goal, which means they will forget any stored pathfinding history -// on the next choose_direction call. -void peep_reset_pathfind_goal(Peep* peep); - // Test whether the given tile can be walked onto, if the peep is currently at height currentZ and // moving in direction currentDirection. -bool is_valid_path_z_and_direction(TileElement* tileElement, int32_t currentZ, int32_t currentDirection); +bool IsValidPathZAndDirection(TileElement* tileElement, int32_t currentZ, int32_t currentDirection); // Overall guest pathfinding AI. Sets up Peep::DestinationX/DestinationY (which they move to in a // straight line, no pathfinding). Called whenever the guest has arrived at their previously set destination. @@ -65,8 +60,6 @@ int32_t guest_path_finding(Guest* peep); // The following calls configure debug logging for the given peep // If they're a guest, pathfinding will be logged if they have PEEP_FLAGS_TRACKING set // If they're staff, pathfinding will be logged if their name is "Mechanic Debug" -void pathfind_logging_enable(Peep* peep); -void pathfind_logging_disable(); +void PathfindLoggingEnable(Peep* peep); +void PathfindLoggingDisable(); #endif // defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 - -#endif diff --git a/src/openrct2/peep/Peep.cpp b/src/openrct2/peep/Peep.cpp index c1998b2fb3..1d4147b5dd 100644 --- a/src/openrct2/peep/Peep.cpp +++ b/src/openrct2/peep/Peep.cpp @@ -1707,7 +1707,7 @@ Peep* Peep::Generate(const CoordsXYZ& coords) peep->CashInPocket = cash; peep->CashSpent = 0; peep->TimeInPark = -1; - peep_reset_pathfind_goal(peep); + peep->ResetPathfindGoal(); peep->ItemStandardFlags = 0; peep->ItemExtraFlags = 0; peep->GuestHeadingToRideId = RIDE_ID_NULL; diff --git a/src/openrct2/peep/Peep.h b/src/openrct2/peep/Peep.h index 87e645fa86..f69273b884 100644 --- a/src/openrct2/peep/Peep.h +++ b/src/openrct2/peep/Peep.h @@ -800,6 +800,10 @@ public: // Peep std::string GetName() const; bool SetName(const std::string_view& value); + // Reset the peep's stored goal, which means they will forget any stored pathfinding history + // on the next peep_pathfind_choose_direction call. + void ResetPathfindGoal(); + // TODO: Make these private again when done refactoring public: // Peep bool CheckForPath(); diff --git a/src/openrct2/peep/Staff.cpp b/src/openrct2/peep/Staff.cpp index 4e305ff4cf..64d4bc3d86 100644 --- a/src/openrct2/peep/Staff.cpp +++ b/src/openrct2/peep/Staff.cpp @@ -283,7 +283,7 @@ bool staff_can_ignore_wide_flag(Peep* staff, const CoordsXYZ& staffPos, TileElem } /* test_element is a path */ - if (!is_valid_path_z_and_direction(test_element, adjacPos.z / COORDS_Z_STEP, adjac_dir)) + if (!IsValidPathZAndDirection(test_element, adjacPos.z / COORDS_Z_STEP, adjac_dir)) continue; /* test_element is a connected path */ @@ -857,13 +857,13 @@ static uint8_t staff_mechanic_direction_path(Peep* peep, uint8_t validDirections gPeepPathFindQueueRideIndex = RIDE_ID_NULL; #if defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 - pathfind_logging_enable(peep); + PathfindLoggingEnable(peep); #endif // defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 Direction pathfindDirection = peep_pathfind_choose_direction(TileCoordsXYZ{ peep->NextLoc }, peep); #if defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 - pathfind_logging_disable(); + PathfindLoggingDisable(); #endif // defined(DEBUG_LEVEL_1) && DEBUG_LEVEL_1 if (pathfindDirection == INVALID_DIRECTION) @@ -874,7 +874,7 @@ static uint8_t staff_mechanic_direction_path(Peep* peep, uint8_t validDirections * This lets the heuristic search "try again" in case the player has * edited the path layout or the mechanic was already stuck in the * save game (e.g. with a worse version of the pathfinding). */ - peep_reset_pathfind_goal(peep); + peep->ResetPathfindGoal(); return staff_mechanic_direction_path_rand(peep, pathDirections); } @@ -1437,7 +1437,7 @@ void Staff::UpdateHeadingToInspect() if (SubState == 0) { MechanicTimeSinceCall = 0; - peep_reset_pathfind_goal(this); + ResetPathfindGoal(); SubState = 2; } @@ -1547,7 +1547,7 @@ void Staff::UpdateAnswering() SubState = 2; peep_window_state_update(this); MechanicTimeSinceCall = 0; - peep_reset_pathfind_goal(this); + ResetPathfindGoal(); return; } UpdateAction();