Observatør-observert-teknikken - Videreføring av spilloppgaver

GridProvider har følgende metoder for rutenettets dimensjoner og innhold:

• int getGridWidth() - returnerer bredden eller antall kolonner i rutenettet, f.eks. 3 for standard Tic Tac Toe
• int getGridHeight() - returnerer høyden eller antall rader i rutenettet, f.eks. 3 for standard Tic Tac Toe
• Object getGridElement(int x, int y) - returnerer objektet som er lagret i en bestemt rute angitt med x,y-koordinater (altså kolonne,rad). Dette kan være noe så enkelt som et tegn, f.eks. 'x', 'o' eller ' ' for Tic Tac Toe, eller noe mer komplisert for Sudoku. Object brukes som returtype, for å kunne håndtere alle type spill og implementasjoner.

For å gå gjennom alle elementene i rutenettet vil en typisk lage en dobbel løkke:

GridProvider grid = ...
for (int row = 0; row < grid.getGridHeight(); row++) {
	for (int column = 0; column < grid.getGridWidth(); column++) {
		Object element = grid.getGridElement(column, row);
		// gjør noe med element her
	}
}

GridProvider har følgende metoder for lytterhåndtering:

• void addGridListener(GridListener) - registrerer en lytter skal skal ha beskjed hver gang rutenettet endres
• void removeGridListener(GridListener) - avregistrere en lytter som tidligere er registrert med addGridListener

Lytterne må implementere GridListener og dermed følgende metode:

• gridChanged(GridProvider grid, int x, int y, int w, int h) - metoden kalles for å gi beskjed om at en eller flere ruter i rutenettet (grid) innenfor det angitte rektanglet er endret. Rektanglet er angitt med posisjon x, y og dimensjonene w, h (bredde, høyde).

Hvis f.eks. metoden kalles med x=1, y=2, w=2 og h=1, så angir det at rutene 1,2 og 2,2 er endret. Det er opp til rutenett-klassen å avgjøre om endringer av flere ruter rapporteres med ett eller flere kall til gridChanged-metoden. Så endringer i rutene 1,2 og 2,2 kan også rapporteres med to kall, ett hvor x=1, y=2 og ett hvor x=2, y=2, med w=1 og h=1 for begge. Så selv om en kaller denne metoden, så er det ikke dermed sagt at alle rutene i det angitte rektangelet er endret (strengt tatt trenger ingen å være det).

Spillets livssyklus

Det er GUI-et som lager en instans av spillklassen og styrer oppstart og utvikling av spillet, dvs. laster inn et nytt nivå eller bra, setter spillet igang og driver det fremover ved å ta imot input fra brukeren og videreformidle det til spillet. Spillklassen din må innordne seg hvordan GUI-et gjør dette, ved å tilby et standard sett med metoder definert i GridGame-grensesnittet. De viktigste metodene er knyttet til den overordnede livssyklusen til spillet:

• void init(String) - denne metoden kalles av GUI-et for å initialisere et nytt spill, men uten at det settes igang. Argumentet er ment å angi et nivå, brett eller det som gir mening for spillet ditt. Det kan f.eks. være en nettadresse hvor nivået ligger, nivået koden direkte i en String eller dimensjonene til et brett. Det er brukeren som skriver String-argumentet inn, og det er opp til implementasjonen av metoden å tolke og bruke det.
• GridProvider getGridProvider() - denne metoder returnerer objektet som representerer selve rutenettet, som ble initialisert av init-metoden. Ved hjelp av dette objektet, kan GUI-et vise frem rutenettet og registrere seg som lytter for å få beskjed om endringer i rutenettet.
• void run(GameOutput) - denne metoden setter igang spillet. Argumentet er et objekt som spillet må huske og som under spillets gang kan brukes for å gi meldinger og statusoppdateringer til brukeren. (I praksis er dette objektet GUI-et selv, og GUI-ets implementasjon av GameOutput-metodene angjør hvordan meldinger vises til brukeren.)
• Integer doCommand(String) - det er denne metoden som driver spillet fremover ved at brukerinput formidles fra GUI-et til spillet. Argumentet er en slags kommandolinje, på et format som kan tolkes og brukes av spillet. Returverdien er spillets måte å fortelle GUI-et om spillet er ferdig og i tilfelle hva som ble resultatet. En null-verdi betyr at spillet ikke er ferdig og 0 betyr at det ikke ble noe resultat (eller uavgjort). En negativ eller positiv verdi angir hhv. tap eller seier, evt. hvilken av to spillere som vant.

Meldinger til brukeren

