From c734156954830a75e139abaa6d358c7b8d21ccf8 Mon Sep 17 00:00:00 2001 From: Siket Melinda Tekla Date: Mon, 16 May 2016 16:26:10 +0200 Subject: [PATCH] Comments added to Field.java --- cicaprojekt/Field.java | 33 ++++++++++++++++++++++++++++++++- 1 file changed, 32 insertions(+), 1 deletion(-) diff --git a/cicaprojekt/Field.java b/cicaprojekt/Field.java index 18a1100..05c2da1 100644 --- a/cicaprojekt/Field.java +++ b/cicaprojekt/Field.java @@ -1,15 +1,36 @@ package cicaprojekt; +/** + * A játékban megjelenő mezőket reprezentáló osztály. + */ public class Field extends cicaprojekt.Tile { - public Field() { + /** + * Az osztály konstruktora. + */ + public Field() { super(); } + /** + * Igazzal tér vissza, ha rá lehet lépni a mezőre, hamissal, ha nem. + * A rajta lévő dobozok szerint dönti el, hoyg rá lehet-e lépni. + * + * @return igaz, ha nincsenek dobozok rajta + * hamis, ha vannak dobozok rajta + */ @Override public boolean isSteppable() { return boxStack.isEmpty(); } + /** + * A függvény akkor hívódik meg, ha egy személy rá akar lépni a mezőre. + * Ha a mezőn vannak dobozok, akkor nem engedi rálépni a személyt, + * ha nincsenek, akkor engedi. Ekkor átállítja a személy helyét a mezőre, + * és ha azon volt ZPM, akkor azt a személy felveszi. + * + * @param playerBase a személy, aki rá akar lépni a mezőre + */ @Override public void onEntry(PlayerBase playerBase) { super.onEntry(playerBase); @@ -20,9 +41,19 @@ public class Field extends cicaprojekt.Tile { playerBase.pickZPM(this); } + /** + * A függvény akkor hívódik meg, ha egy személy le akar lépni róla. + * + * @param playerBase a személy, aki le akar lépni a mezőről + */ @Override public void onExit(PlayerBase playerBase) {} + /** + * A függvény azt adja meg, hogy lehet-e a mezőn ZPM. + * + * @return true + */ @Override public boolean canHazZPM() { return true;