Descrevendo metodos e valores de Ball.h

Classes/GameScene/Ball.cpp

@@ -1,7 +1,11 @@
-//
-//  Ball.cpp
-//  RedCore
-//
+/********************************************************************
+ *  Nomes: Gabriel Capella                       Números USP: 8962078 
+ *         João Herique Luciano                               8535957
+ * 
+ *  Tarefa:    RedCore - EP2 MAC0463
+ *  Arquivo:   Ball.cpp
+ *  Descrição: Classe para auxiliar na criação da bola no jogo.
+ ********************************************************************/ 
 
 #include "Ball.h"
 #include "params.h"
@@ -21,7 +25,7 @@ bool Ball::init() {
     auto material = PHYSICSBODY_MATERIAL_DEFAULT;
     material.density = 0.0f;
     material.restitution = 1.005f;
-    material.friction = 0.0f; //set friction here
+    material.friction = 0.0f;
     
     auto physicsBody = PhysicsBody::createCircle(BALL_SIZE, material);
     physicsBody->setGravityEnable(false);

Classes/GameScene/Ball.h

@@ -1,7 +1,11 @@
-//
-//  Ball.h
-//  RedCore
-//
+/********************************************************************
+ *  Nomes: Gabriel Capella                       Números USP: 8962078 
+ *         João Herique Luciano                               8535957
+ * 
+ *  Tarefa:    RedCore - EP2 MAC0463
+ *  Arquivo:   Ball.h
+ *  Descrição: Classe para auxiliar na criação da bola no jogo.
+ ********************************************************************/
 
 #ifndef Ball_h
 #define Ball_h
@@ -10,15 +14,57 @@
 
 class Ball : public cocos2d::Node {
     public:
+        /**
+         * Inicia elementos qunado a bola é criada.
+         * @return se foi possível criar a bola ou não.
+         */
         virtual bool init();
+
+        /**
+         * Reescreve a função de posicionar o node.
+         * A bola somente colide após esse método ser chamado.
+         * 
+         * @param x posição da bola no eixo x
+         * @param y posição da bola no eixo y
+         */
         virtual void setPosition(float x, float y);
+
+        /**
+         * Lança a bola.
+         */
         void throwBall();
+
+        /**
+         * É um macro do cocos2d-x que define a função create do
+         * do classe.
+         * 
+         * @param Classe para qual vai criar.
+         */
         CREATE_FUNC(Ball);
+
+        /**
+         * Marca se é uma superbola ou não.
+         */
         bool superball;
+
+        /**
+         * Transforma em uma super bola.
+         */
         void setSuperball();
+
+        /**
+         * Transforma a bola em uma bola normar, sem poderes.
+         */
         void resetNormalball();
     private:
+        /**
+         * Desenho (imagem) da bola normal.
+         */
         cocos2d::DrawNode* ball_draw;
+
+        /**
+         * Desenho (imagem) da superbola.
+         */
         cocos2d::DrawNode* superball_draw;
 };
 

README.md

@@ -8,4 +8,11 @@ Para montar o APK do jogo:
 ./build
 ```
 
+# Manual
+
+## Power UPs
+### SuperBola
+ë o power up laranja o responsável por esse efeito. Qunado o usuário possui uma superbola, a bola fica laranja e tem capacidade de destruir os blocos indestritíveis (somente um toque).
+
+
 Esse script vai fazer o download do cocos2d-x (por volta de 350mb).