DOCUMENTATION

Class GameRoom

Uses:

To create and keep track of all the players on the room

Params

name	type	description
red	list[int]	array of ID's
blue	list[int]	array of ID's
spect	list[int]	array of ID's
max_players	list[int]	the max players in red or blue

Methods

constructor

Uses:

To create new objects of this type

Params

name	type	description
max_players	int	The number of players for the teams (red and blue)

Pre-conditions:

• $True$

Post-conditions

• $|res.red| = 0$
• $|res.blue| = 0$
• $|res.spect| = 0$
• $res.max\_players = max_players$

isGameMax

Uses:

Returns if both teams are full

Params

name	type	description
c	gameRoom	the Game Room

Pre-conditions:

• $True$

Post-conditions

• $res=True \iff (|this.red|=this.max\_player \land |this.blue|=this.max\_player)$

addPlayer

Uses:

Adds a player to the teams that needs a player. If both teams have the exact same number of players and they are less than the max_players, the player is added to red. If both the teams are full, the player is set to the spect's teams

Params

name	type	description
id	int	The player's ID.

Pre-conditions:

• $( \forall x: \mathbb{Z}) (0 \leq x < |c.red| \to_{L} c.red[x] \neq id)$
• $c = C_{0} (this)$

Post-conditions

• $( |c.red| = c.max\_players \land |c.blue| = this.max\_players ) \to \\ (c.red = C_{0}.red \land c.blue = C_{0}.blue \land c.spect = concat(C_{0}.spect, (id)) )$
• $(|c.red| == |c.blue| \land |c.red| < c.max\_players) \to \\ ( c.red = concat(C_{0}.red, (this.id)) \land c.blue = C_{0}.blue \land c.spect = C_{0}.spect )$
• $(|c.red| > |c.blue| \land |c.red| \leq c.max\_players) \to \\ (c.red = C_{0}.red \land c.blue = concat(C_{0}.blue, (id)) \land c.spect = C_{0}.spect)$
• $(|c.red| < |c.blue| \land |c.blue| \leq c.max\_players) \to \\ (c.red = concat(C_{0}.red, (id))) \land c.blue = C_{0}.blue \land c.spect = C_{0}.spect$

#addPlayerRed/Blue/Spect

Uses:

Deletes the player from all the teams and set it to the selected (red, blue or spect)

Params

name	type	description
c	gameRoom	the Game Room
id	int	The player's id to set to the given team

Pre-conditions:

• $c = C_{0}$

Post-conditions

• $c.red = concat(C_{0}.red, (id)) \text{Red/blue/spect. Depends on the method that was called}$
• $c.blue = C_{0}.blue$
• $c.spect = C_{0}.spect$

deletePlayer

Uses:

Deletes the player from all the teams. It don't affect the orders in the arrays. All the elements after this are set with an index befero they were originally placed

Params

name	type	description
id	int	The player's ID

Pre-conditions:

• $c = C_{0}$

Post-conditions

• $(\exists! x: \mathbb{Z}) (0 \leq x < |C_{0}.red| \land_{L} C_{0}[x] = id \land \\ c.red = concat(subseq(C_{0}.red, 0, x), subseq(C_{0}.red, x + 1, |C_{0}.red|))) \\ \lor c.red = C_{0}.red \\ \text{I asume that it will not be undefined the x + 1}$
• $(\exists! x: \mathbb{Z}) (0 \leq x < |C_{0}.blue| \land_{L} C_{0}[x] = id \land \\ c.blue = concat(subseq(C_{0}.blue, 0, x), subseq(C_{0}.blue, x + 1, |C_{0}.blue|))) \\ \lor c.blue = C_{0}.blue \\ \text{I asume that it will not be undefined the x + 1}$
• $(\exists! x: \mathbb{Z}) (0 \leq x < |C_{0}.spect| \land_{L} C_{0}[x] = id \land \\ c.spect = concat(subseq(C_{0}.spect, 0, x), subseq(C_{0}.spect, x + 1, |C_{0}.spect|))) \\ \lor c.spect = C_{0}.spect \\ \text{I asume that it will not be undefined the x + 1}$

#searchID_red/blue/spect

Uses:

Gets the index in the given team. If no player has this id, it returns -1

Params

name	type	description
c	gameRoom	the Game Room
id	int	The player's id

Pre-conditions:

• $True$

Post-conditions

• $(\exists i : \mathbb{Z}) (0 \leq i < |c.red| \land_{L} c.red[i] = id\land red = i) \lor \\ \neg (\exists i : \mathbb{Z})(0 \leq i < |c.red| \land_{L} c.red) = id \land res = -1$

movePlayer

Uses:

Moves the player to the team passed

Params

name	type	description
c	gameRoom	the Game Room
id	int	The player's ID
team	id	The player's team

Pre-conditions:

• $0 \leq team \leq 2$

Post-conditions

• $team = 0 \to c.red = C_{0}.red \land c.blue = C_{0}.blue \land c.spect = concat(C_{0}.spect, (id))$
• $team = 1 \to c.red = concat(C_{0}.red, (id)) \land c.blue = C_{0}.blue \land c.spect = C_{0}.spect$
• $team = 2 \to c.red = C_{0}.red \land c.blue = concat(C_{0}.blue, (id)) \land c.spect = C_{0}.spect$

