Jypeli  5
The simple game programming library
GameObjectBase luokkareferenssiabstract

Kaikille peliolioille yhteinen kantaluokka Lisää...

Luokan GameObjectBase luokkakaavio
Tagged Destroyable GameObject GameObject PhysicsStructure Explosion Weapon ParticleSystem HorizontalSpacer PhysicsObject VerticalSpacer Widget Explosion Weapon ParticleSystem HorizontalSpacer PhysicsObject VerticalSpacer Widget

Julkiset jäsenfunktiot

void OnAddedToGame ()
 Kutsutaan kun olio lisätään peliin. Lisää...
 
void OnRemoved ()
 Kutsutaan kun olio poistetaan pelistä. Lisää...
 
virtual void Destroy ()
 Tuhoaa olion. Lisää...
 
abstract void MoveTo (Vector location, double speed, Action doWhenArrived)
 Yrittää siirtyä annettuun paikkaan annetulla nopeudella. Laukaisee annetun aliohjelman, kun paikkaan on päästy. Lisää...
 
void MoveTo (Vector location, double speed)
 Yrittää siirtyä annettuun paikkaan annetulla nopeudella. Lisää...
 
virtual void Update (Time time)
 Peliolion päivitys. Tätä kutsutaan, kun IsUpdated-ominaisuuden arvoksi on asetettu true ja olio on lisätty peliin. IsUpdated Lisää...
 

Julkiset attribuutit

IntPoint PosInLevel
 
List< Object > Data
 

Suojatut jäsenfunktiot

void OnDestroyed ()
 
 GameObjectBase ()
 

Ominaisuudet

Game Game [get]
 Peli. Lisää...
 
Layer Layer [get, set]
 Kerros, jolle peliolio on lisätty. Lisää...
 
bool RotateImage [get, set]
 Pyöritetäänkö kuvaa olion kulman mukana. Lisää...
 
IGameObject Parent [get, set]
 Olio, jonka lapsiolio tämä olio on. Jos null, olio ei ole minkään olion lapsiolio. Lisää...
 
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ä. Lisää...
 
object Tag [get, set]
 Vapaasti asetettava muuttuja. Lisää...
 
virtual Brain Brain [get, set]
 Olion aivot. Ks. Brain Lisää...
 
bool IsDestroyed [get]
 Onko olio tuhottu. Lisää...
 
abstract Vector Size [get, set]
 Olion koko pelimaailmassa. Kertoo olion äärirajat, ei muotoa. Lisää...
 
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. Lisää...
 
abstract Angle Angle [get, set]
 Olion kulma tai rintamasuunta. Nolla = osoittaa oikealle. Lisää...
 
TimeSpan CreationTime [get, protected set]
 Olion luomisaika. Lisää...
 
TimeSpan Lifetime [get]
 Olion elinaika. Lasketaan siitä lähtien, kun olio luodaan. Lisää...
 
TimeSpan MaximumLifetime [get, set]
 Olion suurin mahdollinen elinaika. Kun Lifetime on suurempi kuin tämä, olio kuolee. Lisää...
 
TimeSpan LifetimeLeft [get, set]
 Olion jäljellä oleva elinaika. Lisää...
 
double Width [get, set]
 Olion leveys (X-suunnassa, leveimmässä kohdassa). Lisää...
 
double Height [get, set]
 Olion korkeus (Y-suunnassa, korkeimmassa kohdassa). Lisää...
 
Vector AbsolutePosition [get, set]
 Olion absoluuttinen paikka pelimaailmassa. Jos olio ei ole minkään toisen peliolion lapsiolio, tämä on sama kuin Position. Lisää...
 
Angle AbsoluteAngle [get, set]
 Olion absoluuttinen kulma pelimaailmassa. Jos olio ei ole minkään toisen peliolion lapsiolio, tämä on sama kuin Angle. Lisää...
 
