Esteet eli Obstaclet.

Johdanto

Pelin toimintoihin eli actioneihin voidaan liittää tehtäviä, jotka pelaajan täytyy ratkaista ennen, kuin toiminto voidaan suorittaa. Tehtäviä nimitetään esteiksi (obstacles). Tässä pelissä niiden on tarkoitus olla erilaisia kielitehtäviä, kuten esimerkiksi projektissa ensimmäiseksi aukkotehtävä (fill-in-blank), monivalinta ja sanan keksiminen määrittelyn mukaan (glossary).

Pelinkirjoittajat voivat muokata omia esteitä kunkin esteen editorilla (Obstacle Editor), joka toimii kirjoittajan käyttöliittymän alaisuudessa.

Esimerkiksi pelinkirjoittaja voi halutessaan asettaa uuteen paikkaan siirtymisen ehdoksi bussilipun omistamisen sekä lisäksi aukkotehtävän, jossa pelaajan on täydennettävä linja-autonkuljettajan kanssa käytävä keskustelu.

Toimintojen esittely

Yhteiset toiminnot

obstacle_editor.pl

Este-editorin yhteinen osa, jossa on kaikille esteille yhteisiä toimintoja (palveluita). Editorista voidaan valita muokattavaksi haluttavan esteen luokka ja haluttaessa esteen lähdetiedosto. Ohjelma etsii esteen hakemistosta sen oman editorin ja käynnistää sen tarvittavilla parametreilla. Editori siis sisältää esteiden lähdetiedostojen avaamiseen (=valitsemiseen) tarvittavat rutiinit.

link_obstacle.pl

Ohjelma esteen liittämiseksi pelin toimintoon (action). Ohjelma kysyy esteen luokan ja hakee esteen modulin sekä estekohtaisen liittämis-rutiinin, jota kutsuu tarvittavin parametrein.

Estekohtaiset toiminnot

Hakemistot

../cgi-bin/obstacles/ObstacleClass/

../data/obstacles/ObstacleClass/

Esteen ohjelmat sijaitsevat binäärihakemistossa: ../cgi-bin/obstacles/ObstacleClass/.
Esim. ../cgi-bin/obstacles/fill-in-blank/

Tässä hakemistossa on esteen muokkaamisen, ja luomisen mahdollistava editori; esteen peliin liittämistä varten ohjelma, joka kysyy käyttäjältä vaaditut parametrit oikean muotoisina; Varsinainen este-moduli, joka tulostaa esteen html-muotoisena argumenttiensa mukaan; sekä mahdollisesti muita estekohtaisia ohjelmia ja scriptejä - ei muuttuvia data-tiedostoja.

Estekohtaiset datatiedostot taas ovat jälkimmäisessä hakemistossa: Esteen lähdekoodi, joka on käyttäjän antama. Se säilytetään esteen muokkaamisen ja uudelleen generoimisen mahdollistamiseksi. Tiedostolla on tunniste .txt. Esteellä voi olla html-muotoinen templatetiedosto eli instanssi, joka on valmiiksi generoitu este. Esteen oikeat vastaukset voivat olla tunnisteella .answer olevassa tiedostossa.

Ohjelmatiedostot

Esteen liittämiseksi pelin toimintoon olevan estekohtaisen ohjelman nimi on muotoa link_ObstacleClass* Tämä huolehtii vaadittujen parametrien kysymisestä, oikeellisuudesta ja välittämisestä kirjoittan käytt|liittymään.

Estemodulin nimi on muotoa ObstacleClass* (esim. fill-in-blank.pl) ja tarkka nimi kuljetetaan objektissa ObstacleName. Estemoduli muodostaa käyttäjälle (tai pelin kirjoittajalle) html-muotoisen esteen saamiensa parametrien ja esteen data-hakemistossa ../data/obstacles/ObstacleClass/ olevien tiedostojen avulla. Este voidaan muodostaa joko lähdetiedostosta generoimalla tai valmiiksi generoidusta template-tiedostosta. Estemodulin parametrina saamaan tiedoston nimi on objektissa: ObstacleInstance.

Estemoduli voi kutsua käyttäjien vastauksia tarkistavaa check_ObstacleClass* nimistä ohjelmaa, kuten fill-in-blank -este tekee. Oikeat vastaukset ovat tässä modulissa .answer tunnisteisessa tiedostossa data-hakemistossa.

FUNKTIOKUVAKSET

Esteille yhteiset toiminnot

