Jypeli  5
The simple game programming library
Timer luokkareferenssi

Ajastin, joka voidaan asettaa laukaisemaan tapahtumia tietyin väliajoin. Lisää...

Julkiset jäsenfunktiot

 Timer ()
 Alustaa uuden ajastinluokan. Lisää...
 
void Start ()
 Käynnistää ajastimen. Lisää...
 
void Start (int times)
 Käynnistää ajastimen, rajoittaa suorituskerrat. Lisää...
 
void Pause ()
 Pysäyttää ajastimen tallentaen sen tilan. Lisää...
 
void Stop ()
 Pysäyttää ajastimen ja nollaa sen tilan. Lisää...
 
void Reset ()
 Nollaa ajastimen tilan. Myös suorituskerrat nollataan. Lisää...
 

Staattiset julkiset jäsenfunktiot

static void SingleShot (double seconds, Action onTimeout)
 Kutsuu aliohjelmaa onTimeout annetun ajan kuluttua. Ajastin luodaan automaattisesti. Lisää...
 
static void Limit (Action action, double seconds)
 Rajoittaa toimintaa niin, että se voidaan suorittaa vain tietyin väliajoin. Huom. älä käytä delegaatteja tämän metodin kanssa! Lisää...
 

Suojatut jäsenfunktiot

void OnStopped ()
 

Ominaisuudet

bool Enabled [get, set]
 Ajastin päällä/pois päältä. Lisää...
 
bool IgnorePause [get, set]
 Ajastin ei pysähdy vaikka peli pysäytettäisiin. Lisää...
 
double Interval [get, set]
 Aika sekunneissa, jonka välein TimeOut tapahtuu. Lisää...
 
double CurrentTime [get, set]
 Menossa oleva hetki nollasta väliaikaan (Interval). Lisää...
 
DoubleMeter SecondCounter [get]
 Ajastimen käynnistysaika. Lisää...
 
double SecondCounterStep [get, set]
 Kuinka monta sekuntia sekuntilaskuri laskee yhden sekunnin aikana. Oletus on 1. Arvolla 2 laskuri laskee tuplanopeudella, arvolla -1 taaksepäin jne. Lisää...
 
IntMeter Times [get]
 Määrää, kuinka monta kertaa tapahtuma suoritetaan. Kun tapahtumaa on suoritettu tarpeeksi, Enabled saa automaattisesti arvon false, jolloin ajastin pysähtyy. Kun laskuri nollataan, myös Times palautuu oletusarvoonsa. Huomaa, että TimesLimited tulee olla true, että arvo otetaan huomioon. Lisää...
 
bool TimesLimited [get, set]
 Ajastimen suorituskertojen rajoitus päälle/pois. Lisää...
 
object Tag [get, set]
 Vapaasti asetettava muuttuja. Arvo ei muutu, jos sitä ei muuteta. Lisää...
 

Tapahtumat

Action Timeout
 Tapahtuu väliajoin. Lisää...
 
Action Stopped
 

Yksityiskohtainen selite

Ajastin, joka voidaan asettaa laukaisemaan tapahtumia tietyin väliajoin.

Määrittely tiedoston Timer.cs rivillä 39.

Rakentajien & purkajien dokumentaatio

◆ Timer()

Timer ( )

Alustaa uuden ajastinluokan.

Määrittely tiedoston Timer.cs rivillä 171.

Jäsenfunktioiden dokumentaatio

◆ Limit()

static void Limit ( Action  action,
double  seconds 
)
static

Rajoittaa toimintaa niin, että se voidaan suorittaa vain tietyin väliajoin. Huom. älä käytä delegaatteja tämän metodin kanssa!

Parametrit
actionToiminta
secondsKuinka monta sekuntia täytyy odottaa ennen seuraavaa suoritusta

Määrittely tiedoston Timer.cs rivillä 200.

◆ OnStopped()

void OnStopped ( )
protected

