typo-correct "navigatable", remove now-unnecessary GetArea warning

pawnishoovy · pawnishoovy · commit ff52b9ad61d7 · 2024-11-18T06:40:16.000+02:00
Area stuff required renaming the string_view, const string stuff so it wouldn't be ambiguous. if anyone has a better idea than 1 and 2, feel free.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -113,14 +113,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 - Internal GUI element `ComboBox` no longer displays dropdown combobutton when disabled, to communicate visually that it's setting is not modifiable.
 
-- Almost all ctrl+* special inputs functionality (i.e restarting activity, world dumps, showing performance stats) are now mapped to right alt, to not interfere with default crouching inputs. The only exception is ctrl+arrow keys for changing console size.
+- Almost all ctrl+\* special inputs functionality (i.e restarting activity, world dumps, showing performance stats) are now mapped to right alt, to not interfere with default crouching inputs. The only exception is ctrl+arrow keys for changing console size.
 
 - `Gib`s and detached `Attachable`s now inherit the parent's angular velocity by default.
 
 - `InheritsVel` now accounts for the angular velocity of the parent MO, resulting in offset gibs and emissions being flung further away.
 
 - `InheritsVel` and its ilk have been uncapped, allowing users to set them outside of 0-1.
 
+- `Scene` Lua functions `AddNavigatableArea(areaName)` and `ClearNavigatableAreas()` have been renamed/corrected to `AddNavigableArea(areaName)` and `ClearNavigableAreas()`, respectively.
+
 </details>
 
 <details><summary><b>Fixed</b></summary>
diff --git a/Data/Browncoats.rte/Activities/RefineryAssault.lua b/Data/Browncoats.rte/Activities/RefineryAssault.lua
@@ -178,10 +178,10 @@ function RefineryAssault:StartActivity(newGame)
 		end
 	end
 
-	SceneMan.Scene:AddNavigatableArea("Mission Stage Area 1");
-	SceneMan.Scene:AddNavigatableArea("Mission Stage Area 2");
-	SceneMan.Scene:AddNavigatableArea("Mission Stage Area 3");
-	SceneMan.Scene:AddNavigatableArea("Mission Stage Area 4");
+	SceneMan.Scene:AddNavigableArea("Mission Stage Area 1");
+	SceneMan.Scene:AddNavigableArea("Mission Stage Area 2");
+	SceneMan.Scene:AddNavigableArea("Mission Stage Area 3");
+	SceneMan.Scene:AddNavigableArea("Mission Stage Area 4");
 	
 	self.musicGraceTimer = Timer();
 	self.musicGraceTime = 4000;