Den viktigste logikken i spillet ligger typisk i doCommand-metoden, siden den håndterer input fra brukeren. Effekten vil typisk være at spillet endrer rutenettet, og dette fanges opp av GUI-et, som lytter til rutenettendringer, slik at den grafisk visningen kan oppdateres. I tillegg kan spillet gi meldinger og statusoppdateringer til brukeren vha. GameOutput-objektet som ble gitt til run-metoden, da spillet startet. Det er derfor dette objektet må lagres unna, slik at det er tilgjengelig for doCommand-metoden.

GameOutput-objektet tilbyr tre metoder, for meldinger av ulik alvorlighetsgrad:

• info(String) - viser String-argumentet som en enkelt statusoppdatering, f.eks. "x sin tur" eller "4 av 8 bokser er på plass".
• warning(String) - viser String-argumentet som et (forsiktig) varsel. f.eks. "Ulovlig trekk".
• error(String) - viser String-argumentet som et (kraftig) varsel. f.eks. "Inkonsistent brett".

Akkurat hvordan meldingen vises er opp til GUI-et, som implementerer metodene, men tanken er når alvorlighetsgraden øker, så blir meldinger mer tydelig og påtrengende. F.eks. kan info oppdatere en statuslinje, mens error åpner en meldingsdialog.

Visning av rutenett-element

GridGame har i tillegg til metodene angitt over to metoder for å angi hvordan elementene i rutenettet vises. Tanken er at hver rute i rutenettet kan vises med tekst og/eller bilde og at GUI-et for hver rute spør om disse med følgende metoder:

• String getTextFor(Object) - returnerer teksten som skal vises for rutenett-elementet angitt av argumentet. Dersom en ikke ønsker en tekst så returneres null.
• String getImageFor(Object) - returnerer en String som angir bildet som skal vises for rutenett-elementet angitt av argumentet. String-en kan være en nettadresse eller navnet/stien til en fil som er relativt til spillklassen eller prosjektet. Hvis en f.eks. har en fil med navn bilde.png liggende i samme mappe/pakke som java-fila for spillklassen din, så returneres bare "bilde.png". Dersom en ikke ønsker et bilde så returneres null.

Begge disse metodene tar et Object-argumentet, og disse er alle hentet med GridProvider sin getGridElement-metode. Siden argument-typen er Object, så kan det tenkes at du må bruke cast til den typen du vet ligger i rutenettet, for å kunne hente ut data som ligger inni dette objektet.

Håndtering av ikke-tekstlig input

doCommand-metoden beskrevet over, brukes for tekstlig input tilsvarende et kommandlinje-basert spill. For å gjøre spillet bedre egnet til å styres av et GUl så har GridGame i tillegg følgende metoder for å ta imot input:

• Integer gridElementInput(int x, int y) - kalles når brukeren har valgt en rute i rutenettet, f.eks. ved å klikke i ruta.
• Integer directionInput(int dx, int dy) - kalles når brukeren angir en retning, f.eks. ved å trykke en piltast.

For begge disse tolkes returverdien som for doCommand, og effekten kan, som for doCommand, være en kombinasjon av oppdatering av rutenettet eller tekstlig output til brukeren vha. GameOutput.

GUI-et har tre deler, fra øverst til nederst:

• Øverst: En kan angi et nivå/bret e.l. og starte spiller ved å trykke "init and run"-knappen
• I midten: Rutenettet vises, og hvis det har fokus, så kan en trykke piltastene eller klikke på en rute
• Nederst: Tekstfelt for å gi inn kommandoer

Når brukeren trykker "init and run"-knappen vil GUI-et ta innholdet i det øverste tekstfeltet og gi det som argument til spillklassen sin init-metode. Deretter vil den be om å få rutenettet vha. getGridProvider()-metoden. Dette objektet vil så spørres om antall kolonner (getGridWidth()) og rader (getGridHeight()) og selve innholdet (getGridElement(...)), slik at den kan tegne rutenettet. Akkurat hvilken tekst og hvilket bilde som vises pr. rute bestemmes av svaret fra getTextFor(...) og getImageFor(...). Til slutt vil GUI-et registrere seg som lytter, slik at den kan reagrere på fremtidige endringer i rutenett. Til slutt startes selve spillet med et kall til run(...) og denne metoden vil typisk gi oppstartsinfo til brukeren med info(...)-metoden.

Når brukeren trykker "doCommand"-knappen vil GUI-et ta innholdet i det nederste tekstfeltet og gi det som argument til spillklassen sin doCommand-metode. Dette vil typisk trigge en endring i rutenettet, som gir beskjed til lytterne, inkl. GUI-et, om endringen. GUI-et vil hente innholdet i ruten(e) som ble endret med getGridElement(...) og hvilken tekst og hvilket bilde som skal vises med getTextFor(...). Det kan også hende at statusen til spillet oppdateres med info(...)-metoden.