Huom. lähes jokainen ohjelma "kutsuu" formien kautta myös itseään. Tämä on WWW:lle tyypillinen ominaisuus, koska ohjelmat eivät ole jatkuvasti päällä, vaan ne suoritetaan aina formeihin kytkettyjen toimintojen seurauksena.

Nimi:

Kutsuminen:

Nimi polkuineen:

Kutsuja(t):

Argumentit:

UserID, int

RoundNumber, int

AdventureID, int

ActionID, int

ObstacleClass, string(40)

Memo, string

start_obstacle_editor - string, a hidden object which implicates that the obstacle editor will be started

Kutsuu funktiota:

Argumenteilla:

UserID, int

AdventureID, int

ActionID, int

RoundNumber, int

Memo, string

ObstacleClass, string(40)

name, string(40)

edit_obstacle - indicates that the editor prints the begin screen.

Kutsuu funktiota:

Argumenteilla:

UserID, int

Kuvaus:

--

Nimi:

Kutsuminen:

Nimi polkuineen:

Kutsuja(t):

Argumentit:

UserID, int

AdventureID, int

ActionID, int

RoundNumber, int

Memo, string

select_linked_obstacle - a hidden object which indicates that the editor prints the begin screen.

Kutsuu funktiota:

Argumenteilla:

UserID, int

AdventureID, int

ActionID, int

RoundNumber, int

Memo, string

ObstacleClass, string(40)

class_selected - a hidden object which indicates that the editor prints the begin screen.

Kutsuu funktiota:

Argumenteilla:

UserID, int

Kuvaus:

Estekohtaiset toiminnot

Nimi:

Kutsuminen:

Nimi polkuineen:

Kutsuja(t):

Argumentit:

UserID, int

AdventureID, int

ActionID, int

RoundNumber, int

Memo, string

ObstacleClass, string(40)

class_selected - a hidden object which indicates that the editor prints the begin screen.

Kutsuu funktiota:

Argumenteilla:

UserID, int

AdventureID, int

ActionID, int

RoundNumber, int

Memo, string

ObstacleClass, string(40)

ObstacleInstance, string(40)

ObstacleOptions, string(40)

Kuvaus:

---

Nimi:

Kutsuminen:

Nimi polkuineen:

Kutsuja(t):

Argumentit:

UserID, int

ActionID, int

RoundNumber, int

ObstacleClass, string(40)

ObstacleInstance, string(40)

ObstacleOptions, string(40)

BeforeDescription, string(255)

edit_ObstacleClass*:

Argumentit:

UserID, int

ActionID, int

RoundNumber, int

ObstacleClass, string(40)

ObstacleInstance, string(40)

ObstacleOptions, string(40)

NoGame

Kutsuu funktiota:

Argumenteilla:

UserID, int

ActionID, int

RoundNumber, int

Memo, string

AdventureID, int

start_obstacle_editor - string, a hidden objhect which implicates that the obstacle editor will be started

Kutsuu funktiota:

Argumenteilla:

UserID, int

RoundNumber, int

Kutsuu funktiota:

Argumenteilla:

UserID, int

ActionID, int

RoundNumber, int

ObstacleInstance, string(40)

ObstacleOptions, string(40)

BeforeDescription, string(255)

Kuvaus:

Estemoduli voi kutsua käyttäjien vastauksia tarkistavaa check_ObstacleClass* nimistä ohjelmaa. Oikeat vastaukset voivat olla .answer tunnisteisessa tiedostossa data-hakemistossa.

--

Nimi:

Kutsuminen:

Nimi polkuineen:

Kutsuja(t):

Argumentit:

UserID, int

ActionID, int

RoundNumber, int

ObstacleInstance, string(40)

ObstacleOptions, string(40)

BeforeDescription, string(255)

Kutsuu funktiota:

Argumenteilla:

UserID, int

RoundNumber, int

Kutsuu funktiota:

Komentorivi-argumenteilla:

UserID, int

ActionID, int

RoundNumber, int

Score - 0-100

Kutsuu funktiota:

Argumenteilla:

UserID, int

ActionID, int

RoundNumber, int

AdventureID - 311

Memo, string

start_obstacle_editor - string, a hidden objhect which implicates that the obstacle editor will be started

Kuvaus:

---

Esteisiin liittyvät toiminnot

Esteisiin liittyviä käyttöliittymä-kuvia

