LASTEXPRESS: Rename Chapters and Gendarmes functions

4 files changed, 72 insertions, 67 deletions

diff --git a/engines/lastexpress/entities/chapters.cpp b/engines/lastexpress/entities/chapters.cpp
index 341c55aeaa..4972ff69f6 100644
--- a/engines/lastexpress/entities/chapters.cpp
+++ b/engines/lastexpress/entities/chapters.cpp
@@ -77,7 +77,7 @@ Chapters::Chapters(LastExpressEngine *engine) : Entity(engine, kEntityChapters)
 	ADD_CALLBACK_FUNCTION(Chapters, exitStation);
 	ADD_CALLBACK_FUNCTION(Chapters, chapter1);
 	ADD_CALLBACK_FUNCTION(Chapters, resetMainEntities);
-	ADD_CALLBACK_FUNCTION(Chapters, chapter1End);
+	ADD_CALLBACK_FUNCTION(Chapters, firstDream);
 	ADD_CALLBACK_FUNCTION(Chapters, chapter1Init);
 	ADD_CALLBACK_FUNCTION(Chapters, chapter1Handler);
 	ADD_CALLBACK_FUNCTION(Chapters, chapter1Next);
@@ -154,7 +154,8 @@ IMPLEMENT_FUNCTION(5, Chapters, resetMainEntities)
 IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
-IMPLEMENT_FUNCTION(6, Chapters, chapter1End)
+IMPLEMENT_FUNCTION(6, Chapters, firstDream)
+	// Chapter 1 end
 	switch (savepoint.action) {
 	default:
 		break;
@@ -384,6 +385,7 @@ IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
 IMPLEMENT_FUNCTION(8, Chapters, chapter1Handler)
+	// Moving at night
 	switch (savepoint.action) {
 	default:
 		break;
@@ -704,7 +706,7 @@ label_chapter1_next:
 			setup_chapter1Next();
 		} else {
 			setCallback(23);
-			setup_chapter1End();
+			setup_firstDream();
 		}
 		break;
 	}
@@ -917,6 +919,7 @@ IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
 IMPLEMENT_FUNCTION(15, Chapters, chapter3Handler)
