diff --git a/planung/architektur.md b/planung/architektur.md index 37f9782..6d6451a 100644 --- a/planung/architektur.md +++ b/planung/architektur.md @@ -1,8 +1,8 @@ # Architekturplan Zweiundvierzig -**Version: 2** +**Version: 3** -**Stand: 10.04.2016** (TT.MM.JJJJ / DD.MM.YYYY) +**Stand: 12.05.2016** (TT.MM.JJJJ / DD.MM.YYYY) [Hier die neuste offizielle Version vom Master-Branch sehen](https://github.com/HGE-IT-Course-2016/zweiundvierzig/blob/master/planung/architektur.md) @@ -61,14 +61,11 @@ Der Spieler kann mithilfe der Welt dann herausfinden, welche Provinzen ihm gehö - *Player* - *Dice* (Würfel) -### Sonstige Actors (Control Elemente) +### Sonstige Actors (GUI Objekte) - *GUI_Interface* - *Label* - *Button* - - *Menue_Button* - - *Roll_Button* -- *CurrentPlayerArrow* ### Sonstige @@ -365,8 +362,12 @@ Die Hauptklasse für Buttons, wird durch Erbung spezifiziert. ## Utils -Eine finale Klasse mit vielen kleinen Methoden, die den restlichen Code verkleinern und besser lesbar gestalten soll. Ergänzungen in Form von eigenen Funktionen dürfen selbst eingebracht werden. +Eine finale Klasse mit vielen kleinen Methoden, die den restlichen Code verkleinern und besser lesbar gestalten soll. Ergänzungen in Form von eigenen Funktionen dürfen **selbst** eingebracht werden. ### copyArray() -Kopiert ein Array des Types **boolean**, **int** oder **String** mit identischer Größe. \ No newline at end of file +Kopiert ein Array des Types **boolean**, **int** oder **String** mit identischer Größe. + +### drawInsideRectangle() + +Zeichnet innerhalb eines **GreenfootImage** ein Rechteck gefüllt mit der angegebenen Farbe. Es besitzt zu allen Seiten den gegebenen Abstand zum Rand des Image. \ No newline at end of file diff --git a/planung/funktionsliste.md b/planung/funktionsliste.md index 14c33ac..d19ee62 100644 --- a/planung/funktionsliste.md +++ b/planung/funktionsliste.md @@ -1,92 +1,127 @@ # Funktionsliste Zweiundvierzig -**Version: 2** +**Version: 3** -**Stand: 10.04.2016** (TT.MM.JJJJ / DD.MM.YYYY) +**Stand: 12.05.2016** (TT.MM.JJJJ / DD.MM.YYYY) [Hier die neuste offizielle Version vom Master-Branch sehen](https://github.com/HGE-IT-Course-2016/zweiundvierzig/blob/master/planung/funktionsliste.md) [Hier zum gesamten Architekturplan](https://github.com/HGE-IT-Course-2016/zweiundvierzig/blob/master/planung/architektur.md) -Hier einfach eine grobe Übersicht über alle Funktionen, die jede Klasse als Public / Protected besitzen soll. +Hier einfach eine grobe Übersicht über alle Funktionen, die jede Klasse als Public / Protected besitzen soll beziehungsweise bereits besitzt. +Weitere Informationen zu den Funktionen findet ihr in der Architektur oder, falls die Funktion bereits vorhanden ist, in der Dokumentation, die von Greenfoot automatisch erstellt wird (durch die InCode Dokumentation). Dies könnt auch als Checkliste nehmen, um zu sehen, ob ihr bereits alle Funktionen im Code präsent habt. ## GeneralMap -- **static GeneralMap generateMap(int mapID, ...)** +- static *GeneralMap* **generateMap** ( *int* mapID, ... ) -- **int getPlayerCount()** -- **String getPlayerName()** -- **String getPlayerName(int)** -- **int getPlayerStars()** -- **int getProvinceOwner(int)** -- **int[] getProvinceOwners()** -- **int getProvinceEntityCount(int)** -- **int getProvincesEntityCounts(int[])** -- **int getProvincesEntityCounts(boolean[])** -- **int getProvincesEntityCounts(int)** +- *int* **getPlayerCount** () +- *String* **getPlayerName** () +- *String* **getPlayerName** ( *int* ) +- *int* **getPlayerStars** () + +- *int* **getProvinceOwner** ( *int* ) +- *int[]* **getProvinceOwners** () +- *int* **getProvinceEntityCount** ( *int* ) +- *int* **getProvincesEntityCounts** ( *int[]* ) +- *int* **getProvincesEntityCounts** ( *boolean[]* ) +- *int* **getProvincesEntityCounts** ( *int* ) ## Province -- **Province(int, int, int, int, int, String, int[])** -- **Province(int, int, int, int, int, String, boolean[])** +- *Province* ( *int*, *int*, *int*, *int*, *int*, *String*, *int[]* ) +- *Province* ( *int*, *int*, *int*, *int*, *int*, *String*, *boolean[]* ) + +- *int* **getID** () +- *int* **getContinentID** () +- *String* **getDisplayName** () +- *boolean* **isProvinceNear** ( *int* ) + +- *int* **getStars** () -- **int getID()** -- **int getContinentID()** -- **boolean isProvinceNear(int)** -- **String getDisplayName()** -- **int getStars()** -- **int getOwner()** -- **setOwner(int)** -- **int getEntityCount()** -- **int addToEntities(int)** -- **int removeFromEntities(int)** -- **int setEntityCount(int)** +- *int* **getOwner** () +- *void* **setOwner** ( *int* ) -- **redrawProvince()** +- *int* **getEntityCount** () +- *int* **addToEntities** ( *int* ) +- *int* **removeFromEntities** ( *int* ) +- *int* **setEntityCount** ( *int* ) + +- *void* **redrawProvince** () ## Player -- **Player(int, String)** +- *Player* ( *int*, *String* ) -- **int getID()** -- **String getDisplayName()** -- **int getStars()** -- **int addToStars(int)** -- **int removeFromStars(int)** -- **int setStars(int)** -- **boolean cnaStarsRemoved(int)** +- *int* getID () +- *String* **getDisplayName** () +- *int* **getStars** () +- *int* **addToStars** ( *int* ) +- *int* **removeFromStars** ( *int* ) +- *int* **setStars** ( *int* ) +- *boolean* **canStarsRemoved**( *int* ) -- **int[] getStatistics()** -- **gotProvince()** -- **lostProvince()** -- **gotEntities(int)** -- **lostEntity()** +- *int[]* **getStatistics** () +- *void* **gotProvince** () +- *void* **lostProvince** () +- *void* **gotEntities** ( *int* ) +- *void* **lostEntity** () -- **boolean[] getMyProvinces()** -- **int getProvinceCount()** -- **redrawPlayer()** +- *boolean[]* **getMyProvinces** () +- *int* **getProvinceCount** () +- *void* **redrawPlayer** () ## Dice -- **Dice()** +- *Dice* () -- **int getNumber()** +- *int* **getNumber** () -- **int roll()** +- *int* **roll** () ## GUI_Interface -*Noch unvollständig* +- *int* **getWidth** () +- *int* **getHeight** () +- *void* **setSize** ( *int*, *int* ) + +- *System.awt.Color* **getBackColor** () +- *boolean* **setBackColor** ( *System.awt.Color* ) +- *System.awt.Color* **getForeColor** () +- *boolean* **setForeColor** ( *System.awt.Color* ) + +- abstract *void* **redraw** () + +## Label (erweitert GUI_Interface) + +- *Label* ( *String*, *int* ) + +- *boolean* **getAutoSize** () +- *boolean* **setAutoSize** ( *boolean* ) + +- *int* **getTextSize** () +- *boolean* **setTextSize** ( *int* ) + +- *String* **getText** () +- *boolean* **setText** ( *String* ) + +## Button (erweitert GUI_Interface) -## Label +- *Button* ( *String*, *int* ) +- *Button* ( *ButtonEvent* ) +- *Button* ( *String*, *int*, *ButtonEvent* ) -*Noch unvollständig* +- *boolean* **getAutoSize** () +- *boolean* **setAutoSize** ( *boolean* ) -- **String getText()** -- **String setText(String)** +- *int* **getTextSize** () +- *boolean* **setTextSize** ( *int* ) -## Button +- *String* **getText** () +- *boolean* **setText** ( *String* ) -*Noch unvollständig* \ No newline at end of file +- *ButtonEvent* **getHandler** () +- *void* **setHandler** ( *ButtonEvent* ) +- *void* **removeHandler** () \ No newline at end of file