-Added documentation

-Fixed scorecounter
-Changed color of "Game Over"

SnakePlusPlus/SnakePlusPlus/Field.cpp

@@ -15,9 +15,10 @@ Field::Field()
 	m_scoreText.setPosition(5, 5);
 	m_scoreText.setColor(sf::Color::Black);
 
-	for (int y = 0; y < 33; y++)
+	// Generate every tile on the field
+	for (int y = 0; y < TPC; y++)
 	{
-		for (int x = 0; x < 33; x++)
+		for (int x = 0; x < TPR; x++)
 		{
 			// Magic numbers and hardcoding is completely acceptable
 			// Kill me please
@@ -28,7 +29,8 @@ Field::Field()
 			m_field.insert(std::pair<Vector2D, Tile>(Vector2D(x, y), t));
 		}
 	}
-
+	
+	// choose a random field and color it red, so it is a fruit field
 	range = std::uniform_int_distribution<int>(0, 32);
 	engine.seed(time(NULL));
 	m_field.find(Vector2D(range(engine), range(engine)))->second.setFillColor(sf::Color::Red);
@@ -41,12 +43,17 @@ Field::~Field()
 
 bool Field::IsOnFruit(Vector2D pos)
 {
+	// if the field at the given position is red, the position is a fruit
 	if (m_field.find(pos)->second.getFillColor() == sf::Color::Red)
 	{
+		// the snake is now on the fruit, so delete the fruit by coloring the tile white
 		m_field.find(pos)->second.setFillColor(sf::Color::White);
+		// choose another field and make it the fruit
 		m_field.find(Vector2D(range(engine), range(engine)))->second.setFillColor(sf::Color::Red);
 
+		//update score
 		m_score++;
+		m_scoreText.setString(std::to_string(m_score));
 		return true;
 	}
 
@@ -55,8 +62,10 @@ bool Field::IsOnFruit(Vector2D pos)
 
 void Field::Render(sf::RenderWindow& window)
 {
+	// render field
 	for (auto it : m_field)
 		window.draw(it.second);
 
+	// render score
 	window.draw(m_scoreText);
 }

SnakePlusPlus/SnakePlusPlus/Field.h

@@ -15,13 +15,25 @@ public:
 	Field();
 	~Field();
 
+	/**
+		Renders the playfield to the screen
+
+		@param window a reference to the window object
+	*/
 	void Render(sf::RenderWindow& window);
+
+	/**
+		Checks wether the given position is a fruit or not and updates the field accordingly
+
+		@param pos The position to be checked
+		@returns wether there is a fruit or not
+	*/
 	bool IsOnFruit(Vector2D pos);
 
 private:
-	std::map<Vector2D, Tile> m_field;
-	Vector2D fruitField;
+	std::map<Vector2D, Tile> m_field;	// A map containing every tile
 
+	// RNG
 	std::default_random_engine engine;
 	std::uniform_int_distribution<int> range;
 

SnakePlusPlus/SnakePlusPlus/Framework.cpp

@@ -2,54 +2,65 @@
 #include <iostream>
 
 sf::RenderWindow*	Framework::window = nullptr; //Set Window object to nullptr. If window is nullptr, the framework was not initialized.
-sf::Event			Framework::e = sf::Event();
+sf::Event			Framework::e = sf::Event();		
 sf::Font			Framework::m_font = sf::Font();
 sf::Text			Framework::m_gameOverText = sf::Text();
 
 Field				Framework::m_field = Field();
 Snake				Framework::m_snake = Snake();
 
-bool				Framework::m_gameOver = false;
+bool				Framework::m_gameOver = false;	// When the game starts, the game is not over
 
 
 Framework::~Framework()
 {
+	// delete widnow and release memory
 	delete window;
 	window = nullptr;
 }
 
 ErrorType Framework::Initialize(unsigned int width, unsigned int height, std::string title, sf::Uint8 flags)
 {
+	// If the window is already initialized, then don't initialize it again
 	if (window != nullptr)
 	{
 		std::cout << "WARNING: Framework has already been initialized." << std::endl;
 		return WARNING;
 	}
 
+	// Set window properties
 	window = new sf::RenderWindow(sf::VideoMode(width, height), title, flags);
 
+	//Load Font and create GameOver text
 	m_font.loadFromFile("font.ttf");
 	m_gameOverText.setFont(m_font);
 	m_gameOverText.setString("Game\nOver");
 	m_gameOverText.setCharacterSize(140);
 	m_gameOverText.setPosition(100, 200);
-	m_gameOverText.setColor(sf::Color::Black);
+	m_gameOverText.setColor(sf::Color(0, 0, 110));
+
 	return NONE;
 }
 
 ErrorType Framework::Run()
 {
+	// If widnow was not initialized, return error
 	if (window == nullptr)
 	{
 		std::cout << "ERROR: Framework cannot run before being initialized" << std::endl;
 		return ERROR;
 	}
 
+	//Program loop!
 	while (window->isOpen())
 	{
 		if (Handle() == ERROR) return ERROR;
+
+		// Only update when the game is not over
+		// It keeps the snake from moving
 		if(!m_gameOver)
 			if (Update() == ERROR) return ERROR;
+
 		if (Render() == ERROR) return ERROR;
 	}
 
@@ -62,10 +73,13 @@ ErrorType Framework::Handle()
 	{
 		switch (e.type)
 		{
+			// When window gets closed
 		case sf::Event::Closed:
 			window->close();
 			break;
 
+			//  When a key gets pressed
+			// Only used to update the snakes direction
 		case sf::Event::KeyPressed:
 			{
 			if (sf::Keyboard::isKeyPressed(sf::Keyboard::W))
@@ -88,6 +102,8 @@ ErrorType Framework::Handle()
 
 ErrorType Framework::Update()
 {
+	// If the snake's update returns false, it crashed
+	// The game is over
 	if (!m_snake.Update(m_field))
 		m_gameOver = true;
 
@@ -96,14 +112,19 @@ ErrorType Framework::Update()
 
 ErrorType Framework::Render()
 {
+	// Clear screen
 	window->clear(sf::Color::Black);
 
+	// Render the field and the snake
 	m_field.Render(*window);
 	m_snake.Render(*window);
-
+	
+	// If the game is over, display the Game Over Text
 	if (m_gameOver)
 		window->draw(m_gameOverText);
 
+	// Display everything to the screen
 	window->display();
+
 	return NONE;
 }

SnakePlusPlus/SnakePlusPlus/Framework.h

@@ -4,33 +4,69 @@
 #include "Field.h"
 #include "Snake.h"
 
+// ErrorType, used to differentiate different Problems in the Program
 enum ErrorType {
 	NONE,
 	WARNING,
 	ERROR
 };
 
+//Framework: Contains GameLoop, Rendering Routines etc
+
 class Framework
 {
 public:
 	virtual ~Framework();
 
+	/**
+		Initializes the Framework
+
+		@param width The width of the window
+		@param height The height of the window
+		@param title The title of the window
+		@param flags The style of the window
+		@return ErrorType
+	*/
 	static ErrorType Initialize(unsigned int width, unsigned int height, std::string title, sf::Uint8 flags = sf::Style::Default);
+
+	/**
+		Contains the GameLoop
+
+		@return ErrorType
+	*/
 	static ErrorType Run();
 
 private:
+	/**
+		Handles different Events, e.g. closing the Window or KeyStrokes
+
+		@return ErrorType
+	*/
 	static ErrorType Handle();
+
+	/**
+		Updates the different parts of the program
+
+		@return ErrorType
+	*/
 	static ErrorType Update();
+
+	/**
+		Renders all parts of the program that
+
+		@return ErrorType
+	*/
 	static ErrorType Render();
 
-	static sf::RenderWindow* window;
-	static sf::Event e;
+	
+	static sf::RenderWindow* window;	//	The window object
+	static sf::Event e;					//	An event holder, which saves current events
 
-	static Field m_field;
-	static Snake m_snake;
+	static Field m_field;				// The gamefield (The Field is a grid of white tiles)
+	static Snake m_snake;				// The snake (a collection of black tiles)
 
-	static sf::Font m_font;
-	static sf::Text m_gameOverText;
+	static sf::Font m_font;				// Font Holder
+	static sf::Text m_gameOverText;		// GameOver Text
 
 	static bool m_gameOver;
 };

SnakePlusPlus/SnakePlusPlus/Snake.cpp

@@ -4,13 +4,14 @@
 
 Snake::Snake()
 {
+	//Create three initial Snake Pieces in the same spot
 	for (int i = 0; i < 3; i++)
 	{
 		m_snake.push_back(SnakePiece(Vector2D(16, 16)));
 	}
 
-	m_direction = Vector2D(1, 0);
-	m_clock.restart();
+	m_direction = Vector2D(1, 0);	// Standard direction is right
+	m_clock.restart();				// Restart the Snake's clock
 }
 
 
@@ -20,13 +21,17 @@ Snake::~Snake()
 
 bool Snake::Update(Field& field)
 {
+	// The snake gets updated every second
 	if (m_clock.getElapsedTime().asMilliseconds() >= 250)
 	{
+		//remove the last tile in the vector, which thereby is the last piece of the snake
 		m_snake.pop_back();
 
+		// Create a new snake piece in front of the frontmost piece and insert it at the beginning of the vector
 		Vector2D v = m_snake.begin()->position + m_direction;
 		m_snake.insert(m_snake.begin(), v);
 
+		// If the snake's 'head' is out of bounds, it crashed -> Game Over
 		if (m_snake.begin()->position.x > 32 ||
 			m_snake.begin()->position.x < 0 ||
 			m_snake.begin()->position.y > 32 ||
@@ -35,22 +40,26 @@ bool Snake::Update(Field& field)
 			return false;
 		}
 
+		// If the snake crashes into itself -> Game over
 		auto it = m_snake.begin();
 		it++;
 
 		while (it != m_snake.end())
 		{
+			// if the snakes head's position equals another part's position, it crashed into itself
 			if (m_snake.begin()->position == it->position)
 				return false;
 			it++;
 		}
 
+		// Checks wether the snake ate a fruit or not
 		if (field.IsOnFruit(m_snake.begin()->position))
 		{
-			std::cout << "Score!" << std::endl;
+			// if yes, create a new tile on top of the last tile
 			m_snake.insert(m_snake.end(), m_snake.back());
 		}
 
+		// restart the clock
 		m_clock.restart();
 	}
 
@@ -59,6 +68,7 @@ bool Snake::Update(Field& field)
 
 void Snake::Render(sf::RenderWindow& window)
 {
+	// render the snake
 	for (auto it : m_snake)
 	{
 		window.draw(it.tile);

SnakePlusPlus/SnakePlusPlus/Snake.h

@@ -14,8 +14,26 @@ public:
 	Snake();
 	virtual ~Snake();
 
+	/**
+		Renders all Tiles of the snake
+
+		@param window Adress of the window object
+	*/
 	void Render(sf::RenderWindow& window);
+
+	/**
+		Updates the snake by moving every tile to it's new position
+
+		@param field an adress to the field object
+		@return Returns false when the Snake crashes into the wall or itself
+	*/
 	bool Update(Field& field);
+
+	/**
+		Sets the new direction the snake is going
+
+		@param dir the new direction
+	*/
 	void setDirection(Vector2D dir) { m_direction = dir; }
 
 private:

SnakePlusPlus/SnakePlusPlus/main.cpp

@@ -3,9 +3,8 @@
 
 int CALLBACK WinMain(HINSTANCE hInstance, HINSTANCE hPrevInstance, LPSTR lpCmdLine, int nShowCmd)
 {
-
-	Framework::Initialize(WIDTH, HEIGHT, "SnakePlusPlus v1.0", sf::Style::Close);
-	Framework::Run();
+	Framework::Initialize(WIDTH, HEIGHT, "SnakePlusPlus v1.1", sf::Style::Close);	// Initialize Framework
+	Framework::Run();	// Enter program loop
 
 	return 0;
 }

SnakePlusPlus/SnakePlusPlus/util.h

@@ -2,6 +2,7 @@
 
 #include <SFML/Graphics.hpp>
 
+// constants used by different classes
 #define WIDTH 825
 #define HEIGHT 825
 #define TILESIZE 25
@@ -21,6 +22,8 @@ struct Vector2D {
 
 	friend bool operator<(const Vector2D& lhs, const Vector2D& rhs)
 	{
+		// if you would read the tiles like a book (line by line, from left to right) then 
+		// the tiles you see first are "smaller" than the ones after it
 		if (lhs.y < rhs.y)
 			return true;
 		else if (lhs.y > rhs.y)
@@ -63,13 +66,14 @@ struct Vector2D {
 
 struct SnakePiece
 {
+	// A container for position and tile because maps fucking suck apparently
+
 	SnakePiece(Vector2D position)
 	{
 		this->position = Vector2D(position.x, position.y);
 
 		tile.setSize(sf::Vector2f(TILESIZE, TILESIZE));
-		tile.setPosition(TILESIZE * position.x, TILESIZE * position.y); // "I will redo this properly without magic numbers"
-																		// i did it!
+		tile.setPosition(TILESIZE * position.x, TILESIZE * position.y); // "I will redo this properly without magic numbers" (i did it!)
 		tile.setFillColor(sf::Color::Black);
 	}