options.md

This is the documentation for all options.

Table of Contents

• PlayerOptions
• PlayerManagerOptions
• GameOptions
• BigTwoOptions
• BullsAndCowsOptions
• FinalCodeOptions
• FlipTripOptions
• GomokuOptions
• LightsUpOptions
• TicTacToeOptions
• TofeOptions
• DjsGameWrapperOptions
• DjsBigTwoOptions
• DjsBullsAndCowsOptions
• DjsFinalCodeOptions
• DjsFlipTripOptions
• DjsGomokuOptions
• DjsLightsUpOptions
• DjsTicTacToeOptions
• DjsTofeOptions

PlayerOptions

parameter	type	default	description
bot	boolean	false	Whether the player is a bot
id	number | string	required	The id of the player
symbol	string | null	null	The symbol of the player
username	string	"Player"	The username of the player

PlayerManagerOptions

parameter	type	default	description
firstPlayerIndex	number	1	The index of the first player
players	PlayerOptions[]	required	All players' data
playerCountRange	Range	new Range(1, Infinity)	To restrict the number of players
requireSymbol	boolean	false	Whether all players need their own symbols

GameOptions

parameter	type	default	description
gameStatus	string[]	[]	The possible game statuses
playerManagerOptions	PlayerManagerOptions	required	The options for the player manager

StatusManagerOptions

parameter	type	default	description
initial	string	status[0]	The initial status
status	string[]	[]	The possible game statuses

BigTwoOptions

parameter	type	default	description
players	PlayerOptions[]	required	All players' data

BullsAndCowsOptions

parameter	type	default	description
answerLength	number	4	The length of the answer
players	PlayerOptions[]	required	All players' data

FinalCodeOptions

parameter	type	default	description
players	PlayerOptions[]	required	All players' data
range	Range	new Range(1, 1000)	The range of the answer

FlipTripOptions

parameter	type	default	description
boardSize	number	3	The number of the pieces
players	PlayerOptions[]	required	All players' data

GomokuOptions

parameter	type	default	description
boardSize	number	19	The dimensions of the board
players	PlayerOptions[]	required	All players' data

LightsUpOptions

parameter	type	default	description
boardSize	number	5	The dimensions of the board
players	PlayerOptions[]	required	All players' data

TicTacToeOptions

parameter	type	default	description
boardSize	number	3	The dimensions of the board
players	PlayerOptions[]	required	All players' data

TofeOptions

parameter	type	default	description
hardMode	boolean	false	Whether to enable hard mode
players	PlayerOptions[]	required	All players' data

DjsGameWrapperOptions

parameter	type	default	description
source	CommandInteraction | Message	required	The source to instantiate the game
time	number	60e3	How long to consider a player idle

DjsBigTwoOptions

extends DjsGameWrapperOptions, BigTwoOptions

parameter	type	default	description
strings	BigTwoStrings	strings.json#bigTwo	The display strings

DjsBullsAndCowsOptions

extends DjsGameWrapperOptions, BullsAndCowsOptions

parameter	type	default	description
hardmode	boolean	none	Whether to enable hard mode
strings	BullsAndCowsStrings	strings.json#bullsAndCows	The display strings

DjsFinalCodeOptions

extends DjsGameWrapperOptions, FinalCodeOptions

parameter	type	default	description
strings	FinalCodeStrings	strings.json#finalCode	The display strings

DjsFlipTripOptions

extends DjsGameWrapperOptions, FlipTripOptions

parameter	type	default	description
strings	FlipTripStrings	strings.json#flipTrip	The display strings

DjsGomokuOptions

extends DjsGameWrapperOptions, GomokuOptions

parameter	type	default	description
strings	GomokuStrings	strings.json#gomoku	The display strings

DjsLightsUpOptions

extends DjsGameWrapperOptions, LightsUpOptions

parameter	type	default	description
strings	LightsUpStrings	strings.json#lightsUp	The display strings

DjsTicTacToeOptions

extends DjsGameWrapperOptions, TicTacToeOptions

parameter	type	default	description
strings	TicTacToeStrings	strings.json#ticTacToe	The display strings

DjsTofeOptions

extends DjsGameWrapperOptions, TofeOptions

parameter	type	default	description
strings	TofeStrings	strings.json#tofe	The display strings