---

white.c File Reference

This file is run by VCC when the simulation is commenced. It is the main of the core module. More...

#include "white_interface.h"
#include <start_piece.h>
#include <piece.h>
#include <battlefield_piece.h>
#include "start_core.h"
#include "battle_core.h"
#include "start_core.c"
#include "battle_functions.c"

Defines
#define	TRUE   1
#define	FALSE   0
Functions
int	vccPrintPdxDebugInfo (const char *format,...)
	Function used for debugging. More...
int	strcmp (const char *s1, const char *s2)
	Compare two strings. More...
int	abs (int a)
	Get absolute value of parameter. More...
void	poin_entry_Init ()
	Function called upon starting the simulation. More...
void	poin_entry_Begin ()
	Main Function of core module. More...
Variables
int	battle_started
int	player_no
int	turn

---

Detailed Description

This file is run by VCC when the simulation is commenced. It is the main of the core module.

white.c is the equivalent of a main function in ANSI C. It has two main functions namely, poin_entry_Init() and poin_entry_Run()

The implementation of the game rules starts in this file. This is the basic implemenation of the module.
All functions and data structures in other files are referenced from here. When receiving an input from other modules
this file is run. The ports are checked to see if they are enabled. If a port is enabled, the code is executed and
the appropriate output signals are sent, either to bluetooth or to the graphics module. The white_interface.h file
describes the ports and functions used, which are declared automaticaly by VCC.

Inputs to the module are a move and a button. Outputs consist of a draw , a printSting to the graphics section, a Move and a button to bluetooth

---

Define Documentation

#define FALSE   0

Variable that translates the boolean known value FALSE to an integer 0.

#define TRUE   1

Variable that translates the boolean known value TRUE to an integer 1.

---

Function Documentation

int abs (  int    a )

Get absolute value of parameter. Function that gets the absolute value of a number. Used to translate the negative coordinates received during initialisation from the input module to positive ones that allow me to reference the start array

void poin_entry_Begin (    )

