From 33c3bce6e2c35772c517667e14ddda4bacc43a1d Mon Sep 17 00:00:00 2001 From: Siket Melinda Tekla Date: Mon, 16 May 2016 16:26:58 +0200 Subject: [PATCH] Comments added to Gap.java --- cicaprojekt/Gap.java | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/cicaprojekt/Gap.java b/cicaprojekt/Gap.java index 6df4004..557b4f3 100644 --- a/cicaprojekt/Gap.java +++ b/cicaprojekt/Gap.java @@ -1,33 +1,68 @@ package cicaprojekt; +/** + * A játékban megjelenő szakadékokat reprezentáló osztály. + */ public class Gap extends cicaprojekt.Tile { - public Gap() { + /** + * Az osztály konstruktora. + */ + public Gap() { super(); } + /** + * A függvény igazzal tér vissza, ha a rá lehet lépni az adott szakadékra, + * hamissal, ha nem. + * + * @return true + */ @Override public boolean isSteppable() { return true; } + /** + * A függvény igazzal tér vissza, ha a Tile típusa szakadék. + * + * @return true + */ @Override public boolean isGap() { return true; } + /** + * A függvény akkor hívódik meg, ha egy személy rálép a szakadékra, + * ekkor az megsemmisül. + * + * @param plyerBase az a PlayerBase példány, amely rálépett + * a szakadékra + */ @Override public void onEntry(PlayerBase playerBase) { super.onEntry(playerBase); playerBase.destroy(); } + /** + * A szakadékból való kilépéskor hívódik meg, ez hibát eredményez. + * + * @throws IllegalStateException Ha valami kijut a szakadékból. + */ @Override public void onExit(PlayerBase playerBase) throws IllegalStateException { throw new IllegalStateException("Hiba! A szakadékból nem jut ki semmi!"); } + /** + * A függvény akkor hívódik meg, ha egy doboz kerül a szakadékba. + * Ekkor a doboz megsemmisül. + * + * @param box az a Box példány, amely a szakadékba került + */ @Override public void putABox(Box box) { box.destroy();