+	// Moving during the afternoon
 	switch (savepoint.action) {
 	default:
 		break;
@@ -1077,6 +1080,7 @@ IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
 IMPLEMENT_FUNCTION(16, Chapters, viennaEvents)
+	// End in Vienna
 	switch (savepoint.action) {
 	default:
 		break;
@@ -1224,6 +1228,7 @@ IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
 IMPLEMENT_FUNCTION(19, Chapters, chapter4Handler)
+	// Moving during the second night
 	switch (savepoint.action) {
 	default:
 		break;
diff --git a/engines/lastexpress/entities/chapters.h b/engines/lastexpress/entities/chapters.h
index 39739aa92e..abc464845f 100644
--- a/engines/lastexpress/entities/chapters.h
+++ b/engines/lastexpress/entities/chapters.h
@@ -70,7 +70,7 @@ public:
 	/**
 	 * Handle end of Chapter 1 events
 	 */
-	DECLARE_FUNCTION(chapter1End)
+	DECLARE_FUNCTION(firstDream)
 
 	/**
 	 * Init Chapter 1 data
diff --git a/engines/lastexpress/entities/gendarmes.cpp b/engines/lastexpress/entities/gendarmes.cpp
index 7b31c592cd..5ecf8ef804 100644
--- a/engines/lastexpress/entities/gendarmes.cpp
+++ b/engines/lastexpress/entities/gendarmes.cpp
@@ -37,16 +37,16 @@ namespace LastExpress {
 Gendarmes::Gendarmes(LastExpressEngine *engine) : Entity(engine, kEntityGendarmes) {
 	ADD_CALLBACK_FUNCTION(Gendarmes, reset);
 	ADD_CALLBACK_FUNCTION(Gendarmes, chapter1);
-	ADD_CALLBACK_FUNCTION(Gendarmes, arrestDraw);
-	ADD_CALLBACK_FUNCTION(Gendarmes, arrestPlaysound);
-	ADD_CALLBACK_FUNCTION(Gendarmes, arrestPlaysound16);
-	ADD_CALLBACK_FUNCTION(Gendarmes, arrestCallback);
+	ADD_CALLBACK_FUNCTION(Gendarmes, doDraw);
+	ADD_CALLBACK_FUNCTION(Gendarmes, doDialog);
+	ADD_CALLBACK_FUNCTION(Gendarmes, doDialogFullVolume);
+	ADD_CALLBACK_FUNCTION(Gendarmes, doWait);
 	ADD_CALLBACK_FUNCTION(Gendarmes, savegame);
-	ADD_CALLBACK_FUNCTION(Gendarmes, arrestUpdateEntity);
-	ADD_CALLBACK_FUNCTION(Gendarmes, function9);
-	ADD_CALLBACK_FUNCTION(Gendarmes, function10);
+	ADD_CALLBACK_FUNCTION(Gendarmes, doWalk);
+	ADD_CALLBACK_FUNCTION(Gendarmes, doCompartment);
+	ADD_CALLBACK_FUNCTION(Gendarmes, trappedCath);
 	ADD_CALLBACK_FUNCTION(Gendarmes, chapter1Handler);
-	ADD_CALLBACK_FUNCTION(Gendarmes, function12);
+	ADD_CALLBACK_FUNCTION(Gendarmes, searchTrain);
 	ADD_CALLBACK_FUNCTION(Gendarmes, function13);
 	ADD_CALLBACK_FUNCTION(Gendarmes, chapter2);
 	ADD_CALLBACK_FUNCTION(Gendarmes, chapter3);
@@ -76,23 +76,23 @@ IMPLEMENT_FUNCTION(2, Gendarmes, chapter1)
 IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
-IMPLEMENT_FUNCTION_S(3, Gendarmes, arrestDraw)
-	arrest(savepoint);
+IMPLEMENT_FUNCTION_S(3, Gendarmes, doDraw)
+	handleAction(savepoint);
 IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
-IMPLEMENT_FUNCTION_S(4, Gendarmes, arrestPlaysound)
-	arrest(savepoint, true);
+IMPLEMENT_FUNCTION_S(4, Gendarmes, doDialog)
+	handleAction(savepoint, true);
 IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
-IMPLEMENT_FUNCTION_S(5, Gendarmes, arrestPlaysound16)
-	arrest(savepoint, true, kFlagDefault);
+IMPLEMENT_FUNCTION_S(5, Gendarmes, doDialogFullVolume)
+	handleAction(savepoint, true, kFlagDefault);
 IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
-IMPLEMENT_FUNCTION_I(6, Gendarmes, arrestCallback, uint32)
-	arrest(savepoint, true, kFlagInvalid, true);
+IMPLEMENT_FUNCTION_I(6, Gendarmes, doWait, uint32)
+	handleAction(savepoint, true, kFlagInvalid, true);
 IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
@@ -101,12 +101,12 @@ IMPLEMENT_FUNCTION_II(7, Gendarmes, savegame, SavegameType, uint32)
 IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
-IMPLEMENT_FUNCTION_II(8, Gendarmes, arrestUpdateEntity, CarIndex, EntityPosition)
-	arrest(savepoint, true, kFlagInvalid, false, true);
+IMPLEMENT_FUNCTION_II(8, Gendarmes, doWalk, CarIndex, EntityPosition)
+	handleAction(savepoint, true, kFlagInvalid, false, true);
 IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
-IMPLEMENT_FUNCTION_IISS(9, Gendarmes, function9, CarIndex, EntityPosition)
+IMPLEMENT_FUNCTION_IISS(9, Gendarmes, doCompartment, CarIndex, EntityPosition)
 	EntityData::EntityParametersSSS *parameters1 = (EntityData::EntityParametersSSS*)_data->getCurrentParameters(1);
 	EntityData::EntityParametersISII *parameters2 = (EntityData::EntityParametersISII*)_data->getCurrentParameters(2);
 
@@ -178,13 +178,13 @@ IMPLEMENT_FUNCTION_IISS(9, Gendarmes, function9, CarIndex, EntityPosition)
 		  || (params->param1 == kCarGreenSleeping && params->param2 == kPosition_8200 && getEntities()->isOutsideAlexeiWindow()))
 		 && !getEntities()->isInsideCompartment(kEntityPlayer, kCarRedSleeping, kPosition_7850)) {
 			setCallback(1);
-			setup_function10((CarIndex)params->param1, (EntityPosition)params->param2, (ObjectIndex)parameters2->param5);
+			setup_trappedCath((CarIndex)params->param1, (EntityPosition)params->param2, (ObjectIndex)parameters2->param5);
 		} else {
 			getEntities()->drawSequenceLeft(kEntityGendarmes, (char *)&parameters1->seq1);
 			getEntities()->enterCompartment(kEntityGendarmes, (ObjectIndex)CURRENT_PARAM(2, 5));
 
 			setCallback(parameters2->param6 ? 2 : 3);
-			setup_arrestPlaysound(parameters2->param6 ? "POL1044A" : "POL1044B");
+			setup_doDialog(parameters2->param6 ? "POL1044A" : "POL1044B");
 		}
 		break;
 
@@ -202,14 +202,14 @@ IMPLEMENT_FUNCTION_IISS(9, Gendarmes, function9, CarIndex, EntityPosition)
 			getEntities()->drawSequenceLeft(kEntityGendarmes, (char *)&parameters1->seq2);
 			if (getEntities()->isNobodyInCompartment((CarIndex)params->param1, (EntityPosition)params->param2) || !strcmp(params->seq2, "NODIALOG")) {
 				setCallback(4);
-				setup_arrestCallback(150);
+				setup_doWait(150);
 			} else {
 				char *arrestSound = (char *)&parameters2->seq;
 				strcpy(arrestSound, "POL1045");
 				strcat(arrestSound, (char *)&params->seq2);
 
 				setCallback(5);
-				setup_arrestPlaysound(arrestSound);
+				setup_doDialog(arrestSound);
 			}
 			break;
 
@@ -226,7 +226,7 @@ IMPLEMENT_FUNCTION_IISS(9, Gendarmes, function9, CarIndex, EntityPosition)
 			getData()->location = kLocationInsideCompartment;
 
 			setCallback(6);
-			setup_arrestDraw((char *)&parameters1->seq3);
+			setup_doDraw((char *)&parameters1->seq3);
 			break;
 
 		case 6:
@@ -240,7 +240,7 @@ IMPLEMENT_FUNCTION_IISS(9, Gendarmes, function9, CarIndex, EntityPosition)
 IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
-IMPLEMENT_FUNCTION_III(10, Gendarmes, function10, CarIndex, EntityPosition, ObjectIndex)
+IMPLEMENT_FUNCTION_III(10, Gendarmes, trappedCath, CarIndex, EntityPosition, ObjectIndex)
 	switch (savepoint.action) {
 	default:
 		break;
@@ -287,7 +287,7 @@ IMPLEMENT_FUNCTION_III(10, Gendarmes, function10, CarIndex, EntityPosition, Obje
 		getObjects()->update((ObjectIndex)params->param3, kEntityGendarmes, getObjects()->get((ObjectIndex)params->param3).status, kCursorNormal, kCursorNormal);
 
 		setCallback(5);
-		setup_arrestPlaysound16("POL1046B");
+		setup_doDialogFullVolume("POL1046B");
 		break;
 
 	case kActionOpenDoor:
@@ -299,7 +299,7 @@ IMPLEMENT_FUNCTION_III(10, Gendarmes, function10, CarIndex, EntityPosition, Obje
 		getObjects()->update((ObjectIndex)params->param3, kEntityGendarmes, getObjects()->get((ObjectIndex)params->param3).status, kCursorNormal, kCursorNormal);
 
 		setCallback(1);
-		setup_arrestPlaysound16("POL1046");
+		setup_doDialogFullVolume("POL1046");
 		break;
 
 	case kActionCallback:
@@ -351,12 +351,12 @@ IMPLEMENT_FUNCTION_END
 IMPLEMENT_FUNCTION(11, Gendarmes, chapter1Handler)
 	if (savepoint.action == kAction169499649) {
 		getSavePoints()->push(kEntityGendarmes, kEntityMertens, kAction190082817);
-		setup_function12();
+		setup_searchTrain();
 	}
 IMPLEMENT_FUNCTION_END
 
 //////////////////////////////////////////////////////////////////////////
-IMPLEMENT_FUNCTION(12, Gendarmes, function12)
+IMPLEMENT_FUNCTION(12, Gendarmes, searchTrain)
 	switch (savepoint.action) {
 	default:
 		break;
@@ -369,7 +369,7 @@ IMPLEMENT_FUNCTION(12, Gendarmes, function12)
 		getProgress().field_14 = 29;
 
 		setCallback(1);
-		setup_arrestUpdateEntity(kCarGreenSleeping, kPosition_5540);
+		setup_doWalk(kCarGreenSleeping, kPosition_5540);
 		break;
 
 	case kActionCallback:
@@ -379,42 +379,42 @@ IMPLEMENT_FUNCTION(12, Gendarmes, function12)
 
 		case 1:
 			setCallback(2);
-			setup_function9(kCarGreenSleeping, kPosition_5790, "d", "A");
+			setup_doCompartment(kCarGreenSleeping, kPosition_5790, "d", "A");
 			break;
 
 		case 2:
 			setCallback(3);
-			setup_arrestUpdateEntity(kCarGreenSleeping, kPosition_6220);
+			setup_doWalk(kCarGreenSleeping, kPosition_6220);
 			break;
 
 		case 3:
 			setCallback(4);
-			setup_function9(kCarGreenSleeping, kPosition_6470, "c", "B");
+			setup_doCompartment(kCarGreenSleeping, kPosition_6470, "c", "B");
 			break;
 
 		case 4:
 			setCallback(5);
-			setup_arrestUpdateEntity(kCarGreenSleeping, kPosition_7250);
+			setup_doWalk(kCarGreenSleeping, kPosition_7250);
 			break;
 
 		case 5:
 			setCallback(6);
-			setup_function9(kCarGreenSleeping, kPosition_7500, "b", "C");
+			setup_doCompartment(kCarGreenSleeping, kPosition_7500, "b", "C");
 			break;
 
 		case 6:
 			setCallback(7);
-			setup_arrestUpdateEntity(kCarGreenSleeping, kPosition_7950);
+			setup_doWalk(kCarGreenSleeping, kPosition_7950);
 			break;
 
 		case 7:
 			setCallback(8);
-			setup_function9(kCarGreenSleeping, kPosition_8200, "a", "NODIALOG");
+			setup_doCompartment(kCarGreenSleeping, kPosition_8200, "a", "NODIALOG");
 			break;
 
 		case 8:
 			setCallback(9);
-			setup_arrestUpdateEntity(kCarGreenSleeping, kPosition_9460);
+			setup_doWalk(kCarGreenSleeping, kPosition_9460);
 			break;
 
 		case 9:
@@ -427,77 +427,77 @@ IMPLEMENT_FUNCTION(12, Gendarmes, function12)
 			}
 
 			setCallback(10);
-			setup_arrestUpdateEntity(kCarRedSleeping, kPosition_2490);
+			setup_doWalk(kCarRedSleeping, kPosition_2490);
 			break;
 
 		case 10:
 			setCallback(11);
-			setup_function9(kCarRedSleeping, kPosition_2740, "h", "NODIALOG");
+			setup_doCompartment(kCarRedSleeping, kPosition_2740, "h", "NODIALOG");
 			break;
 
 		case 11:
 			setCallback(12);
-			setup_arrestUpdateEntity(kCarRedSleeping, kPosition_3820);
+			setup_doWalk(kCarRedSleeping, kPosition_3820);
 			break;
 
 		case 12:
 			setCallback(13);
-			setup_function9(kCarRedSleeping, kPosition_4070, "f", "E");
+			setup_doCompartment(kCarRedSleeping, kPosition_4070, "f", "E");
 			break;
 
 		case 13:
 			setCallback(14);
-			setup_arrestUpdateEntity(kCarRedSleeping, kPosition_4590);
+			setup_doWalk(kCarRedSleeping, kPosition_4590);
 			break;
 
 		case 14:
 			setCallback(15);
-			setup_function9(kCarRedSleeping, kPosition_4840, "e", "F");
+			setup_doCompartment(kCarRedSleeping, kPosition_4840, "e", "F");
 			break;
 
 		case 15:
 			setCallback(16);
-			setup_arrestUpdateEntity(kCarRedSleeping, kPosition_5540);
+			setup_doWalk(kCarRedSleeping, kPosition_5540);
 			break;
 
 		case 16:
 			setCallback(17);
-			setup_function9(kCarRedSleeping, kPosition_5790, "d", "G");
+			setup_doCompartment(kCarRedSleeping, kPosition_5790, "d", "G");
 			break;
 
 		case 17:
 			setCallback(18);
-			setup_arrestUpdateEntity(kCarRedSleeping, kPosition_6220);
+			setup_doWalk(kCarRedSleeping, kPosition_6220);
 			break;
 
 		case 18:
 			setCallback(19);
-			setup_function9(kCarRedSleeping, kPosition_6470, "c", "H");
+			setup_doCompartment(kCarRedSleeping, kPosition_6470, "c", "H");
 			break;
 
 		case 19:
 			setCallback(20);
-			setup_arrestUpdateEntity(kCarRedSleeping, kPosition_7250);
+			setup_doWalk(kCarRedSleeping, kPosition_7250);
 			break;
 
 		case 20:
 			setCallback(21);
-			setup_function9(kCarRedSleeping, kPosition_7500, "b", "J");
+			setup_doCompartment(kCarRedSleeping, kPosition_7500, "b", "J");
 			break;
 
 		case 21:
 			setCallback(22);
-			setup_arrestUpdateEntity(kCarRedSleeping, kPosition_7950);
+			setup_doWalk(kCarRedSleeping, kPosition_7950);
 			break;
 
 		case 22:
 			setCallback(23);
-			setup_function9(kCarRedSleeping, kPosition_8200, "a", "NODIALOG");
+			setup_doCompartment(kCarRedSleeping, kPosition_8200, "a", "NODIALOG");
 			break;
 
 		case 23:
 			setCallback(24);
-			setup_arrestUpdateEntity(kCarRedSleeping, kPosition_9460);
+			setup_doWalk(kCarRedSleeping, kPosition_9460);
 			break;
 
 		case 24:
@@ -544,7 +544,7 @@ IMPLEMENT_FUNCTION_END
 //////////////////////////////////////////////////////////////////////////
 // Private functions
 //////////////////////////////////////////////////////////////////////////
-void Gendarmes::arrest(const SavePoint &savepoint, bool shouldPlaySound, SoundFlag flag, bool checkCallback, bool shouldUpdateEntity) {
+void Gendarmes::handleAction(const SavePoint &savepoint, bool shouldPlaySound, SoundFlag flag, bool checkCallback, bool shouldUpdateEntity) {
 	switch (savepoint.action) {
 	default:
 		break;
diff --git a/engines/lastexpress/entities/gendarmes.h b/engines/lastexpress/entities/gendarmes.h
index 8475c50799..1cde626a22 100644
--- a/engines/lastexpress/entities/gendarmes.h
+++ b/engines/lastexpress/entities/gendarmes.h
@@ -46,10 +46,10 @@ public:
 	 */
 	DECLARE_FUNCTION(chapter1)
 
-	DECLARE_FUNCTION_1(arrestDraw, const char *sequence)
-	DECLARE_FUNCTION_1(arrestPlaysound, const char *soundName)
-	DECLARE_FUNCTION_1(arrestPlaysound16, const char *soundName)
-	DECLARE_FUNCTION_1(arrestCallback, uint32 timeValue)
+	DECLARE_FUNCTION_1(doDraw, const char *sequence)
+	DECLARE_FUNCTION_1(doDialog, const char *soundName)
+	DECLARE_FUNCTION_1(doDialogFullVolume, const char *soundName)
+	DECLARE_FUNCTION_1(doWait, uint32 timeValue)
 
 	/**
 	 * Saves the game
@@ -59,11 +59,11 @@ public:
 	 */
 	DECLARE_FUNCTION_2(savegame, SavegameType savegameType, uint32 param)
 
-	DECLARE_FUNCTION_2(arrestUpdateEntity, CarIndex car, EntityPosition entityPosition)
-	DECLARE_FUNCTION_4(function9, CarIndex car, EntityPosition entityPosition, const char *sequence1, const char *sequence2)
-	DECLARE_FUNCTION_3(function10, CarIndex car, EntityPosition entityPosition, ObjectIndex object)
+	DECLARE_FUNCTION_2(doWalk, CarIndex car, EntityPosition entityPosition)
+	DECLARE_FUNCTION_4(doCompartment, CarIndex car, EntityPosition entityPosition, const char *sequence1, const char *sequence2)
+	DECLARE_FUNCTION_3(trappedCath, CarIndex car, EntityPosition entityPosition, ObjectIndex object)
 	DECLARE_FUNCTION(chapter1Handler)
-	DECLARE_FUNCTION(function12)
+	DECLARE_FUNCTION(searchTrain)
 	DECLARE_FUNCTION(function13)
 
 	/**
@@ -87,7 +87,7 @@ public:
 	DECLARE_FUNCTION(chapter5)
 
 private:
-	void arrest(const SavePoint &savepoint, bool playSound = false, SoundFlag flag = kFlagInvalid, bool checkCallback = false, bool shouldUpdateEntity = false);
+	void handleAction(const SavePoint &savepoint, bool playSound = false, SoundFlag flag = kFlagInvalid, bool checkCallback = false, bool shouldUpdateEntity = false);
 };
 
 } // End of namespace LastExpress