From 236b42bcffae68974abff22a6aaf8ea0eec35f50 Mon Sep 17 00:00:00 2001
From: Paul Gilbert
Date: Tue, 3 Mar 2009 09:00:49 +0000
Subject: Formatting fixes

svn-id: r39086
---
 engines/cruise/actor.cpp | 24 ++++++++++++++++++++----
 engines/cruise/font.cpp  |  9 +++++++++
 engines/cruise/font.h    |  1 +
 engines/cruise/menu.cpp  |  8 --------
 4 files changed, 30 insertions(+), 12 deletions(-)

diff --git a/engines/cruise/actor.cpp b/engines/cruise/actor.cpp
index a2e0a76f2d..787248abcb 100644
--- a/engines/cruise/actor.cpp
+++ b/engines/cruise/actor.cpp
@@ -577,7 +577,9 @@ void valide_noeud(int16 table[], int16 p, int *nclick, int16 solution0[20 + 3][2
 	}
 }
 
-//computePathfinding(returnVar2, params.X, params.Y, aniX, aniY, currentActor->stepX, currentActor->stepY);
+/**
+ * Computes a path for an actor to walk between a given source and destination position
+ */
 int16 computePathfinding(int16 *pSolution, int16 x, int16 y, int16 destX, int16 destY, int16 stepX, int16 stepY, int16 oldPathId) {
 	persoStruct *perso;
 	int num;
@@ -721,6 +723,9 @@ void set_anim(int ovl, int obj, int start, int x, int y, int mat, int state) {
 	setObjectPosition(ovl, obj, 5, state);
 }
 
+/**
+ * Handles the processing of any active actors to allow for handling movement
+ */
 void processAnimation(void) {
 	objectParamsQuery params;
 	int16 returnVar2[5];
@@ -793,11 +798,16 @@ void processAnimation(void) {
 			animationStart = false;
 
 			if ((currentActor->pathId >= 0) || (currentActor->phase == ANIM_PHASE_STATIC_END)) {
+
+				// Main switch statement for handling various phases of movement
+				// IMPORTANT: This switch relies on falling through cases in certain circumstances
+				// , so 'break' statements should *not* be used at the end of case areas
 				switch (currentActor->phase) {
-				// In-place (on the spot) animationos
 				case ANIM_PHASE_STATIC_END:
 				case ANIM_PHASE_STATIC: 
 				{
+					// In-place (on the spot) animationos
+
 					if ((currentActor->counter == -1) && (currentActor->phase == ANIM_PHASE_STATIC)) {
 						affiche_chemin(currentActor->pathId, returnVar2);
 
@@ -871,8 +881,10 @@ void processAnimation(void) {
 					}
 				}
 
-				// Walk animations
-				case ANIM_PHASE_MOVE: {
+				case ANIM_PHASE_MOVE:
+				{
+					// Walk animations
+
 					if (currentActor->counter >= 1) {
 						affiche_chemin(currentActor->pathId, returnVar2);
 
@@ -908,8 +920,11 @@ void processAnimation(void) {
 						break;
 					}
 				}
+
 				case ANIM_PHASE_END:
 				{
+					// End of walk animation
+
 					int newA = actor_end[currentActor->startDirection][0];
 
 					set_anim(currentActor->overlayNumber, currentActor->idx, currentActor->start,
@@ -928,6 +943,7 @@ void processAnimation(void) {
 				}
 			}
 		}
+
 		currentActor = nextActor;
 	}
 }
diff --git a/engines/cruise/font.cpp b/engines/cruise/font.cpp
index 6d87d0ef6f..de82b4b436 100644
--- a/engines/cruise/font.cpp
+++ b/engines/cruise/font.cpp
@@ -445,4 +445,13 @@ gfxEntryStruct *renderText(int inRightBorder_X, const char *string) {
 	return generatedGfxEntry;
 }
 
+void freeGfx(gfxEntryStruct *pGfx) {
+	if (pGfx->imagePtr) {
+		free(pGfx->imagePtr);
+	}
+
+	free(pGfx);
+}
+
+
 } // End of namespace Cruise
diff --git a/engines/cruise/font.h b/engines/cruise/font.h
index 0a3dc14379..6404c91230 100644
--- a/engines/cruise/font.h
+++ b/engines/cruise/font.h
@@ -70,6 +70,7 @@ void renderWord(uint8 *fontPtr_Data, uint8 *outBufferPtr,
 gfxEntryStruct *renderText(int inRightBorder_X, const char *string);
 void drawString(int32 x, int32 y, const char *string, uint8 * buffer, uint8 fontColour,
                 int32 inRightBorder_X);
+void freeGfx(gfxEntryStruct *pGfx);
 
 } // End of namespace Cruise
 
diff --git a/engines/cruise/menu.cpp b/engines/cruise/menu.cpp
index 8125b06ca2..f5d61a4843 100644
--- a/engines/cruise/menu.cpp
+++ b/engines/cruise/menu.cpp
@@ -273,14 +273,6 @@ int playerMenu(int menuX, int menuY) {
 	return 0;
 }
 
-void freeGfx(gfxEntryStruct *pGfx) {
-	if (pGfx->imagePtr) {
-		free(pGfx->imagePtr);
-	}
-
-	free(pGfx);
-}
-
 void freeMenu(menuStruct *pMenu) {
 	menuElementStruct *pElement = pMenu->ptrNextElement;
 
-- 
cgit v1.2.3