diff --git a/core/src/com/usp/corrida/Core.java b/core/src/com/usp/corrida/Core.java
index 7a24a7c..75941d5 100644
--- a/core/src/com/usp/corrida/Core.java
+++ b/core/src/com/usp/corrida/Core.java
@@ -42,7 +42,7 @@ public class Core extends com.badlogic.gdx.Game {
Boolean showFPS = false;
/**
- * Faz as primeiras configurações do programa.
+ * Faz as primeiras configurações do programa
*/
@Override
public void create () {
@@ -71,7 +71,7 @@ public void create () {
}
/**
- * Cuida de toda a renderização do jogo.
+ * Cuida de toda a renderização do jogo
*/
@Override
public void render () {
@@ -95,7 +95,7 @@ public void render () {
}
/**
- * Descarrega todos os recursos.
+ * Descarrega todos os recursos
*/
@Override
public void dispose () {
diff --git a/core/src/com/usp/corrida/logic/Character.java b/core/src/com/usp/corrida/logic/Character.java
index 0d2c852..4cd358c 100644
--- a/core/src/com/usp/corrida/logic/Character.java
+++ b/core/src/com/usp/corrida/logic/Character.java
@@ -6,6 +6,9 @@
import javax.swing.text.StyledEditorKit;
+/**
+ * Classe responsável pela renderização dos personagens
+ */
public class Character {
// Configuration constants
@@ -26,29 +29,49 @@ public class Character {
// Texture
Texture texSprite;
- public Character(Core core, String spritePath){
+ /**
+ * @param core Instancia do core do jogo
+ * @param spriteID Identificador do sprite
+ */
+ public Character(Core core, int spriteID){
this.core = core;
- texSprite = new Texture(Gdx.files.internal(spritePath));
+ texSprite = new Texture(Gdx.files.internal("sprites/" + spriteID + ".png"));
}
+ /**
+ * Define a posição coordenada do personagem na tela
+ */
public void setPos(float x, float y){
posX = x;
posY = y;
}
+ /**
+ * Define o flip horizontal do sprite
+ */
public void setHorizontalFlip(Boolean flip){
horizontalFlip = flip;
}
+ /**
+ * @return Posição X
+ */
public float getX(){
return posX;
}
+ /**
+ * @return Posição Y
+ */
public float getY(){
return posY;
}
+ /**
+ * Essa função é chamada antes da função render. É utilizada para atualizar os frames de movimento
+ * @param delta Variação de tempo entre a chamada atual e a última chamada
+ */
public void update(float delta){
if (isMoving){
if (System.currentTimeMillis() > tickFrame){
@@ -60,12 +83,19 @@ public void update(float delta){
else frame = 0;
}
+ /**
+ * Renderiza o sprite do personagem
+ * @param delta Variação de tempo entre a chamada atual e a última chamada
+ */
public void render(float delta){
update(delta);
core.batch.draw(texSprite, posX, posY, 32, 32, frame*32, 0, 32, 32, horizontalFlip, false);
}
+ /**
+ * Descarrega todos os recursos
+ */
public void dispose(){
texSprite.dispose();
}
diff --git a/core/src/com/usp/corrida/logic/Game.java b/core/src/com/usp/corrida/logic/Game.java
index 7caed2e..6417b2d 100644
--- a/core/src/com/usp/corrida/logic/Game.java
+++ b/core/src/com/usp/corrida/logic/Game.java
@@ -6,6 +6,9 @@
import com.usp.corrida.Core;
import com.usp.corrida.utils.Utils;
+/**
+ * Classe responsável pela renderização do cenário
+ */
public class Game {
// Core instance
@@ -31,8 +34,11 @@ public class Game {
float[] cloudPositionY = new float[MAXCLOUDS];
// Character
- com.usp.corrida.logic.Character charMain;
+ Character charMain;
+ /**
+ * @param core Instancia do core do jogo
+ */
public Game(Core core){
this.core = core;
@@ -54,11 +60,16 @@ public Game(Core core){
cloudPositionY[i] = core.rand.getIntRand(100,(int)core.height-64);
}
- charMain = new Character(core, "sprites/1.png");
+ charMain = new Character(core, 1);
charMain.setPos(32, 32);
charMain.isMoving = true;
}
+ /**
+ * Renderiza todo o cenário do jogo
+ * @param delta Variação de tempo entre a chamada atual e a última chamada
+ * @param x Deslocamento da coordenada x do cenário
+ */
public void render(float delta, float x){
// Drawing top effect
@@ -99,6 +110,9 @@ public void render(float delta, float x){
charMain.render(delta);
}
+ /**
+ * Descarrega todos os recursos
+ */
public void dispose(){
texBackground.dispose();
texTerrain.dispose();
diff --git a/core/src/com/usp/corrida/screens/GameScreen.java b/core/src/com/usp/corrida/screens/GameScreen.java
index 8e9cf8d..3c36e7d 100644
--- a/core/src/com/usp/corrida/screens/GameScreen.java
+++ b/core/src/com/usp/corrida/screens/GameScreen.java
@@ -5,6 +5,9 @@
import com.badlogic.gdx.ScreenAdapter;
import com.usp.corrida.Core;
+/**
+ * Classe destinada à renderização da tela de jogo
+ */
public class GameScreen extends ScreenAdapter {
// Core instance
@@ -12,14 +15,16 @@ public class GameScreen extends ScreenAdapter {
float x = 0;
+ /**
+ * @param core Instancia do core do jogo
+ */
public GameScreen(Core core){
this.core = core;
}
- @Override
- public void dispose(){
- }
-
+ /**
+ * Essa função é chamada quando a tela acaba de ser exibida
+ */
@Override
public void show(){
// Input Processor
@@ -31,18 +36,29 @@ public boolean touchDown (int x, int y, int pointer, int button) {
});
}
+ /**
+ * Essa função é chamada quando a tela acaba de ser escondida
+ */
@Override
public void hide(){
Gdx.input.setInputProcessor(null);
}
- public void loop(float delta){
+ /**
+ * Essa função é chamada antes da função render. É utilizada para atualizar tudo antes da renderização
+ * @param delta Variação de tempo entre a chamada atual e a última chamada
+ */
+ public void update(float delta){
}
+ /**
+ * Renderiza a tela de jogo
+ * @param delta Variação de tempo entre a chamada atual e a última chamada
+ */
@Override
public void render (float delta) {
- loop(delta);
+ update(delta);
x += delta*30;
@@ -51,4 +67,11 @@ public void render (float delta) {
core.font.draw(core.batch, "PONTOS: 0", 10, core.height-11);
}
+
+ /**
+ * Descarrega todos os recursos
+ */
+ @Override
+ public void dispose(){
+ }
}
diff --git a/core/src/com/usp/corrida/screens/TitleScreen.java b/core/src/com/usp/corrida/screens/TitleScreen.java
index 4a16324..2d5db48 100644
--- a/core/src/com/usp/corrida/screens/TitleScreen.java
+++ b/core/src/com/usp/corrida/screens/TitleScreen.java
@@ -6,19 +6,24 @@
import com.usp.corrida.Core;
import com.usp.corrida.screens.GameScreen;
+/**
+ * Classe destinada à renderização da tela de título
+ */
public class TitleScreen extends ScreenAdapter {
// Core instance
Core core;
+ /**
+ * @param core Instancia do core do jogo
+ */
public TitleScreen(Core core){
this.core = core;
}
- @Override
- public void dispose(){
- }
-
+ /**
+ * Essa função é chamada quando a tela acaba de ser exibida
+ */
@Override
public void show(){
// Input Processor
@@ -31,18 +36,29 @@ public boolean touchDown (int x, int y, int pointer, int button) {
});
}
+ /**
+ * Essa função é chamada quando a tela acaba de ser escondida
+ */
@Override
public void hide(){
Gdx.input.setInputProcessor(null);
}
- public void loop(float delta){
+ /**
+ * Essa função é chamada antes da função render. É utilizada para atualizar tudo antes da renderização
+ * @param delta Variação de tempo entre a chamada atual e a última chamada
+ */
+ public void update(float delta){
}
+ /**
+ * Renderiza a tela de título
+ * @param delta Variação de tempo entre a chamada atual e a última chamada
+ */
@Override
public void render (float delta) {
- loop(delta);
+ update(delta);
// Draw background
core.game.render(delta, 0);
@@ -50,4 +66,11 @@ public void render (float delta) {
core.font.draw(core.batch, "RECORDE: 9.632", 10, core.height-11);
}
+ /**
+ * Descarrega todos os recursos
+ */
+ @Override
+ public void dispose(){
+ }
+
}
diff --git a/core/src/com/usp/corrida/utils/Random.java b/core/src/com/usp/corrida/utils/Random.java
index d1a519b..166080b 100644
--- a/core/src/com/usp/corrida/utils/Random.java
+++ b/core/src/com/usp/corrida/utils/Random.java
@@ -2,10 +2,13 @@
import java.util.Calendar;
+/**
+ * Cuida das funções aleatórias
+ */
public class Random {
- private long p = 2147483648L;
- private long m = 843314861L;
- private long a = 453816693L;
+ private final long p = 2147483648L;
+ private final long m = 843314861L;
+ private final long a = 453816693L;
private long xi = 0;
diff --git a/core/src/com/usp/corrida/utils/Utils.java b/core/src/com/usp/corrida/utils/Utils.java
index e3309a7..224714e 100644
--- a/core/src/com/usp/corrida/utils/Utils.java
+++ b/core/src/com/usp/corrida/utils/Utils.java
@@ -1,8 +1,15 @@
package com.usp.corrida.utils;
+/**
+ * Funções diversas para auxiliar no desenvolvimento do programa
+ */
public class Utils {
- // Convert x.xxxxx to x.x
+ /**
+ * Corrige a precisão do float para 1 casa decimal
+ * @param f número decimal da forma x.xxxxxxx
+ * @return número decimal da forma x.x
+ */
public static float fixFloat(float f){
return (int)(f*10)/10f;
}
diff --git a/docs/allclasses-frame.html b/docs/allclasses-frame.html
index 753ef85..d9ca2ff 100644
--- a/docs/allclasses-frame.html
+++ b/docs/allclasses-frame.html
@@ -2,7 +2,7 @@
-
+
All Classes (Corrida Aritmetica - docs)
diff --git a/docs/allclasses-noframe.html b/docs/allclasses-noframe.html
index 2fa62f0..cbc4baa 100644
--- a/docs/allclasses-noframe.html
+++ b/docs/allclasses-noframe.html
@@ -2,7 +2,7 @@
-
+
All Classes (Corrida Aritmetica - docs)
diff --git a/docs/com/usp/corrida/Core.html b/docs/com/usp/corrida/Core.html
index 4187114..5a13c7b 100644
--- a/docs/com/usp/corrida/Core.html
+++ b/docs/com/usp/corrida/Core.html
@@ -2,7 +2,7 @@
-
+
Core (Corrida Aritmetica - docs)
@@ -197,19 +197,19 @@