Main Function of core module. This is the "driving force" of each core module. Inside this module, we can find the basic data flow and functionality of the game. There are two posible signals sent. A button and a Move. MOVE Upon receiving a move command from either the input module or bluetooth, we firstly check the source of the command. This can be: The player himself The opponent NOTE: The observer (being an observer) is not permitted to send a command (i.e. make a move or press buttons). His signals are ignored by the core module and therefore not sent to the network. Then we compare the source of the command against the player identification of the module, which is the variable player_no. The outcome is: The message was sent and received by the player himself (i.e. the user tried to make a move) In this case, we firsty check whether the player is in the initialisation phase or if the battle has started. This can be detected by the variable battle_started. If we are at the initialisation phase, we firstly check if the third variable of the Move command is negative. A negative value represents that the user picked a piece from the bottom of the board. If that piece was available (not all kinds of its piece were already placed i.e. not all Marshals), then we check where he placed it.Therefore we check if the piece of the board that he placed it on, was free and if it was on the correct side of the board. The reader is reminded that one player places his pieces on the top part of the board and the other on the bottom. When all pieces have been placed, the user can press the "start" button to commence the game. If the game has already started and a Move command is received, coming from the player himself, the order of action is different: In this case the move is firstly verified against the game rules and if it is valid the battlefield array is updated and the appropriate signals are sent to the graphics and bluetooth section. The outcome of the command is determined by if it was an attack or not. No Attack/Move: If we had a valid move then make the departing piece empty and fill in the destination piece accordingly. Then send a Move command down to bluetooth and two draw commands to graphics. i.e. Move(1,2,3,4,5): If battlefield[2][3] -> battlefield[4][5] is a valid move then make battlefield[2][3] empty and fill in battlefield[4][5] with what was in battlefield[2][3]. This action makes a move. Then send the appropriate draw commands to the Graphics module,to make battlefield[2][3] empty and battlefield[4][5] to have a piece. Attack: The outcome of the attack is determined by the decide_winner function. This can be either the attacking player winning, losing or a draw. If the player wins, then his piece should be moved where the defending piece was. If he loses then his piece should become empty. If we have a draw then both pieces should be cleared. No matter which part of the game we are on (initialisation or if the battle has started) if we have a valid move, then it is necessary to send the appropriate Move message to the network. This is because the other player and observers should be aware of the action taken and update their Graphics section and core modeule data structures appropriately, so that their data are kept up to date. The message was sent from the opponent and received by the other player. (i.e. the opponent made a move) In this case we firstly check if it is the initialisation phase or if the game has started. If it is the initialisation phase then we place a covered piece in the coordinates where the move was made. If the game has started then we determine if the piece moved by the opponent can be revealed or if it should remain covered. Furthermore we check to see if there was an attack and it was a draw, in which case we have to clear both pieces from the board. As described above, it is important for the data structures in the core section to have the adequate information, to decide whether the opponent's piece being moved should be displayed or not on its board. This depends on whether that specific piece has previously participated in a battle or not. This information should be kept in the battlefield array of the module. Whether it will be displayed, is determined by the "revealed" field in the piece composite. For a more detailed description of this field click on any piece word. The message was received by the observer.(i.e. one of the players made a move) In this case the observer has to check if it the result of an attack was a draw, in which case he has to clear both pieces from his board. If it was not a draw he simply processes the move command and sends the appropriate draw commands to the graphics module. The observer can see both player's pieces and no piece is covered. It should be noted that the observer can not send a move command or press a button. BUTTON In Startego2Go buttons are used for communication and for control. At the start of the game, a button command is sent from the input module identifying each player to the core.This is explained in the poin_entry_Init() function. From there on, in the game console the user can see 2 buttons, namely the start button and the quit button. During the initialisation of the game, if the start button is pressed the core checks if all the pieces have been placed on the board. If they have the battle_started variable is set to TRUE and the game starts. If not a message is sent explaining that only when all pieces are placed can the game commence. The quit button is used if the user wants to quit the game. Again the observer can not press a button. The only reason for using the button structure is for identification at the start of the game The result of the attack action is detailed in the decide_winner function in battle_functions.c. The code for the poin_entry_Run function is displayed below with the C comments inside explaining in more detail what the program does. { int i , temp_y1 , tmp; int k; move result; DrawSprite draw; PrintString out; char print_out[100]; button pressed; start_piece f; char *tmpString; while(TRUE) { vccAwait(); if (move_in_Enabled()){ result = *move_in_Value(); if (player_no != 2){ if (battle_started == FALSE){ /* we are in initialisation phase */ if (player_no == result.player){ if (result.y1 > 0){ /* sprintf(print_out, "You must complete placement before starting to move pieces around"); */ vccPrintPdxDebugInfo("You must complete placement before starting to move pieces around\n"); out.text = "PLACE@ALL"; out.x = 0; out.y = 6; print_Post(&out); vccAwait(10.0); for (k=0; k<10; k++){ draw.bitmapno = 13; draw.x = k; draw.y = 6; draw_Post(&draw); vccAwait(10.0); } } /* if placement process. */ if (result.y1 < 0){ temp_y1 = abs(result.y1); /* make y positive... */ if (start[result.x1][temp_y1].remaining == 0){ vccPrintPdxDebugInfo("You have already placed all %s on battlefield\n",start[result.x1][temp_y1].name); out.text = "ALL@PLACED"; out.x = 0; out.y = 6; print_Post(&out); vccAwait(10.0); for (k=0; k<10; k++){ draw.bitmapno = 13; draw.x = k; draw.y = 6; draw_Post(&draw); vccAwait(10.0); } } else if ( check_placement(player_no , result.y2) ){ if (battlefield[result.x2][result.y2].player == -1){ start[result.x1][temp_y1].remaining--; update_battlefield( start[result.x1][temp_y1].name , result.player , result.x2 , result.y2); vccPrintPdxDebugInfo("A %s was placed on the battlefield\n",battlefield[result.x2][result.y2].occupied.name); draw.bitmapno = get_bitmapno(start[result.x1][temp_y1].name); draw.x = result.x2; draw.y = result.y2; draw_Post(&draw); move_out_Post(&result); } else { vccPrintPdxDebugInfo("The square on the battlefield has already been used\n"); out.text = "OCCUPIED"; out.x = 0; out.y = 6; print_Post(&out); vccAwait(10.0); for (k=0; k<10; k++){ draw.bitmapno = 13; draw.x = k; draw.y = 6; draw_Post(&draw); vccAwait(10.0); } } } else {/* else if */ out.text = "AT@YOUR@END"; out.x = 0; out.y = 6; print_Post(&out); vccAwait(10.0); for (k=0; k<10; k++){ draw.bitmapno = 13; draw.x = k; draw.y = 6; draw_Post(&draw); vccAwait(10.0); } } /* else */ } /* if (result.y1 <= 0) */ } else { /* if player_no == result.player */ temp_y1 = abs(result.y1); update_battlefield( start[result.x1][temp_y1].name , result.player , result.x2 , result.y2); draw.bitmapno = 12; /* opponent draws a covered piece */ draw.x = result.x2; draw.y = result.y2; draw_Post(&draw); } /* else */ } else if (battle_started == TRUE){ if (player_no == result.player){ if (turn == 1){ if (check_piece_clicked(result.player , result.x1 , result.y1 , result.x2 , result.y2)){ if (attack_or_move(result.x2 , result.y2)){ /* if he attacked */ vccPrintPdxDebugInfo("%s attacking piece in [%d][%d] which is a %s\n",battlefield[result.x1][result.y1].occupied.name,result.x2,result.y2,battlefield[result.x2][result.y2].occupied.name); if (decide_winner(result.x1 , result.y1 , result.x2 , result.y2) == 1){ /* if piece in x1,y1 stronger */ vccPrintPdxDebugInfo("[%d][%d] won %s\n",result.x1,result.y1,battlefield[result.x1][result.y1].occupied.name); draw.bitmapno = get_bitmapno(battlefield[result.x1][result.y1].occupied.name); draw.x = result.x2; draw.y = result.y2; draw_Post(&draw); vccAwait(5.0); draw.bitmapno = 13; draw.x = result.x1; draw.y = result.y1; draw_Post(&draw); perform_move(player_no , result.x1 , result.y1 , result.x2 , result.y2 , 1); turn = 0; move_out_Post(&result); vccPrintPdxDebugInfo("%s piece in [%d][%d] is the winner\n",battlefield[result.x2][result.y2].occupied.name,result.x1,result.y1); } else if (decide_winner(result.x1 , result.y1 , result.x2 , result.y2) == 2){ /* piece in x2,y2 stronger */ /* make piece empty */ battlefield[result.x1][result.y1].occupied.name = "UNOCCUPIED"; battlefield[result.x1][result.y1].occupied.rank = -1; battlefield[result.x1][result.y1].occupied.revealed = -1; battlefield[result.x1][result.y1].player = -1; /* clear attacking piece */ draw.bitmapno = 13; draw.x = result.x1; draw.y = result.y1; draw_Post(&draw); /* also set winning piece's reveal flag to on */ battlefield[result.x2][result.y2].occupied.revealed == 1; turn = 0; result.x2 = result.x1; result.y2 = result.y1; /* delete x1 , y1 piece */ move_out_Post(&result); vccPrintPdxDebugInfo("%s piece in [%d][%d] is the winner\n",battlefield[result.x2][result.y2].occupied.name,result.x2,result.y2); } else if (decide_winner(result.x1 , result.y1 , result.x2 , result.y2) == 3){ vccPrintPdxDebugInfo("%s and %s have equal rank. Both lose!\n",battlefield[result.x1][result.y1].occupied.name,battlefield[result.x2][result.y2].occupied.name); /* make piece empty */ battlefield[result.x2][result.y2].occupied.name = "UNOCCUPIED"; battlefield[result.x2][result.y2].occupied.rank = -1; battlefield[result.x2][result.y2].occupied.revealed = -1; battlefield[result.x2][result.y2].player = -1; /* make piece empty */ battlefield[result.x1][result.y1].occupied.name = "UNOCCUPIED"; battlefield[result.x1][result.y1].occupied.rank = -1; battlefield[result.x1][result.y1].occupied.revealed = -1; battlefield[result.x1][result.y1].player = -1; /* clear attacking piece */ draw.bitmapno = 13; draw.x = result.x1; draw.y = result.y1; draw_Post(&draw); vccAwait(5.0); /* clear defending piece */ draw.bitmapno = 13; draw.x = result.x2; draw.y = result.y2; draw_Post(&draw); /* send the -1 signal indicating clearance of pieces to other player */ result.player = -1; turn = 0; move_out_Post(&result); } else if (decide_winner(result.x1 , result.y1 , result.x2 , result.y2) == 4){ vccPrintPdxDebugInfo("Flag Has been captured! Youuuuuhooouuuu\n"); out.text = "WINNER"; out.x = 0; out.y = 6; print_Post(&out); } /* else if decide_winner */ } else { /* if we have a move */ if (legal_move(result.x1 , result.y1 , result.x2 , result.y2)){ vccPrintPdxDebugInfo("Moving %s from [%d][%d] to [%d][%d]\n",battlefield[result.x1][result.y1].occupied.name , result.x1 , result.y1 , result.x2 , result.y2); draw.bitmapno = get_bitmapno(battlefield[result.x1][result.y1].occupied.name); draw.x = result.x2; draw.y = result.y2; draw_Post(&draw); vccAwait(5.0); /* clear defending piece */ draw.bitmapno = 13; draw.x = result.x1; draw.y = result.y1; draw_Post(&draw); tmp = battlefield[result.x1][result.y1].occupied.revealed; /* has piece been previously revealed? */ perform_move(player_no , result.x1 , result.y1 , result.x2 , result.y2 , tmp); turn = 0; move_out_Post(&result); }/* if */ }/* else */ }/* if */ } else { /* if turn = 1 */ out.text = "WAIT"; out.x = 0; out.y = -2; print_Post(&out); vccPrintPdxDebugInfo("\nIt is not your turn\n"); } /* else */ } else { /* if player_no == result.player */ if ( result.player == -1 ){ /* there has been an attack which was equal*/ /* make piece empty */ battlefield[result.x2][result.y2].occupied.name = "UNOCCUPIED"; battlefield[result.x2][result.y2].occupied.rank = -1; battlefield[result.x2][result.y2].occupied.revealed = -1; battlefield[result.x2][result.y2].player = -1; /* make piece empty */ battlefield[result.x1][result.y1].occupied.name = "UNOCCUPIED"; battlefield[result.x1][result.y1].occupied.rank = -1; battlefield[result.x1][result.y1].player = -1; /* clear attacking piece */ draw.bitmapno = 13; draw.x = result.x1; draw.y = result.y1; draw_Post(&draw); vccAwait(5.0); /* clear defending piece */ draw.bitmapno = 13; draw.x = result.x2; draw.y = result.y2; draw_Post(&draw); } /* if */ else { if ( (battlefield[result.x1][result.y1].player != -1) && (battlefield[result.x2][result.y2].player != -1) ){ if ( (battlefield[result.x1][result.y1].player) != (battlefield[result.x2][result.y2].player) ){ /* if two pieces moved are different then we know there was an attack so reveal pieces*/ vccPrintPdxDebugInfo("\nREVEAL\n"); battlefield[result.x1][result.y1].occupied.revealed = 1; } } if (battlefield[result.x1][result.y1].occupied.revealed == 1){ draw.bitmapno = get_bitmapno(battlefield[result.x1][result.y1].occupied.name); vccPrintPdxDebugInfo("\nBIT : %d\n",draw.bitmapno); } else draw.bitmapno = 12; draw.x = result.x2; draw.y = result.y2; draw_Post(&draw); vccAwait(5.0); draw.bitmapno = 13; draw.x = result.x1; draw.y = result.y1; draw_Post(&draw); perform_move(result.player , result.x1 , result.y1 , result.x2 , result.y2 , battlefield[result.x1][result.y1].occupied.revealed); turn = 1; /* other player played (no change if the observer since never gets inside */ } /* else */ } /* else */ } /* else if */ } else if (player_no == 2){ if (result.player != 2){ /* if this has been sent by observer then do nothing */ if (result.y1 < 0){ temp_y1 = abs(result.y1); update_battlefield( start[result.x1][temp_y1].name , result.player , result.x2 , result.y2); draw.bitmapno = get_bitmapno(start[result.x1][temp_y1].name); draw.x = result.x2; draw.y = result.y2; draw_Post(&draw); } else if ( result.player == -1 ){ /* there has been an attack which was equal*/ /* make piece empty */ battlefield[result.x2][result.y2].occupied.name = "UNOCCUPIED"; battlefield[result.x2][result.y2].occupied.rank = -1; battlefield[result.x2][result.y2].occupied.revealed = -1; battlefield[result.x2][result.y2].player = -1; /* make piece empty */ battlefield[result.x1][result.y1].occupied.name = "UNOCCUPIED"; battlefield[result.x1][result.y1].occupied.rank = -1; battlefield[result.x1][result.y1].occupied.revealed = -1; battlefield[result.x1][result.y1].player = -1; /* clear attacking piece */ draw.bitmapno = 13; draw.x = result.x1; draw.y = result.y1; draw_Post(&draw); vccAwait(5.0); /* clear defending piece */ draw.bitmapno = 13; draw.x = result.x2; draw.y = result.y2; draw_Post(&draw); } else { draw.bitmapno = get_bitmapno(battlefield[result.x1][result.y1].occupied.name); draw.x = result.x2; draw.y = result.y2; draw_Post(&draw); vccAwait(5.0); draw.bitmapno = 13; draw.x = result.x1; draw.y = result.y1; draw_Post(&draw); perform_move(result.player , result.x1 , result.y1 , result.x2 , result.y2 , battlefield[result.x1][result.y1].occupied.revealed); turn = 1; /* other player played (no change if the observer since never gets inside */ } /* else */ } /* if result.player != 2 */ } /* else if player_no == 2 */ }/*if (move_in enabled) */ if (button_in_Enabled()){/* if move_enabled */ pressed = *button_in_Value(); vccPrintPdxDebugInfo("\nButton pressed\n"); if ((pressed.button_no == 1) && (player_no != 2)){ vccPrintPdxDebugInfo("\nStart button pressed"); if (pieces_placed()){ vccPrintPdxDebugInfo("\nStarting game\n"); out.text = "STARTING"; out.x = 0; out.y = -2; print_Post(&out); battle_started = TRUE; } else { vccPrintPdxDebugInfo("\nYou have to place all pieces before starting the game\n"); out.text = "PLACE@ALL"; out.x = 0; out.y = 6; print_Post(&out); } }else if ((pressed.button_no == 2) && (player_no != 2)){ vccPrintPdxDebugInfo("Quit button pressed\n...EXITING..."); out.text = "QUITING"; out.x = 0; out.y = 6; print_Post(&out); } else if (pressed.button_no == 0){ player_no = pressed.player; turn = 1; vccPrintPdxDebugInfo("\nPlayer is: %d\n",player_no); }

void poin_entry_Init (    )

Function called upon starting the simulation. This function is called directly when the simulation and VCC is started. In it, the start array and battlefield array are initialised by calling the initialise_start and initialise_battlefield functions. In addition, the variable battle_started is set to FALSE to indicate that we are at the initialisation phase of the game. Thi svariable is set to TRUE only when the user has placed all of his pieces on the board, and he pressses the "start" button. { initialise_start(); initialise_battlefield(); battle_started = FALSE; }

int strcmp (  const char *    s1, const char *    s2 )

Compare two strings. Function used to compare two strings. Declared in order to be used

int vccPrintPdxDebugInfo (  const char *    format, ...    )

Function used for debugging. This function is the equivalent of printf in VCC. Has been used throughout the program for debugging

---

Variable Documentation

int battle_started

Variable used to distinguish if the battle has began or not. If battle has started then we use different structures and perform different actions compared to those used during the initialisation. At the start of the game this variable is set to FALSE and it is only set to TRUE when the start button is pressed

int player_no

Variable used to identify the player to whom this specific module belongs to. This variable is set by a button signal that is sent by the Input module. This signal is unique and it is the first thing that is sent in the game. During the game the player_no variable is used to identify the source or destination of a message and act accordingly.

int turn

Variable used to detect if it is a player's turn or not This variable is set to 0 at the start and then to 1 when a player presses the start button. Every time a legal move or attack is made during the battle, it is set back to 0. If a player tries to make a move while it is 0, it is reported that it is not his turn

---