double Left [get, set]
 Olion vasemman reunan x-koordinaatti. Lisää...
 
double Right [get, set]
 Olion oikean reunan x-koordinaatti. Lisää...
 
double Top [get, set]
 Olion yläreunan y-koordinaatti. Lisää...
 
double Bottom [get, set]
 Olion alareunan y-koordinaatti. Lisää...
 
double AbsLeft [get]
 Olion vasemman reunan absoluuttinen x-koordinaatti. Lisää...
 
double AbsRight [get]
 Olion oikean reunan absoluuttinen x-koordinaatti. Lisää...
 
double AbsTop [get]
 Olion yläreunan absoluuttinen y-koordinaatti. Lisää...
 
double AbsBottom [get]
 Olion alareunan absoluuttinen y-koordinaatti. Lisää...
 
double X [get, set]
 Olion paikan X-koordinaatti. Lisää...
 
double Y [get, set]
 Olion paikan Y-koordinaatti. Lisää...
 
Vector UnitX [get]
 Suhteellinen x-suuntavektori lapsiolioille. Varoitus: suhteessa vanhempi-olioon! Jos haluat käyttää suoraan kentässä, käytä AbsoluteUnitX. Lisää...
 
Vector UnitY [get]
 Suhteellinen y-suuntavektori lapsiolioille. Varoitus: suhteessa vanhempi-olioon! Jos haluat käyttää suoraan kentässä, käytä AbsoluteUnitY. Lisää...
 
Vector AbsoluteUnitX [get]
 Suhteellinen x-suuntavektori lapsiolioille. Suhteessa suoraan kentän koordinaatteihin. Lisää...
 
Vector AbsoluteUnitY [get]
 Suhteellinen y-suuntavektori lapsiolioille. Suhteessa suoraan kentän koordinaatteihin. Lisää...
 
abstract Animation Animation [get, set]
 Animaatio. Voi olla null, jolloin piirretään vain väri. Lisää...
 
Image Image [get, set]
 Olion kuva. Voi olla null, jolloin piirretään vain väri. Lisää...
 
- Ominaisuudet inherited from Tagged
object Tag [get, set]
 
- Ominaisuudet inherited from Destroyable
bool IsDestroyed [get]
 

Tapahtumat

Action AddedToGame
 Tapahtuu, kun olio lisätään peliin. Lisää...
 
Action Removed
 Tapahtuu, kun olio poistetaan pelistä (tuhotaan tai ei). Lisää...
 
Action Destroyed
 Tapahtuu, kun olio tuhotaan. Lisää...
 
- Tapahtumat inherited from Destroyable
Action Destroyed
 

Yksityiskohtainen selite

Kaikille peliolioille yhteinen kantaluokka

Määrittely tiedoston GameObjectBase.cs rivillä 12.

Rakentajien & purkajien dokumentaatio

◆ GameObjectBase()

GameObjectBase ( )
protected

Määrittely tiedoston GameObjectBase.cs rivillä 457.

Jäsenfunktioiden dokumentaatio

◆ Destroy()

virtual void Destroy ( )
virtual

Tuhoaa olion.

Toteuttaa luokan Destroyable.

Uudelleentoteutetaan luokissa PhysicsStructure, PlatformCharacter, GameObject, PhysicsObject, Tank ja GameObject.

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

◆ MoveTo() [1/2]

abstract void MoveTo ( Vector  location,
double  speed,
Action  doWhenArrived 
)
pure virtual

Yrittää siirtyä annettuun paikkaan annetulla nopeudella. Laukaisee annetun aliohjelman, 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.
doWhenArrivedAliohjelma, joka ajetaan kun paikkaan on päästy. Voi olla null, jos ei haluta mitään aliohjelmaa.

Toteutettu luokassa PhysicsStructure ja GameObject.

◆ MoveTo() [2/2]

void MoveTo ( Vector  location,
double  speed 
)

