Jypeli 4
The simple game programming library
Julkiset jäsenfunktiot | Suojatut jäsenfunktiot | Suojellut attribuutit | Ominaisuudet | Tapahtumat
GameObject luokkareferenssi

Pelialueella liikkuva olio. Käytä fysiikkapeleissä PhysicsObject-olioita. Lisää...

Luokan GameObject luokkakaavio
Destroyable Tagged Explosion Weapon ParticleSystem PhysicsObject AssaultRifle Cannon LaserGun PlasmaCannon ExplosionSystem Flame Smoke Automobile Projectile Tank PlatformCharacter PlatformCharacter2

Lista kaikista jäsenistä.

Julkiset jäsenfunktiot

virtual void Destroy ()
 Tuhoaa olion. Tuhottu olio poistuu pelistä.
 GameObject (double width, double height)
 Alustaa uuden peliolion.
 GameObject (Image image)
 Alustaa uuden peliolion. Kappaleen koko ja ulkonäkö ladataan parametrina annetusta kuvasta.
 GameObject (double width, double height, Shape shape)
 Alustaa uuden peliolion.
object Clone ()
 Tekee oliosta kopion.
bool IsInside (Vector point)
 Onko piste p tämän olion sisäpuolella.
void Add (GameObject childObject)
 Lisää annetun peliolion tämän olion lapseksi. Lapsiolio liikkuu tämän olion mukana, ja sen paikka ja koko ilmaistaan suhteessa tähän olioon.
void Remove (GameObject childObject)
 Poistaa lapsiolion. Jos haluat tuhota olion, kutsu mielummin olion Destroy-metodia.
virtual void Update (Time time)
virtual void Move (Vector movement)
 Siirtää oliota.
virtual void MoveTo (Vector location, double speed)
 Yrittää siirtyä annettuun paikkaan annetulla nopeudella. Laukaisee tapahtuman ArrivedAt, kun paikkaan on päästy.

Suojatut jäsenfunktiot

void OnArrivedAt (Vector location)
virtual void MoveToTarget ()

Suojellut attribuutit

Timer moveTimer = null
Vector moveTarget = null
double moveSpeed

Ominaisuudet

bool IsUpdated [get, set]
 Tarvitseeko olio päivittämistä. Kun perit oman luokkasi tästä luokasta, aseta tämä arvoon true, kun luokan olio tarvitsee päivittämistä.
GameObject Parent [get, set]
 Olio, jonka lapsiolio tämä olio on. Jos null, olio ei ole minkään olion lapsiolio.
object Tag [get, set]
 Vapaasti asetettava muuttuja.
bool IsVisible [get, set]
 Piirretäänkö oliota ruudulle.
virtual Brain Brain [get, set]
 Olion aivot. Ks. Brain
TimeSpan CreationTime [get, set]
 Olion luomisaika.
TimeSpan Lifetime [get]
 Olion elinaika. Lasketaan siitä lähtien, kun olio luodaan.
TimeSpan MaximumLifetime [get, set]
 Olion suurin mahdollinen elinaika. Kun Lifetime on suurempi kuin tämä, olio kuolee.
virtual Vector Size [get, set]
 Olion koko pelimaailmassa. Kertoo olion äärirajat, ei muotoa.
double Width [get, set]
 Olion leveys (X-suunnassa, leveimmässä kohdassa).
double Height [get, set]
 Olion korkeus (Y-suunnassa, korkeimmassa kohdassa).
virtual Vector Position [get, set]
 Olion paikka. Jos olio on jonkun toisen peliolion lapsi, paikka on suhteessa tämän vanhempaan (Parent). Muuten paikka on paikka pelimaailmassa.
Vector AbsolutePosition [get]
 Olion absoluuttinen paikka pelimaailmassa. Jos olio ei ole minkään toisen peliolion lapsiolio, tämä on sama kuin Position.
Angle AbsoluteAngle [get]
 Olion absoluuttinen kulma pelimaailmassa. Jos olio ei ole minkään toisen peliolion lapsiolio, tämä on sama kuin Angle.
double Left [get, set]
 Olion vasemman reunan x-koordinaatti.
double Right [get, set]
 Olion oikean reunan x-koordinaatti.
double Top [get, set]
 Olion yläreunan y-koordinaatti.
double Bottom [get, set]
 Olion alareunan y-koordinaatti.
double X [get, set]
 Olion paikan X-koordinaatti.
double Y [get, set]
 Olion paikan Y-koordinaatti.
virtual Angle Angle [get, set]
 Olion kulma tai rintamasuunta. Nolla = osoittaa oikealle.
Animation Animation [get, set]
 Animaatio. Voi olla null, jolloin piirretään vain väri.
Image Image [get, set]
 Olion kuva. Voi olla null, jolloin piirretään vain väri.
