Stats4 - Documentation

Source:

Version:

Author:

Stats4 is a module to load and save game stats and Elo ratings for Connect 4 games.

Source:

Name	Type	Description
`players`	Array.<string>	A list of player names to return stats for.

The statistics of the requested players as object with keys given in players.

Source:

Record the result of a game and return updated statistcs.

Name	Type	Description
`player_1`	string	The name of player 1 (who plies first)
`player_2`	string	The name of player 2
`result`	0 \| 1 \| 2	The number of the player who won, or `0` for a draw.

Returns statistics for player_1 and player_2, i.e. the result of Stats4.get_statistics([player_1, player_2])

Source:

Name	Type	Description
`elo`	number	The Elo score of the player. https://en.wikipedia.org/wiki/Elo_rating_system
`player_1_wins`	number	How many times the player has won when playing first.
`player_1_losses`	number	How many times the player has lost when playing first.
`player_1_draws`	number	How many times the player has tied when playing first.
`player_2_wins`	number	How many times the player has won when playing second.
`player_2_losses`	number	How many times the player has lost when playing second.
`player_2_draws`	number	How many times the player has tied when playing second.
`current_streak`	number	The number of games the player has won since last losing (or ever if the player has never lost).
`longest_streak`	number	The most consecutive games won.