• Obstacle Editori päätasolla
• Obstacle Editori - tiedoston valinta
• Esteen Fill-in-blank editori
• Esteen linkkaus pelin toimintoon
• Esteen Fill-in-blank ohjelmakohtainen linkkaus

Obstacle Editorissa käyttäjä valitsee ensin selaimella sen esteen luokan (ObstacleClass), jota haluaa editoida. Pelinkirjoittaja voi joko aloittaa uuden esteen muokkaamisen toiminnolla Create a new Obstacle tai valita olemassaolevan esteen muokattavaksi toiminnolla Open an existing Obstacle, jolloin selaimella valitaan haluttu tehtävätiedosto. Tämän jälkeen käynnistyy valitun esteen oma editori. Esteelle annetaan yksilöllinen nimi ja editoriin täydennetään esteen vaatimant tiedot. Käyttäjä voi poistaa esteen toiminnolla Delete an Obstacle.

Esimerkkitapauksessa valitaan täyttötehtävän editori (edit_fill-in-blank.pl).Täyttötehtävän teksti voidaan joko kirjoittaa suoraan ruudulle avautuvaan teksti-editoriin tai kopioda leikepöydältä täyttötehtävän editoriin. Kirjoittaja ympäröi pelaajalta piiloon jääviksi tarkoitetut sanat hakasuluilla. Esim. [tämä lause jäisi pelaajalta piiloon]. Hakasulkuihin on mahdollista laittaa useampiakin oikeita vastauksia, jolloin ne erotetaan toisistaan pilkulla. Teksti voi olla joko pelkässä tekstimuodossa tai html-muodossa, jolloin tehtävään voidaan liittää esimerkiksi kuvia tai muita tehokeinoja. Tämä mahdollistaa näyttävien ja monipuolisten tehtävien laadinnan, eikä käyttäjän kuitenkaan tarvitse osata HTML, että voisi tehdä yksinkertaisia tehtäviä.

Esten muodostus

Kun teksti on valmis, editori muokkaa esteen omaan data-hekemistoon ../data/obstacles/ObstacleClass tekstistä html-muotoisen template-tiedoston, jolla on .html tunniste. Tiedosto voidaan liittää html-dokumentin sisälle.

Esimerkin este-tiedosto sisältää tyttötehtävän tekstin ja tyhjät html-formeit vastauksia varten.

sekä painike, joka kutsuu tehtävän tarkistusrutiinia check_ObstacleClass*. Pelaajan antamia vastauksia verraraan Obstacle Editorin tekemään vastaustiedostoon, jossa on .answer tunniste. Vastaustiedostossa oikeat vastaukset ovat allekkain. Jos on useampi oikea vastaus, niin ne ovat samalla rivillä pilkulla erotettuna. Käyttäjän kirjoittama teksti talletetaan myös alkuperäisessä muodossa .txt tunnisteiseen tiedostoon, jotta tehtävän editoiminen jälkikäteen olisi mahdollista.

Eli fill-in-blank -editori luo jokaisesta estettä varten kolme tiedostoa: Esteen toiminnoista huolehtivan .html-tiedoston, täyttötehtävän vastaukset sisältävän .answer-tiedoston ja esteen tekstin käyttäjän kirjoittamassa muodossa sisältävän .txt-päätteisen tiedoston.

Esteet pelissä

Pelissä este on siis liitetty toimintoon (Action). Toiminnossa on lisäksi esteeseen kuuluva selostus (BeforeMessage), joka tulostuu ennen estettä. Toiminnoista huolehtiva ohjelma actexe1 kutsuu html-muotoisen este-sivun muodostavaa ohjelmaa ObstacleName (esim. fill-in-blank.pl) Parametreina annetaan: UserID, RoundNumber, ActionID, BeforeDescription, ObstascleClass ja ObstacleOptions.

Este-moduli (ObstacleClassObstacle*) tekee html-sivun määrittelyt, tulostaa esteen selostuksen ja muodostaa annettujen parametrien mukaisen esteen, joko generoimalla itse sen, tai lataamalla annetun nimisen valmiin instanssin esteen tominnasta riippuen. Este liitetään html-sivuun. Sivuun liitetään Check the Answers -painike, joka kutsuu tehtävän tarkistusrutiinia check_ObstacleClass* sekä Cancel-painike, jolla voidaan keskeyttää tehtävän ratkaiseminen ja palata edelliselle sivulle.

Kun esimerkkitapauksen täyttötehtävä on saatu valmiiksi, pelaaja voi painaa Check the Answers -painiketta, joka käynnistää vastaukset tarkastavan rutiinin check_ObstacleClass*. Parametreina ovat UserID RoundNumber ja ActionID. Pelaaja voi myös keskeyttää tehtävän ratkaisemisen Cancel-painikkeesta ja palata edelliselle sivulle. Painikkeesta kutsutaan rutiinia loccrea. Parametrina ovat UseID ja RoundNumber.

Vastausten tarkastus rutiinissa pelaajan antamia vastauksia verraraan Obstacle Editorin tekemään vastaustiedostoon, jossa on .answer tunniste. Vastaustiedostossa oikeat vastaukset ovat allekkain. Jos on useampi oikea vastaus, niin ne ovat samalla rivillä pilkulla erotettuna. Pelaajan tarvitsee suorittaa kukin este vain kerran.

Jos vastaukset olivat oikein, kutsutaan rutiinia actexe2, joka suorittaa tehtävän, johon este oli liitetty. Parametreiksi annetaan: UserID, ActionID ja RoundNumber.

Jos pelaaja ei vastannut riittävän hyvin, eikä läpäise estettä kutsutaan rutiinia kutsutaan rutiinia loccrea. Parametrina ovat UseID ja RoundNumber.

Toiminnot ja rakenne opettajan käyttöliittymässä

1. Esteen muokkaus ja luonti.

1.1. Haluttaessa luoda uusi este:
1.1.1. Valitaan toiminto Create a new Obstacle.
1.1.2. Valitaan esteen luokka (ObstacleClass) valinta-ikkunasta.
1.1.3. Esteen oma editori käynnistyy. Editori on esteen binäärihakemistossa /cgi-bin/ObstacleClass/. Editorin nimenä on edit_ObstacleClass*.
1.1.4. Kirjoitetaan esteelle nimi.
1.2. Editoitaessa vanhaa estettä:
1.2.1. Valitaan toiminto Open an Obstacle for Editing.
1.2.2. Select Obstacle Class, valitaan esteen luokka valintaikkunasta.
1.2.3. Select the Source File, valitaan editoitava este.
1.2.4. Esteen editori käynnistyy, esteellä on oletusarvona valittu nimi. Vanha este ladataan levyltä editoriin
.

Aukkotehtävä-esteen (Fill-in-blank Obstacle) luonti ja rakenne.

3.1. Teksti voidaan kirjoittaa suoraan ruudulle avautuvaan teksti-editoriin.
3.2. Kopioda haluttu teksti leikepöydälle ja sieltä editoriin.

8.1. Täyttötehtävän tekstin ja tyhjät html-formeit pelaajan vastauksia varten.
8.2. Check the Answers -painikkeen, joka kutsuu tehtävän tarkistusrutiinia check_fill-in-blank.pl.

Esteen toiminta pelin aikana

1. Jos toimintoon on liitetty este, niin actexe1 käynnistää obstacle-modulin ObstacleName. Parametreina annetaan: UserID, RoundNumber, ObstacleClass, ObstacleInstance, ObstacleOptions, ActionID ja BeforeDescription.

2. ObstacleName muodostaa estesivun seuraavien tietojen avulla:

2.1. Parametrina saadusta tehtävänkuvaksesta BeforeDescription.
2.2. ObstacleOptions objektissa olevien parametrin mukaan.
2.3. ../data/obstacles/ hakemistosta luetusta esteen instanssista ObstacleInstance.

3.1. keskeytyspainike(Return), josta voidaan palata edelliselle sivulle. Painiketta painettaessa ajetaan rutiini loccrea. Se saa parametriksi UserID:n ja RoundNumberin.
3.2. E-Mail to Authors -painike lähettää postia ohjelman tekijöille.
3.3. Help on Playing vie pelin ohjesivuille.
3.4. Dictionaries & other useful links -painike vie sivulle, jossa on mm. elektronisia sanakirjoja ja muita kieliaiheisia sivuja, jotka voivat auttaa mm. tehtävien ratkaisussa.

5.1. Este-moduli (tai jokin sen alirutiineista) kutsuu actexe2:ta, kun pelaaja on ratkaissut tehtävän ja siten saa suorittaa toiminnon. sDoAction.pl saa parametreiksi UserID:n, RoundNumberin ja ActionID:n.

5.2. Este-moduli (tai jokin sen alirutiineista) kutsuu rutiinia loccrea, jos pelaaja ei ole saanut suoritettua tehtävää riittävän hyvin. Parametrina on UserID, RoundNumber.