movePlayerIfNeeded

Uses:

Params

name	type	description
c	gameRoom	the Game Room

Pre-conditions:

Post-conditions

#existID

Uses:

Params

name	type	description
c	gameRoom	the Game Room
id	int	The player's id

Pre-conditions:

• $True$

Post-conditions

• $res = True \iff \\ (\exists i : \mathbb{Z}) (0 \leq i < |c.red| \land_{L} c.red[i] = id) \\ (\exists i : \mathbb{Z}) (0 \leq i < |c.blue| \land_{L} c.blue[i] = id) \\ (\exists i : \mathbb{Z}) (0 \leq i < |c.spect| \land_{L} c.spect[i] = id)$

Class Player

Uses:

To create and keep track of all the players on the room

Params

name	type	description
res	list[int]	array of ID's
blue	list[int]	array of ID's
spect	list[int]	array of ID's
max_players	list[int]	the max players in red or blue

Methods

constructor

Uses:

Creates the player object with the given parameters and afk set to false

Params

name	type	description
id	int	The player's ID
auth	string	The player's auth
name	string	The player's name
authorization	int	The level of authorization to make some commands

Pre-conditions:

• $True$

Post-conditions

• $res.id = id \land \\res.auth = auth \land \\ res.name = name \land \\res.authorization = authorization \land \\res.afk = false$

invertAFK

Uses:

Set the afk state to the negative of the afk parameter

Params

name	type	description
Pla	Player	The player object

Pre-conditions:

• $True$

Post-conditions

• $Pla.id = Pla_{0}.id$
• $Pla.auth = Pla_{0}.auth$
• $Pla.name = Pla_{0}.name$
• $Pla.authorization = Pla_{0}.authorization$
• $Pla.afk = \neg Pla_{0}.afk$

set authorization

Uses:

Sets the authorization of the player to a given authorization

Params

name	type	description
Pla	Player	The player object
authorization	int	The player's authorization

Pre-conditions:

• $0 \leq authorization \leq 3$

Post-conditions

• $Pla.id = Pla_{0}.id$
• $Pla.auth = Pla_{0}.auth$
• $Pla.name = Pla_{0}.name$
• $Pla.authorization = authorization$

Class List_of_players

Uses:

To create and keep track of all the players on the room

Params

name	type	description
list	array()	A list of the players

Methods

constructor

Uses:

Creates the object List_of_players

Params

It doesn't take any parameter

Pre-conditions:

• $True$

Post-conditions

• $res.list = \{\}$

addPlayer

Uses:

Adds a player to the list

Params

name	type	description
list	List_of_players	The list of players' object
player	Player	Player to add to the list

Pre-conditions:

Post-conditions

#getPlayer

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

getPlayerByID

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

#searchID

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

#removePlayer

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

#removePlayerByID

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

Class PlayerStats

Uses:

To create and keep track of all the players on the room

Params

name	type	description
res	list[int]	array of ID's
blue	list[int]	array of ID's
spect	list[int]	array of ID's
max_players	list[int]	the max players in red or blue

Methods

constructor

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

storePlayer

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

incrementGoal

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

incrementGames

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

incrementLoses

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

incrementWonMatches

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

incrementAssists

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

incrementAgainstGoals

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

incrementMVP

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

Class statsTeams

Uses:

To create and keep track of all the players on the room

Params

name	type	description
res	list[int]	array of ID's
blue	list[int]	array of ID's
spect	list[int]	array of ID's
max_players	list[int]	the max players in red or blue

Methods

constructor

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

setFalseIsGameMax

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

storeData

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

addMatch

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

addVictoryTo

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

addDefeatTo

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

addGoalTo

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

addAsisTo

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

Class LocalStorage

Uses:

To create and keep track of all the players on the room

Params

name	type	description
res	list[int]	array of ID's
blue	list[int]	array of ID's
spect	list[int]	array of ID's
max_players	list[int]	the max players in red or blue

Methods

existsData

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

storeData

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

getData

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

getAllLocalStorage

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

importLocalStorage

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

Class colaConLimit

Uses:

To create and keep track of all the players on the room

Params

name	type	description
res	list[int]	array of ID's
blue	list[int]	array of ID's
spect	list[int]	array of ID's
max_players	list[int]	the max players in red or blue

Methods

constructor

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

length

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

isEmpty

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

addElement

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

Functions

Function setTeam

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

Function isCommand

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

Function makeCommand

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

Function showMessage

Uses:

Params

name	type	description

Pre-conditions:

Post-conditions

class GameRoom

Params

name	type	description
red	int	array of ID's
blue	int	array of ID's
spect	int	array of ID's
max_players	int	the max players in red or blue

Methods

Uses This object is for keep a track of the players in all the room and to move them from one team to another

• constructor

  • params:
    • max_players : int The number of players for the teams (red and blue)
  • pre-condition:
    • True
  • post-condition:
    • |res.red| = 0
    • |res.blue| = 0
    • |res.spect| = 0
    • res.max_players = max_players

• getters

• isGameMax

• addPlayer

• addPlayerRed

• addPlayerBlue

• addPlayerSpect

• deletePlayer

• searchID_red

• searchID_blue

• searchID_spect

• movePlayer

• movePlayerIfNeeded

• existID