Vector TextureWrapSize [get, set]
 Määrittää kuinka moneen kertaan kuva piirretään. Esimerkiksi (3.0, 2.0) piirtää kuvan 3 kertaa vaakasuunnassa ja 2 kertaa pystysuunnassa.
Color Color [get, set]
 Väri, jonka värisenä olio piirretään, jos tekstuuria ei ole määritelty.
bool TextureFillsShape [get, set]
 Jos true, kuva piirretään niin, ettei se mene olion muodon ääriviivojen yli. Toisin sanoen kuva piirretään tarkasti vain muodon määrittämälle alueelle.
virtual Shape Shape [get, set]
 Olion muoto.
Game Game [get]
 Peli, johon olio on lisätty. null, jos oliota ei ole lisätty peliin.
bool IsAddedToGame [get, set]
 Onko olio lisätty peliin.
bool IsDestroyed [get]
 Onko olio tuhottu.

Tapahtumat

Action AddedToGame
 Tapahtuu, kun olio lisätään peliin.
Action< GameObject, VectorArrivedAt
 Tapahtuu, kun on saavuttu haluttuun paikkaan (MoveTo-metodi)
Action Destroyed
 Tapahtuu, kun olio tuhotaan.

Yksityiskohtainen selite

Pelialueella liikkuva olio. Käytä fysiikkapeleissä PhysicsObject-olioita.


Rakentajien & purkajien dokumentaatio

GameObject ( double  width,
double  height 
) [inline]

Alustaa uuden peliolion.

Parametrit:
widthLeveys.
heightKorkeus.
GameObject ( Image  image) [inline]

Alustaa uuden peliolion. Kappaleen koko ja ulkonäkö ladataan parametrina annetusta kuvasta.

Parametrit:
imageKuva
GameObject ( double  width,
double  height,
Shape  shape 
) [inline]

Alustaa uuden peliolion.

Parametrit:
widthLeveys.
heightKorkeus.
shapeMuoto.

Jäsenfunktioiden dokumentaatio

void Add ( GameObject  childObject) [inline]

Lisää annetun peliolion tämän olion lapseksi. Lapsiolio liikkuu tämän olion mukana, ja sen paikka ja koko ilmaistaan suhteessa tähän olioon.

PhysicsObject-tyyppisiä olioita ei voi lisätä lapsiolioksi.

object Clone ( ) [inline]

Tekee oliosta kopion.

Palauttaa:
Uusi GameObject-olio samoilla arvoilla.
virtual void Destroy ( ) [inline, virtual]

Tuhoaa olion. Tuhottu olio poistuu pelistä.

Toteuttaa luokan Destroyable.

Uudelleentoteutetaan luokissa PlatformCharacter, Tank ja PhysicsObject.

bool IsInside ( Vector  point) [inline]

Onko piste p tämän olion sisäpuolella.

virtual void Move ( Vector  movement) [inline, virtual]

Siirtää oliota.

Parametrit:
movementVektori, joka määrittää kuinka paljon siirretään.

Uudelleentoteutetaan luokissa PlatformCharacter, PlatformCharacter2 ja PhysicsObject.

virtual void MoveTo ( Vector  location,
double  speed 
) [inline, virtual]

Yrittää siirtyä annettuun paikkaan annetulla nopeudella. Laukaisee tapahtuman ArrivedAt, kun paikkaan on päästy.

Parametrit:
locationPaikka johon siirrytään
speedNopeus (paikkayksikköä sekunnissa) jolla liikutaan. Nopeus on maksiminopeus. Jos välissä on hitaampaa maastoa tai esteitä, liikkumisnopeus voi olla alle sen.
void Remove ( GameObject  childObject) [inline]

Poistaa lapsiolion. Jos haluat tuhota olion, kutsu mielummin olion Destroy-metodia.

Oliota ei poisteta välittömästi, vaan viimeistään seuraavan päivityksen jälkeen.

virtual void Update ( Time  time) [inline, virtual]

Peliolion päivitys. Tätä kutsutaan, kun IsUpdated-ominaisuuden arvoksi on asetettu true ja olio on lisätty peliin. IsUpdated

Parametrit:
timePeliaika.

Uudelleentoteutetaan luokissa Automobile, Explosion, PlatformCharacter, PlatformCharacter2, Grenade, Flame, ParticleSystem, Smoke ja PhysicsObject.


Ominaisuuksien dokumentaatio

Angle AbsoluteAngle [get]

Olion absoluuttinen kulma pelimaailmassa. Jos olio ei ole minkään toisen peliolion lapsiolio, tämä on sama kuin Angle.

Vector AbsolutePosition [get]

Olion absoluuttinen paikka pelimaailmassa. Jos olio ei ole minkään toisen peliolion lapsiolio, tämä on sama kuin Position.

virtual Angle Angle [get, set]

Olion kulma tai rintamasuunta. Nolla = osoittaa oikealle.

Uudelleentoteutetaan luokassa PhysicsObject.

Animation Animation [get, set]

Animaatio. Voi olla null, jolloin piirretään vain väri.

double Bottom [get, set]

Olion alareunan y-koordinaatti.

virtual Brain Brain [get, set]

Olion aivot. Ks. Brain

Uudelleentoteutetaan luokassa PhysicsObject.

Color Color [get, set]

Väri, jonka värisenä olio piirretään, jos tekstuuria ei ole määritelty.

TimeSpan CreationTime [get, set]

Olion luomisaika.

Game Game [get]

Peli, johon olio on lisätty. null, jos oliota ei ole lisätty peliin.

double Height [get, set]

Olion korkeus (Y-suunnassa, korkeimmassa kohdassa).

Image Image [get, set]

Olion kuva. Voi olla null, jolloin piirretään vain väri.

bool IsAddedToGame [get, set]

Onko olio lisätty peliin.

bool IsDestroyed [get]

Onko olio tuhottu.

Toteuttaa luokan Destroyable.

bool IsUpdated [get, set, protected]

Tarvitseeko olio päivittämistä. Kun perit oman luokkasi tästä luokasta, aseta tämä arvoon true, kun luokan olio tarvitsee päivittämistä.

Jos tämä asetetaan arvoon

true

, olion Update-metodia kutsutaan säännöllisesti (noin 25 kertaa sekunnissa) sen jälkeen, kun olio on lisätty peliin.

Tämä ei ole oletuksena true, jotta vältetään pelin hidastuminen turhien päivityskutsujen takia. Jos esimerkiksi kenttä koostuu tuhansista seinäpalikoista, näiden kaikkien päivittäminen koko ajan olisi turhaa.

bool IsVisible [get, set]

Piirretäänkö oliota ruudulle.

double Left [get, set]

Olion vasemman reunan x-koordinaatti.

TimeSpan Lifetime [get]

Olion elinaika. Lasketaan siitä lähtien, kun olio luodaan.

TimeSpan MaximumLifetime [get, set]

Olion suurin mahdollinen elinaika. Kun Lifetime on suurempi kuin tämä, olio kuolee.

GameObject Parent [get, set]

Olio, jonka lapsiolio tämä olio on. Jos null, olio ei ole minkään olion lapsiolio.

virtual Vector Position [get, set]

Olion paikka. Jos olio on jonkun toisen peliolion lapsi, paikka on suhteessa tämän vanhempaan (Parent). Muuten paikka on paikka pelimaailmassa.

Uudelleentoteutetaan luokassa PhysicsObject.

double Right [get, set]

Olion oikean reunan x-koordinaatti.

virtual Shape Shape [get, set]

Olion muoto.

Uudelleentoteutetaan luokassa PhysicsObject.

virtual Vector Size [get, set]

Olion koko pelimaailmassa. Kertoo olion äärirajat, ei muotoa.

Uudelleentoteutetaan luokissa PlatformCharacter, Tank ja PhysicsObject.

object Tag [get, set]

Vapaasti asetettava muuttuja.

Tagia voi käyttää vaikkapa olion keräämien pisteiden tallettamiseen:

            hahmo.Tag = 5;

Kun luet pisteitä, täytyy arvo muuntaa oikean tyyppiseksi kertomalla tyypin nimi suluissa:

            int pisteitä = (int)hahmo.Tag;

Toteuttaa luokan Tagged.

bool TextureFillsShape [get, set]

Jos true, kuva piirretään niin, ettei se mene olion muodon ääriviivojen yli. Toisin sanoen kuva piirretään tarkasti vain muodon määrittämälle alueelle.

Tämän asettaminen tekee olion piirtämisestä hitaamman. Jos muoto on yksinkertainen, harkitse voisiko kuvan piirtää niin, että läpinäkyvyyttä käyttämällä saadaan kuvasta halutun muotoinen.

Vector TextureWrapSize [get, set]

Määrittää kuinka moneen kertaan kuva piirretään. Esimerkiksi (3.0, 2.0) piirtää kuvan 3 kertaa vaakasuunnassa ja 2 kertaa pystysuunnassa.

double Top [get, set]

Olion yläreunan y-koordinaatti.

double Width [get, set]

Olion leveys (X-suunnassa, leveimmässä kohdassa).

double X [get, set]

Olion paikan X-koordinaatti.

double Y [get, set]

Olion paikan Y-koordinaatti.


Tapahtumien dokumentaatio

Action AddedToGame

Tapahtuu, kun olio lisätään peliin.

Action<GameObject, Vector> ArrivedAt

Tapahtuu, kun on saavuttu haluttuun paikkaan (MoveTo-metodi)

Action Destroyed

Tapahtuu, kun olio tuhotaan.

Toteuttaa luokan Destroyable.


Dokumentaatio tälle luokalle luotiin seuraavasta tiedostosta:
 Kaikki Luokat Nimiavaruudet Funktiot Muuttujat Luettelotyypit Ominaisuudet Tapahtumat