---

start_core.h File Reference

This is a header file containing array definitions and function declarations as used in the initialisation phase. More...

Go to the source code of this file.

Defines
#define	START_X_DIMENSIONS   6
#define	START_Y_DIMENSIONS   3
Functions
void	initialise_start ()
	Function used to initialise the elements of the start array. More...
void	update_battlefield (char *name, int player, int x, int y)
	Update the battlefield array. More...
int	pieces_placed ()
	Check if all pieces have been placed on the board. More...
int	check_placement (int player, int y2)
	Check if a placement is on the correct side of the board. More...
Variables
start_piece	start [START_X_DIMENSIONS][START_Y_DIMENSIONS]

---

Detailed Description

This is a header file containing array definitions and function declarations as used in the initialisation phase.

This header file serves as a declaration file for the functions used in the initialisation phase of the game and also
contains definitions of certain variables.

---

Define Documentation

#define START_X_DIMENSIONS   6

This definition is used in the start array variable definition. It is the x coordinate of the array. The reason it is 6 is because the first three rows of the console screen are supposed to hold 6 pieces. These 6 pieces are represented as the 6 columns of the start array.

#define START_Y_DIMENSIONS   3

This definition is used in the start array variable definition. It is the y coordinate of the array. The reason it is 3 is because the first three rows of the console screen are supposed to hold 2 rows of pieces and 1 row of buttons, giving a total of 3.

---

Function Documentation

int check_placement (  int    player, int    y2 )

Check if a placement is on the correct side of the board. A function that checks if the player is placing his pieces on the correct end of the board. Parameters: player  The integer id of the player that made the move y2  The y coordinate of the move command received necessary to perform the checks Returns: int returns TRUE (1) if all placement correct, FALSE (0) otherwise This function checks if the placement made is on the correct end of the board and if not then prints the adequate debug information and returns FALSE. Exploiting the unique identification number that each player has, we check if player 0 has placed a piece in the bottom two rows and player 1 in the top two. For this reason only the y coordinate is used to perform the check. i.e. in squares in battlefield (y = 8,9) for player 1, and 0,1 for player 0 { if (player == 1){ if ( (y2 == 8) || (y2 == 9)) return TRUE; else { vccPrintPdxDebugInfo("Player 1 can only place pieces in the top part of the board\n"); return FALSE; } } else if (player == 0){ if ( (y2 == 0) || (y2 == 1)) return TRUE; else { vccPrintPdxDebugInfo("Player 0 can only place pieces in the bottom part of the board\n"); return FALSE; } } return FALSE; }

void initialise_start (    )

Function used to initialise the elements of the start array. Returns: void Basic functionality is to assign to each element of the array a specific value that represents that piece. For example, start[0][1] is assigned to a Marshal. This element fills its fields with the below values: marshal.name = "Marshal"; marshal.remaining = 1; marshal.player = 0; At the end this piece structure is assigned to the correct element and this square is now initialised start[0][1] = marshal; This function is automatically called by the poin_entry_Init function in the white.c file, when the game is commenced. { /* first form structs of pieces to be added to array */ start_piece marshal , general , colonel , major , captain , lieutenant; start_piece sergeant , miner , scout , spy , bomb , flag; /* marshal */ marshal.name = "Marshal"; marshal.remaining = 1; marshal.player = 0; /* general */ general.name = "General"; general.remaining = 1; general.player = 0; /* colonel */ colonel.name = "Colonel"; colonel.remaining = 2; colonel.player = 0; /* major */ major.name = "Major"; major.remaining = 3; major.player = 0; /* captain */ captain.name = "Captain"; captain.remaining = 4; captain.player = 0; /* lieutenant */ lieutenant.name = "Lieutenant"; lieutenant.remaining = 4; lieutenant.player = 0; /* sergeant */ sergeant.name = "Sergeant"; sergeant.remaining = 4; sergeant.player = 0; /* miner */ miner.name = "Miner"; miner.remaining = 5; miner.player = 0; /* scout */ scout.name = "Scout"; scout.remaining = 8; scout.player = 0; /* spy */ spy.name = "Spy"; spy.remaining = 1; spy.player = 0; /* bomb */ bomb.name = "Bomb"; bomb.remaining = 6; bomb.player = 0; /* flag */ flag.name = "Flag"; flag.remaining = 1; flag.player = 0; /* Now place data (structs) on board */ /* first row */ start[0][1] = marshal; start[1][1] = general; start[2][1] = colonel; start[3][1] = major; start[4][1] = captain; start[5][1] = lieutenant; /* ...second row */ start[0][2] = sergeant; start[1][2] = miner; start[2][2] = scout; start[3][2] = spy; start[4][2] = bomb; start[5][2] = flag; }

int pieces_placed (    )

Check if all pieces have been placed on the board. A function that checks if all pieces are placed on board Returns: int returns TRUE (1) if all pieces have been placed, FALSE (0) otherwise This function checks the start array to see if all pieces have been placed on the board. It is called whenever a player presses the START button. i.e. whenever he tries to commence the game. The game rules point out that for a game to start the player must firstly place all pieces on the board. To check this, I have exploited the representation of a piece during the initialisation stage with the start array. In particular, the "remaining" field, which shows how many pieces are still to be placed on the board. { int i , j; for (i=0; i<=5; i++){ for (j=0; j<=2; j++){ if (start[i][j].remaining != 0) return FALSE; } } return TRUE; /* TRUE means all pieces have been placed */ }

void update_battlefield (  char *    name, int    player, int    x, int    y )

Update the battlefield array. A function that updates the battlefield array. Parameters: name  The name of the piece that was placed on the battlefield player  The integer id of the player that made the move x  The integer x coordinate of the board that the piece was placed on y  The integer y coordinate of the board that the piece was placed on Returns: void This function is the link between the initialisation part of the game and the battle part. When a piece is primarily, placed on the board two things occur: The start array is updated (i.e. the "remaining" field is decremented The battlefield array element corresponding to the coordinates where the piece was placed, is filled in with its data. For example, if the piece in start[2][1] is placed on piece [5][4] on the board, then the element battlefield[5][4] should now hold the data for a Marshal which is the start[2][1] element. This function makes use of the getIndexInTable function and the pieces_table array. { int index; /* now update data on battlefield */ index = getIndexInTable(name); battlefield[x][y].occupied = pieces_table[index]; battlefield[x][y].player = player; }

---

Variable Documentation

start_piece start[START_X_DIMENSIONS][START_Y_DIMENSIONS]

This array is used throughout the initialisation phase of the game, during which the players place their pieces on the board. Its dimensions represent the first three rows of the screen, which consist of two rows of pieces and one row of buttons. Thus, start[2][1] will correspond to a specific piece while start[1][0] to a button. Each element of the array is associated with a piece and contains the informatin needed to define it and check how many pieces of this kind have yet to be placed (field "remaining"). For reasons of clarity, the numbering of the array corresponds to the numbering on the screen. For example, start[2][1] corresponds to the square x=2, y=1 on the screen. The start array is filled in during the poin_entry_Init() function in white.c. Observing the definition of this function one can see in detail how the coordinates are arranged on the screen.

---