Yrittää siirtyä annettuun paikkaan annetulla nopeudella.

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.

Määrittely tiedoston GameObjectBase.cs rivillä 488.

◆ OnAddedToGame()

void OnAddedToGame ( )

Kutsutaan kun olio lisätään peliin.

Määrittely tiedoston GameObjectBase.cs rivillä 122.

◆ OnDestroyed()

void OnDestroyed ( )
protected

Määrittely tiedoston GameObjectBase.cs rivillä 153.

◆ OnRemoved()

void OnRemoved ( )

Kutsutaan kun olio poistetaan pelistä.

Määrittely tiedoston GameObjectBase.cs rivillä 137.

◆ Update()

virtual void Update ( Time  time)
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 PlatformCharacter, PhysicsStructure, PushButton, PlatformCharacter2, GameObject, ParticleSystem, InputBox, Grenade, Explosion, PhysicsObject, Automobile, GameObject, Lightning, Smoke ja Flame.

Määrittely tiedoston GameObjectBase.cs rivillä 500.

Jäsendatan dokumentaatio

◆ Data

List<Object> Data

Määrittely tiedoston GameObjectBase.cs rivillä 19.

◆ PosInLevel

IntPoint PosInLevel

Määrittely tiedoston GameObjectBase.cs rivillä 18.

Ominaisuuksien dokumentaatio

◆ AbsBottom

double AbsBottom
get

Olion alareunan absoluuttinen y-koordinaatti.

Määrittely tiedoston GameObjectBase.cs rivillä 363.

◆ AbsLeft

double AbsLeft
get

Olion vasemman reunan absoluuttinen x-koordinaatti.

Määrittely tiedoston GameObjectBase.cs rivillä 339.

◆ AbsoluteAngle

Angle AbsoluteAngle
getset

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

Määrittely tiedoston GameObjectBase.cs rivillä 283.

◆ AbsolutePosition

Vector AbsolutePosition
getset

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

Määrittely tiedoston GameObjectBase.cs rivillä 260.

◆ AbsoluteUnitX

Vector AbsoluteUnitX
get

Suhteellinen x-suuntavektori lapsiolioille. Suhteessa suoraan kentän koordinaatteihin.

Määrittely tiedoston GameObjectBase.cs rivillä 422.

◆ AbsoluteUnitY

Vector AbsoluteUnitY
get

Suhteellinen y-suuntavektori lapsiolioille. Suhteessa suoraan kentän koordinaatteihin.

Määrittely tiedoston GameObjectBase.cs rivillä 431.

◆ AbsRight

double AbsRight
get

Olion oikean reunan absoluuttinen x-koordinaatti.

Määrittely tiedoston GameObjectBase.cs rivillä 347.

◆ AbsTop

double AbsTop
get

Olion yläreunan absoluuttinen y-koordinaatti.

Määrittely tiedoston GameObjectBase.cs rivillä 355.

◆ Angle

abstract Angle Angle
getset

Olion kulma tai rintamasuunta. Nolla = osoittaa oikealle.

Määrittely tiedoston GameObjectBase.cs rivillä 187.

◆ Animation

abstract Animation Animation
getset

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

Määrittely tiedoston GameObjectBase.cs rivillä 438.

◆ Bottom

double Bottom
getset

Olion alareunan y-koordinaatti.

Määrittely tiedoston GameObjectBase.cs rivillä 330.

◆ Brain

virtual Brain Brain
getset

Olion aivot. Ks. Brain

Määrittely tiedoston GameObjectBase.cs rivillä 98.

◆ CreationTime

TimeSpan CreationTime
getprotected set

Olion luomisaika.

Määrittely tiedoston GameObjectBase.cs rivillä 192.

◆ Game

Game Game
get

Peli.

Määrittely tiedoston GameObjectBase.cs rivillä 26.

◆ Height

double Height
getset

Olion korkeus (Y-suunnassa, korkeimmassa kohdassa).