diff --git a/Source/Activities/AreaEditor.cpp b/Source/Activities/AreaEditor.cpp
@@ -289,15 +289,15 @@ void AreaEditor::Update() {
 				// Make sure we're not trying to create a noname area
 				if (!m_pNewAreaName->GetText().empty()) {
 					// Check if name is already taken, and if so, select the taken one instead of creating a new
-					if (Scene::Area* pArea = pCurrentScene->GetArea(m_pNewAreaName->GetText())) {
+					if (Scene::Area* pArea = pCurrentScene->GetArea2(m_pNewAreaName->GetText())) {
 						m_pEditorGUI->SetCurrentArea(pArea);
 						m_pEditorGUI->SetEditorGUIMode(AreaEditorGUI::PREADDMOVEBOX);
 					} else {
 						// Make and name new Area
 						Scene::Area newArea(m_pNewAreaName->GetText());
 						pCurrentScene->m_AreaList.push_back(newArea);
 						// Set the new area as the active one in the GUI, note we're getting the correct one from the scene, it's a copy of the one passed in
-						m_pEditorGUI->SetCurrentArea(pCurrentScene->GetArea(newArea.GetName()));
+						m_pEditorGUI->SetCurrentArea(pCurrentScene->GetArea2(newArea.GetName()));
 						// Update teh picker list of the GUI so we can mousewheel between all the Areas, incl the new one
 						m_pEditorGUI->UpdatePickerList(newArea.GetName());
 					}
diff --git a/Source/Activities/GATutorial.cpp b/Source/Activities/GATutorial.cpp
@@ -170,7 +170,7 @@ int GATutorial::Start() {
 			// See if there are specified landing zone areas defined in the scene
 			char str[64];
 			std::snprintf(str, sizeof(str), "LZ Team %d", team + 1);
-			Scene::Area* pArea = g_SceneMan.GetScene()->GetArea(str);
+			Scene::Area* pArea = g_SceneMan.GetScene()->GetArea1(str);
 			//        pArea = pArea ? pArea : g_SceneMan.GetScene()->GetArea("Landing Zone");
 			// If area is defined, save a copy so we can lock the LZ selection to within its boxes
 			if (pArea && !pArea->HasNoArea())
diff --git a/Source/Entities/HDFirearm.cpp b/Source/Entities/HDFirearm.cpp
@@ -938,7 +938,7 @@ void HDFirearm::Update() {
 				m_FireSound->Play(m_Pos);
 			}
 			if (m_FireEchoSound) {
-				Scene::Area* noEchoArea = g_SceneMan.GetScene()->GetArea("IndoorArea");
+				Scene::Area* noEchoArea = g_SceneMan.GetScene()->GetArea1("IndoorArea");
 				if (noEchoArea == nullptr || !noEchoArea->IsInside(m_Pos)) {
 					m_FireEchoSound->Play(m_Pos);
 				}
diff --git a/Source/Entities/Scene.cpp b/Source/Entities/Scene.cpp
@@ -356,8 +356,8 @@ void Scene::Clear() {
 		m_ScanScheduled[team] = false;
 	}
 	m_AreaList.clear();
-	m_NavigatableAreas.clear();
-	m_NavigatableAreasUpToDate = false;
+	m_NavigableAreas.clear();
+	m_NavigableAreasUpToDate = false;
 	m_GlobalAcc.Reset();
 	m_SelectedAssemblies.clear();
 	m_AssembliesCounts.clear();
@@ -1856,17 +1856,13 @@ bool Scene::HasArea(std::string areaName) {
 	return false;
 }
 
-Scene::Area* Scene::GetArea(const std::string_view& areaName, bool required) {
+Scene::Area* Scene::GetArea1(const std::string_view& areaName) {
 	for (Scene::Area& area: m_AreaList) {
 		if (area.GetName() == areaName) {
 			return &area;
 		}
 	}
 
-	if (required) {
-		g_ConsoleMan.PrintString("WARNING: Could not find the requested Scene Area named : " + std::string(areaName));
-	}
-
 	return nullptr;
 }
 
@@ -2223,7 +2219,7 @@ float Scene::ApplyBuildBudget(int player, int* pObjectsBuilt) {
 					TerrainObject* pTO = dynamic_cast<TerrainObject*>(pObjectToPlace);
 					if (pTO) {
 						if (HasArea(METABASE_AREA_NAME)) {
-							Scene::Area* metaBase = GetArea(METABASE_AREA_NAME);
+							Scene::Area* metaBase = GetArea1(METABASE_AREA_NAME);
 							if (metaBase) {
 								float x1 = pTO->GetPos().m_X + pTO->GetBitmapOffset().m_X;
 								float y1 = pTO->GetPos().m_Y + pTO->GetBitmapOffset().m_Y;
@@ -2438,21 +2434,21 @@ void Scene::Update() {
 		}
 	}
 
-	if (m_NavigatableAreasUpToDate == false) {
+	if (m_NavigableAreasUpToDate == false) {
 		// Need to block until all current pathfinding requests are finished. Ugh, if only we had a better way (interrupt/cancel a path request to start a new one?)
 		// TODO: Make the PathRequest struct more capable and maybe we can delay starting or cancel mid-request?
 		BlockUntilAllPathingRequestsComplete();
 
-		m_NavigatableAreasUpToDate = true;
+		m_NavigableAreasUpToDate = true;
 		for (int team = Activity::Teams::NoTeam; team < Activity::Teams::MaxTeamCount; ++team) {
 			PathFinder& pathFinder = GetPathFinder(static_cast<Activity::Teams>(team));
 
-			pathFinder.MarkAllNodesNavigatable(m_NavigatableAreas.empty());
+			pathFinder.MarkAllNodesNavigable(m_NavigableAreas.empty());
 
-			for (const std::string& navigatableArea: m_NavigatableAreas) {
-				if (HasArea(navigatableArea)) {
-					for (const Box& navigatableBox: GetArea(navigatableArea)->GetBoxes()) {
-						pathFinder.MarkBoxNavigatable(navigatableBox, true);
+			for (const std::string& navigableArea: m_NavigableAreas) {
+				if (HasArea(navigableArea)) {
+					for (const Box& navigableBox: GetArea2(navigableArea)->GetBoxes()) {
+						pathFinder.MarkBoxNavigable(navigableBox, true);
 					}
 				}
 			}
diff --git a/Source/Entities/Scene.h b/Source/Entities/Scene.h
@@ -505,22 +505,21 @@ namespace RTE {
 
 		/// Gets a specified Area identified by name. Ownership is NOT transferred!
 		/// @param areaName The name of the Area to try to get.
-		/// @param required Whether the area is required, and should throw an error if not found.
 		/// @return A pointer to the Area asked for, or nullptr if no Area of that name was found.
-		Area* GetArea(const std::string_view& areaName, bool required);
+		Area* GetArea1(const std::string_view& areaName);
 
 		/// Gets a specified Area identified by name. Ownership is NOT transferred!
 		/// @param areaName The name of the Area to try to get.
 		/// @return A pointer to the Area asked for, or nullptr if no Area of that name was found.
-		Area* GetArea(const std::string& areaName) { return GetArea(areaName, true); }
+		Area* GetArea2(const std::string& areaName) { return GetArea1(areaName); }
 
-		void AddNavigatableArea(const std::string& areaName) {
-			m_NavigatableAreas.push_back(areaName);
-			m_NavigatableAreasUpToDate = false;
+		void AddNavigableArea(const std::string& areaName) {
+			m_NavigableAreas.push_back(areaName);
+			m_NavigableAreasUpToDate = false;
 		}
-		void ClearNavigatableAreas(const std::string& areaName) {
-			m_NavigatableAreas.clear();
-			m_NavigatableAreasUpToDate = false;
+		void ClearNavigableAreas() {
+			m_NavigableAreas.clear();
+			m_NavigableAreasUpToDate = false;
 		}
 
 		/// Removes a specific Area identified by a name.
@@ -765,9 +764,9 @@ namespace RTE {
 		// List of all the specified Area's of the scene
 		std::list<Area> m_AreaList;
 
-		// List of navigatable areas in the scene. If this list is empty, the entire scene is assumed to be navigatable
-		std::vector<std::string> m_NavigatableAreas;
-		bool m_NavigatableAreasUpToDate;
+		// List of navigable areas in the scene. If this list is empty, the entire scene is assumed to be navigable
+		std::vector<std::string> m_NavigableAreas;
+		bool m_NavigableAreasUpToDate;
 
 		// The global acceleration vector in m/s^2. (think gravity/wind)
 		Vector m_GlobalAcc;
diff --git a/Source/Lua/LuaBindingsEntities.cpp b/Source/Lua/LuaBindingsEntities.cpp
@@ -1196,10 +1196,10 @@ LuaBindingRegisterFunctionDefinitionForType(EntityLuaBindings, Scene) {
 	    .def_readwrite("Areas", &Scene::m_AreaList, luabind::return_stl_iterator)
 	    .def("SetArea", &Scene::SetArea)
 	    .def("HasArea", &Scene::HasArea)
-	    .def("GetArea", (Scene::Area * (Scene::*)(const std::string& areaName)) & Scene::GetArea)
+	    .def("GetArea", (Scene::Area * (Scene::*)(const std::string& areaName)) & Scene::GetArea2)
 	    .def("WithinArea", &Scene::WithinArea)
-	    .def("AddNavigatableArea", &Scene::AddNavigatableArea)
-	    .def("ClearNavigatableAreas", &Scene::ClearNavigatableAreas)
+	    .def("AddNavigableArea", &Scene::AddNavigableArea)
+	    .def("ClearNavigableAreas", &Scene::ClearNavigableAreas)
 	    .def("ResetPathFinding", &Scene::ResetPathFinding)
 	    .def("UpdatePathFinding", &Scene::UpdatePathFinding)
 	    .def("PathFindingUpdated", &Scene::PathFindingUpdated)
diff --git a/Source/Managers/SceneMan.cpp b/Source/Managers/SceneMan.cpp
@@ -2240,7 +2240,7 @@ bool SceneMan::OverAltitude(const Vector& point, int threshold, int accuracy) {
 bool SceneMan::IsPointInNoGravArea(const Vector& point) const {
 	// Todo, instead of a nograv area maybe best to tag certain areas as NoGrav. As otherwise it's tricky to keep track of when things are removed
 	if (m_pCurrentScene) {
-		Scene::Area* noGravArea = m_pCurrentScene->GetArea("NoGravityArea");
+		Scene::Area* noGravArea = m_pCurrentScene->GetArea1("NoGravityArea");
 		if (noGravArea && noGravArea->IsInside(point)) {
 			return true;
 		}
@@ -2648,7 +2648,7 @@ void SceneMan::Draw(BITMAP* targetBitmap, BITMAP* targetGUIBitmap, const Vector&
 
 			static bool s_drawNoGravBoxes = false;
 			if (s_drawNoGravBoxes) {
-				if (Scene::Area* noGravArea = m_pCurrentScene->GetArea("NoGravityArea")) {
+				if (Scene::Area* noGravArea = m_pCurrentScene->GetArea1("NoGravityArea")) {
 					const std::vector<Box>& boxList = noGravArea->GetBoxes();
 					g_FrameMan.SetTransTableFromPreset(TransparencyPreset::MoreTrans);
 					drawing_mode(DRAW_MODE_TRANS, 0, 0, 0);
diff --git a/Source/Menus/AreaPickerGUI.cpp b/Source/Menus/AreaPickerGUI.cpp
@@ -173,7 +173,7 @@ Scene::Area* AreaPickerGUI::GetNextArea() {
 	GUIListPanel::Item* pItem = m_pAreasList->GetSelected();
 	if (pItem) {
 		g_GUISound.SelectionChangeSound()->Play();
-		return g_SceneMan.GetScene()->GetArea(pItem->m_Name);
+		return g_SceneMan.GetScene()->GetArea2(pItem->m_Name);
 	}
 	return 0;
 }
@@ -189,7 +189,7 @@ Scene::Area* AreaPickerGUI::GetPrevArea() {
 	GUIListPanel::Item* pItem = m_pAreasList->GetSelected();
 	if (pItem) {
 		g_GUISound.SelectionChangeSound()->Play();
-		return g_SceneMan.GetScene()->GetArea(pItem->m_Name);
+		return g_SceneMan.GetScene()->GetArea2(pItem->m_Name);
 	}
 	return 0;
 }
@@ -215,7 +215,7 @@ void AreaPickerGUI::UpdateAreasList(std::string selectAreaName) {
 		// Set the picked area to be the one now selected at the top
 		GUIListPanel::Item* pItem = m_pAreasList->GetSelected();
 		if (pItem)
-			m_pPickedArea = pScene->GetArea(pItem->m_Name);
+			m_pPickedArea = pScene->GetArea2(pItem->m_Name);
 	}
 }
 
@@ -329,7 +329,7 @@ void AreaPickerGUI::Update() {
 		// Report the newly selected item as being 'picked', but don't close the picker
 		GUIListPanel::Item* pItem = m_pAreasList->GetSelected();
 		if (pItem)
-			m_pPickedArea = g_SceneMan.GetScene()->GetArea(pItem->m_Name);
+			m_pPickedArea = g_SceneMan.GetScene()->GetArea2(pItem->m_Name);
 		g_GUISound.SelectionChangeSound()->Play();
 	} else if (pressUp) {
 		m_SelectedAreaIndex--;
@@ -341,7 +341,7 @@ void AreaPickerGUI::Update() {
 		// Report the newly selected item as being 'picked', but don't close the picker
 		GUIListPanel::Item* pItem = m_pAreasList->GetSelected();
 		if (pItem)
-			m_pPickedArea = g_SceneMan.GetScene()->GetArea(pItem->m_Name);
+			m_pPickedArea = g_SceneMan.GetScene()->GetArea2(pItem->m_Name);
 
 		g_GUISound.SelectionChangeSound()->Play();
 	}
@@ -351,7 +351,7 @@ void AreaPickerGUI::Update() {
 		GUIListPanel::Item* pItem = m_pAreasList->GetSelected();
 		if (pItem) {
 			// User has made final selection, so close the Picker
-			if (m_pPickedArea = g_SceneMan.GetScene()->GetArea(pItem->m_Name)) {
+			if (m_pPickedArea = g_SceneMan.GetScene()->GetArea2(pItem->m_Name)) {
 				g_GUISound.AreaPickedSound()->Play();
 				SetEnabled(false);
 			}
@@ -363,7 +363,7 @@ void AreaPickerGUI::Update() {
 		GUIListPanel::Item* pItem = m_pAreasList->GetSelected();
 		if (pItem) {
 			// User has made final selection, so close the Picker
-			if (m_pPickedArea = g_SceneMan.GetScene()->GetArea(pItem->m_Name)) {
+			if (m_pPickedArea = g_SceneMan.GetScene()->GetArea2(pItem->m_Name)) {
 				g_GUISound.AreaPickedSound()->Play();
 				SetEnabled(false);
 			}
@@ -412,7 +412,7 @@ void AreaPickerGUI::Update() {
 					if (pItem) {
 						m_SelectedAreaIndex = m_pAreasList->GetSelectedIndex();
 						// User has made final selection, so close the Picker
-						if (m_pPickedArea = g_SceneMan.GetScene()->GetArea(pItem->m_Name)) {
+						if (m_pPickedArea = g_SceneMan.GetScene()->GetArea2(pItem->m_Name)) {
 							g_GUISound.AreaPickedSound()->Play();
 							SetEnabled(false);
 						}
@@ -429,7 +429,7 @@ void AreaPickerGUI::Update() {
 			GUIListPanel::Item* pItem = m_pAreasList->GetSelected();
 			if (pItem) {
 				// User has made final selection, so close the Picker
-				if (m_pPickedArea = g_SceneMan.GetScene()->GetArea(pItem->m_Name)) {
+				if (m_pPickedArea = g_SceneMan.GetScene()->GetArea2(pItem->m_Name)) {
 					g_GUISound.AreaPickedSound()->Play();
 					SetEnabled(false);
 				}
diff --git a/Source/System/PathFinder.cpp b/Source/System/PathFinder.cpp
diff --git a/Source/System/PathFinder.h b/Source/System/PathFinder.h

Original file line number	Diff line number	Diff line change
`@@ -938,7 +938,7 @@ void HDFirearm::Update() {`
`938`	`938`	`m_FireSound->Play(m_Pos);`
`939`	`939`	`}`
`940`	`940`	`if (m_FireEchoSound) {`
`941`		`- Scene::Area* noEchoArea = g_SceneMan.GetScene()->GetArea("IndoorArea");`
	`941`	`+ Scene::Area* noEchoArea = g_SceneMan.GetScene()->GetArea1("IndoorArea");`
`942`	`942`	`if (noEchoArea == nullptr \|\| !noEchoArea->IsInside(m_Pos)) {`
`943`	`943`	`m_FireEchoSound->Play(m_Pos);`
`944`	`944`	`}`