Comments added to Gap.java

This commit is contained in:
Siket Melinda Tekla 2016-05-16 16:26:58 +02:00
parent c734156954
commit 33c3bce6e2

View File

@ -1,33 +1,68 @@
package cicaprojekt; package cicaprojekt;
/**
* A játékban megjelenő szakadékokat reprezentáló osztály.
*/
public class Gap extends cicaprojekt.Tile { public class Gap extends cicaprojekt.Tile {
public Gap() { /**
* Az osztály konstruktora.
*/
public Gap() {
super(); super();
} }
/**
* A függvény igazzal tér vissza, ha a lehet lépni az adott szakadékra,
* hamissal, ha nem.
*
* @return true
*/
@Override @Override
public boolean isSteppable() public boolean isSteppable()
{ {
return true; return true;
} }
/**
* A függvény igazzal tér vissza, ha a <code>Tile</code> típusa szakadék.
*
* @return true
*/
@Override @Override
public boolean isGap() public boolean isGap()
{ {
return true; 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 <code>PlayerBase</code> példány, amely rálépett
* a szakadékra
*/
@Override @Override
public void onEntry(PlayerBase playerBase) { public void onEntry(PlayerBase playerBase) {
super.onEntry(playerBase); super.onEntry(playerBase);
playerBase.destroy(); 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 @Override
public void onExit(PlayerBase playerBase) throws IllegalStateException { public void onExit(PlayerBase playerBase) throws IllegalStateException {
throw new IllegalStateException("Hiba! A szakadékból nem jut ki semmi!"); 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 <code>Box</code> példány, amely a szakadékba került
*/
@Override @Override
public void putABox(Box box) { public void putABox(Box box) {
box.destroy(); box.destroy();