Määrittely tiedoston GameObjectBase.cs rivillä 249.

◆ Image

Image Image
getset

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

Määrittely tiedoston GameObjectBase.cs rivillä 444.

◆ IsDestroyed

bool IsDestroyed
get

Onko olio tuhottu.

Määrittely tiedoston GameObjectBase.cs rivillä 146.

◆ IsUpdated

bool IsUpdated
getset

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.

Määrittely tiedoston GameObjectBase.cs rivillä 75.

◆ Layer

Layer Layer
getset

Kerros, jolle peliolio on lisätty.

Määrittely tiedoston GameObjectBase.cs rivillä 34.

◆ Left

double Left
getset

Olion vasemman reunan x-koordinaatti.

Määrittely tiedoston GameObjectBase.cs rivillä 303.

◆ Lifetime

TimeSpan Lifetime
get

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

Määrittely tiedoston GameObjectBase.cs rivillä 198.

◆ LifetimeLeft

TimeSpan LifetimeLeft
getset

Olion jäljellä oleva elinaika.

Määrittely tiedoston GameObjectBase.cs rivillä 221.

◆ MaximumLifetime

TimeSpan MaximumLifetime
getset

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

Määrittely tiedoston GameObjectBase.cs rivillä 207.

◆ Parent

IGameObject Parent
getset

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

Määrittely tiedoston GameObjectBase.cs rivillä 59.

◆ Position

virtual Vector Position
getset

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

Määrittely tiedoston GameObjectBase.cs rivillä 181.

◆ Right

double Right
getset

Olion oikean reunan x-koordinaatti.

Määrittely tiedoston GameObjectBase.cs rivillä 312.

◆ RotateImage

bool RotateImage
getset

Pyöritetäänkö kuvaa olion kulman mukana.

Määrittely tiedoston GameObjectBase.cs rivillä 50.

◆ Size

abstract Vector Size
getset

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

Määrittely tiedoston GameObjectBase.cs rivillä 175.

◆ Tag

object Tag
getset

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;

Määrittely tiedoston GameObjectBase.cs rivillä 91.

◆ Top

double Top
getset

Olion yläreunan y-koordinaatti.

Määrittely tiedoston GameObjectBase.cs rivillä 321.

◆ UnitX

Vector UnitX
get

Suhteellinen x-suuntavektori lapsiolioille. Varoitus: suhteessa vanhempi-olioon! Jos haluat käyttää suoraan kentässä, käytä AbsoluteUnitX.

Määrittely tiedoston GameObjectBase.cs rivillä 403.

◆ UnitY

Vector UnitY
get

Suhteellinen y-suuntavektori lapsiolioille. Varoitus: suhteessa vanhempi-olioon! Jos haluat käyttää suoraan kentässä, käytä AbsoluteUnitY.

Määrittely tiedoston GameObjectBase.cs rivillä 413.

◆ Width

double Width
getset

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

Määrittely tiedoston GameObjectBase.cs rivillä 240.

◆ X

double X
getset

Olion paikan X-koordinaatti.

Määrittely tiedoston GameObjectBase.cs rivillä 371.

◆ Y

double Y
getset

Olion paikan Y-koordinaatti.

Määrittely tiedoston GameObjectBase.cs rivillä 386.

Tapahtumien dokumentaatio

◆ AddedToGame

Action AddedToGame

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

Määrittely tiedoston GameObjectBase.cs rivillä 117.

◆ Destroyed

Action Destroyed

Tapahtuu, kun olio tuhotaan.

Määrittely tiedoston GameObjectBase.cs rivillä 151.

◆ Removed

Action Removed

Tapahtuu, kun olio poistetaan pelistä (tuhotaan tai ei).

Määrittely tiedoston GameObjectBase.cs rivillä 132.


Dokumentaatio tälle luokalle luotiin seuraavasta tiedostosta: