python outline.txt

+ python outline +

required functions
	registerUser() done
		peramiters
			- user_id
			- A_number
			- email
			- phone_number (optional)
			- discord_id (optional)
			- callsign (optional)
			- 2FA_key (optional)
		
		generates and runs a SQL Insert statment into players table.
	
	newGame() done
		peramiters
			- gameName
			- startTime
			- endTime
			- game_email_key
		
		generates and runs a SQL insert statment into the games table.
		
	registerUserInGame() done
		peramiters
			- user_id
			- code_id
			- game_id
		
		generates and runs a SQL insert statment into the codes, and player_game tables.
	
	getUserData() done
		peramiters
			- user_id
		
		returns a nested list (or dict) of the relivent data assoceated with the user.
	
	getPlayerData() done
		# ive made this an override of getUserData, just dont include a peramiter.
		returns a nested list (or dict) with all players data.
	
	messagePlayers()
		peramiters
			- list of user_ids
			- message
		
		sends a message to every player in the list via there prefered method of contact.
	
	getTags() done
		returns a list of tag info as strings with the most recent tag at index 0.
	
	get2FA() done
		peramiters
			- 2FA key
			- code
		
		returns wther or not the 2FA code is valid.
	
	new2FA() done
		returns a new 2FA_key.
	
	generateQRCode() done
		peramiters
			- url
			- filepath
	
	exicuteSelect() done
		peramiters
			- MySQL select statment
		
		returns a nested list table of results (the errorMsg if error).
	
	exicuteInsert() done
		peramiters
			- MySQL insert statment
		
		returns true for no error and the errorMsg if error.
	
	getCodeInfo()
		peramiters
			- code
		
		reuturns true if a game is active and the player is un-registered
		returns false if there are no active games
		returns a stirng if an error occured
		returns a list containing the player name and tag_code
	
	getPlayerName()
		peramiters
			- user_id
		
		returns the string f'{firstName} "{callsign}" {lastName}'