Määrittely tiedoston Timer.cs rivillä 49.

◆ Pause()

void Pause ( )

Pysäyttää ajastimen tallentaen sen tilan.

Määrittely tiedoston Timer.cs rivillä 244.

◆ Reset()

void Reset ( )

Nollaa ajastimen tilan. Myös suorituskerrat nollataan.

Määrittely tiedoston Timer.cs rivillä 268.

◆ SingleShot()

static void SingleShot ( double  seconds,
Action  onTimeout 
)
static

Kutsuu aliohjelmaa onTimeout annetun ajan kuluttua. Ajastin luodaan automaattisesti.

Parametrit
secondsAika sekunteina.
onTimeoutKutsuttava aliohjelma.

Määrittely tiedoston Timer.cs rivillä 186.

◆ Start() [1/2]

void Start ( )

Käynnistää ajastimen.

Määrittely tiedoston Timer.cs rivillä 220.

◆ Start() [2/2]

void Start ( int  times)

Käynnistää ajastimen, rajoittaa suorituskerrat.

Parametrit
timesKuinka monta kertaa tulee ajastintapahtuma.

Määrittely tiedoston Timer.cs rivillä 232.

◆ Stop()

void Stop ( )

Pysäyttää ajastimen ja nollaa sen tilan.

Määrittely tiedoston Timer.cs rivillä 255.

Ominaisuuksien dokumentaatio

◆ CurrentTime

double CurrentTime
getset

Menossa oleva hetki nollasta väliaikaan (Interval).

Määrittely tiedoston Timer.cs rivillä 114.

◆ Enabled

bool Enabled
getset

Ajastin päällä/pois päältä.

Määrittely tiedoston Timer.cs rivillä 78.

◆ IgnorePause

bool IgnorePause
getset

Ajastin ei pysähdy vaikka peli pysäytettäisiin.

Määrittely tiedoston Timer.cs rivillä 93.

◆ Interval

double Interval
getset

Aika sekunneissa, jonka välein TimeOut tapahtuu.

Määrittely tiedoston Timer.cs rivillä 99.

◆ SecondCounter

DoubleMeter SecondCounter
get

Ajastimen käynnistysaika.

Sekuntilaskuri. Voidaan sitoa näyttöihin.

Määrittely tiedoston Timer.cs rivillä 127.

◆ SecondCounterStep

double SecondCounterStep
getset

Kuinka monta sekuntia sekuntilaskuri laskee yhden sekunnin aikana. Oletus on 1. Arvolla 2 laskuri laskee tuplanopeudella, arvolla -1 taaksepäin jne.

Määrittely tiedoston Timer.cs rivillä 133.

◆ Tag

object Tag
getset

Vapaasti asetettava muuttuja. Arvo ei muutu, jos sitä ei muuteta.

Määrittely tiedoston Timer.cs rivillä 162.

◆ Times

IntMeter Times
get

Määrää, kuinka monta kertaa tapahtuma suoritetaan. Kun tapahtumaa on suoritettu tarpeeksi, Enabled saa automaattisesti arvon false, jolloin ajastin pysähtyy. Kun laskuri nollataan, myös Times palautuu oletusarvoonsa. Huomaa, että TimesLimited tulee olla true, että arvo otetaan huomioon.

TimesLimited

Määrittely tiedoston Timer.cs rivillä 143.

◆ TimesLimited

bool TimesLimited
getset

Ajastimen suorituskertojen rajoitus päälle/pois.

Times

Määrittely tiedoston Timer.cs rivillä 150.

Tapahtumien dokumentaatio

◆ Stopped

Action Stopped

Määrittely tiedoston Timer.cs rivillä 48.

◆ Timeout

Action Timeout

Tapahtuu väliajoin.

Määrittely tiedoston Timer.cs rivillä 46.


Dokumentaatio tälle luokalle luotiin seuraavasta tiedostosta: