Game luokkareferenssi

Peliluokka reaaliaikaisille peleille. Lisää...

Luokan Game luokkakaavio

Lista kaikista jäsenistä.

Luokat
struct	PendingObject
Julkiset jäsenfunktiot
	Game ()
	Alustaa uuden peliluokan.
Layer	GetLayer (int layer)
void	Add (GameObject o)
	Lisää olion peliin, kerrokseen 0.
void	Add (Light light)
	Lisää valon peliin. Nykyisellään valoja voi olla ainoastaan yksi kappale.
virtual void	Add (GameObject o, int layer)
	Lisää peliolion peliin, tiettyyn kerrokseen.
void	Remove (GameObject o)
	Poistaa olion pelistä. Jos haluat tuhota olion, kutsu mielummin olion Destroy-metodia.
GameObject	GetObjectAt (Vector position)
	Palauttaa peliolion, joka on annetussa paikassa. Jos paikassa ei ole mitään pelioliota, palautetaan null. Jos olioita on useampia, palautetaan ensin lisätty.
GameObject	GetObjectAt (Vector position, double radius)
	Palauttaa peliolion, joka on annetussa paikassa tietyllä säteellä. Jos paikassa ei ole mitään pelioliota, palautetaan null. Jos olioita on useampia, palautetaan ensin lisätty.
GameObject	GetObjectAt (Vector position, object tag)
	Palauttaa peliolion, joka on annetussa paikassa. Vain annetulla tagilla varustetut oliot huomioidaan. Jos paikassa ei ole mitään pelioliota, palautetaan null. Jos olioita on useampia, palautetaan ensin lisätty.
GameObject	GetObjectAt (Vector position, object tag, double radius)
	Palauttaa peliolion, joka on annetussa paikassa tietyllä säteellä. Vain annetulla tagilla varustetut oliot huomioidaan. Jos paikassa ei ole mitään pelioliota, palautetaan null. Jos olioita on useampia, palautetaan ensin lisätty.
void	Remove (Widget w)
	Poistaa widgetin pelistä. Jos haluat tuhota widgetin, kutsu mielummin sen Destroy-metodia.
void	Add (Widget w)
	Lisää widgetin peliin.
virtual void	ClearAll ()
	Nollaa kaiken.
void	ClearControls ()
	Palauttaa kontrollit alkutilaansa.
void	ClearGameObjects ()
	Tuohoaa ja poistaa pelistä kaikki pelioliot (ml. fysiikkaoliot).
void	ClearLights ()
void	ClearWidgets ()
virtual void	Begin ()
	Tässä alustetaan peli.
virtual void	Continue ()
	Tässä alustetaan peli tombstoning-tilasta.
bool	SetWindowSize (int width, int height)
	Asettaa ikkunan koon.
bool	SetWindowSize (int width, int height, bool fullscreen)
	Asettaa ikkunan koon ja alustaa pelin käyttämään joko ikkunaa tai koko ruutua.
void	Exit ()
	Lopettaa pelin.
void	SaveGame (string tagName)
	Tallentaa pelin.
void	LoadGame (string tagName)
	Lataa pelin.
void	AddFactory< T > (string tag, Factory.FactoryMethod method)
void	RemoveFactory< T > (string tag, Factory.FactoryMethod method)
T	FactoryCreate< T > (string tag)
void	ShowControlHelp ()
	Näyttää kontrollien ohjetekstit.
void	Dispose ()
Staattiset julkiset jäsenfunktiot
static void	AssertInitialized (Action actionMethod)
	Suorittaa aliohjelman kun peli on varmasti alustettu.
static Image	LoadImage (string name)
	Lataa kuvan contentista.
static Image[]	LoadImages (params string[] names)
	Lataa taulukon kuvia contentista.
static SoundEffect	LoadSoundEffect (string name)
	Lataa ääniefektin contentista.
static SoundEffect[]	LoadSoundEffects (params string[] names)
	Lataa taulukon ääniefektejä contentista.
static Font	LoadFont (string name)
	Lataa fontin. Fontin tulee olla lisätty content-hakemistoon.
Julkiset attribuutit
const int	MinLayer = -3
	Pienin mahdollinen kerros.
const int	MaxLayer = 3
	Suurin mahdollinen kerros.
const int	LayerCount = MaxLayer - MinLayer + 1
	Kerrosten määrä.
Suojatut jäsenfunktiot
virtual void	Update (Time time)
	Ajetaan kun pelin tilannetta päivitetään. Päivittämisen voi toteuttaa perityssä luokassa toteuttamalla tämän metodin. Perityn luokan metodissa tulee kutsua kantaluokan metodia.
override void	Initialize ()
	This gets called after the GraphicsDevice has been created. So, this is the place to initialize the resources needed in the game. Except the graphics content, which should be called int LoadContent(), according to the XNA docs.
override void	LoadContent ()
	XNA calls this when graphics resources need to be loaded. Note that this can be called multiple times (whenever the graphics device is reset).
override void	Update (GameTime gameTime)
override void	Draw (GameTime gameTime)
Ominaisuudet
static string	Name [get, set]
	Pelin nimi.
static Game	Instance [get, set]
Camera	Camera [get, set]
	Kamera, joka näyttää ruudulla näkyvän osan kentästä. Kameraa voidaan siirtää, zoomata tai asettaa seuraamaan tiettyä oliota.
bool	DrawPerimeter [get, set]
	Kentän reunat näkyvissä tai pois näkyvistä. Huomaa, että tämä ominaisuus ei vaikuta reunojen törmäyskäsittelyyn.
Color	PerimeterColor [get, set]
	Väri, jolla kentän reunat piirretään.
static ScreenView	Screen [get]
	Näytön dimensiot, eli koko ja reunat.
static Jypeli.Controls.Controls	Controls [get]
	Pelin kontrollit.
ListenContext	ControlContext [get]
	Pelin pääohjainkonteksti.
MessageDisplay	MessageDisplay [get, set]
	Viestinäyttö, johon voi laittaa viestejä.
static FileManager	DataStorage [get]
	Tietovarasto, johon voi tallentaa tiedostoja pidempiaikaisesti. Sopii esimerkiksi pelitilanteen lataamiseen ja tallentamiseen.
bool	AcceptsFocus [get]
	Onko olio valittavissa. Vain valittu (fokusoitu) olio voii kuunnella näppäimistöä ja muita ohjainlaitteita. Peliolio on aina valittavissa.
Keyboard	Keyboard [get]
	Näppäimistö.
Mouse	Mouse [get]
	Hiiri.
TouchPanel	TouchPanel [get]
	Kosketusnäyttö. Vain kännykässä.
PhoneBackButton	PhoneBackButton [get]
GamePad	ControllerOne [get]
	Peliohjain yksi.
GamePad	ControllerTwo [get]
	Peliohjain kaksi.
GamePad	ControllerThree [get]
	Peliohjain kolme.
GamePad	ControllerFour [get]
	Peliohjain neljä.
Accelerometer	Accelerometer [get]
	Kiihtyvyysanturi. Vain kännykässä.
Phone	Phone [get]
	Phone-olio esim. puhelimen tärisyttämiseen.
Level	Level [get]
	Aktiivinen kenttä.
static Time	Time [get]
	Peliaika. Tätä päivitetään noin 30 kertaa sekunnissa.
static Vector	Wind [get, set]
	Tuuli. Vaikuttaa vain efekteihin.
string	Title [get, set]
	Teksti, joka näkyy pelin ikkunassa (jos peli ei ole koko ruudun tilassa).
bool	IsFullScreen [get, set]
	Onko peli kokoruututilassa.
MediaPlayer	MediaPlayer [get, set]
	Mediasoitin.
static new GraphicsDevice	GraphicsDevice [get]
Tapahtumat
static Action	InstanceInitialized
	Tapahtuu kun Game.Instance on alustettu.

---

Yksityiskohtainen selite

Peliluokka reaaliaikaisille peleille.

---

Rakentajien & purkajien dokumentaatio

Game

(

)

[inline]

Alustaa uuden peliluokan.

---

Jäsenfunktioiden dokumentaatio

void Add

(

GameObject

o

)

[inline]

Lisää olion peliin, kerrokseen 0.

void Add

(

Light

light

)

[inline]

Lisää valon peliin. Nykyisellään valoja voi olla ainoastaan yksi kappale.

virtual void Add	(	GameObject	o,
		int	layer
	)		[inline, virtual]

Lisää peliolion peliin, tiettyyn kerrokseen.

Parametrit:

o	Lisättävä olio.
layer	Kerros, luku väliltä [-3, 3].

Uudelleentoteutetaan luokissa PhysicsGame ja TopDownPhysicsGame.

void Add

(

Widget

w

)

[inline]

Lisää widgetin peliin.

static void AssertInitialized

(

Action

actionMethod

)

[inline, static]

Suorittaa aliohjelman kun peli on varmasti alustettu.

Parametrit:

actionMethod

Suoritettava aliohjelma.

virtual void Begin

(

)

[inline, virtual]

Tässä alustetaan peli.

virtual void ClearAll

(

)

[inline, virtual]

Nollaa kaiken.

Uudelleentoteutetaan luokissa PhysicsGame ja TopDownPhysicsGame.

void ClearControls

(

)

[inline]

Palauttaa kontrollit alkutilaansa.

void ClearGameObjects

(

)

[inline]

Tuohoaa ja poistaa pelistä kaikki pelioliot (ml. fysiikkaoliot).

virtual void Continue

(

)

[inline, virtual]

Tässä alustetaan peli tombstoning-tilasta.

void Exit

(

)

[inline]

Lopettaa pelin.

GameObject GetObjectAt	(	Vector	position,
		object	tag
	)		[inline]

Palauttaa peliolion, joka on annetussa paikassa. Vain annetulla tagilla varustetut oliot huomioidaan. Jos paikassa ei ole mitään pelioliota, palautetaan null. Jos olioita on useampia, palautetaan ensin lisätty.

Parametrit:

position	Paikkakoordinaatit
tag	Etsittävän olion tagi.

Palauttaa:

Mahdollinen olio

GameObject GetObjectAt	(	Vector	position,
		object	tag,
		double	radius
	)		[inline]

Palauttaa peliolion, joka on annetussa paikassa tietyllä säteellä. Vain annetulla tagilla varustetut oliot huomioidaan. Jos paikassa ei ole mitään pelioliota, palautetaan null. Jos olioita on useampia, palautetaan ensin lisätty.

Parametrit:

position

Paikkakoordinaatit

Palauttaa:

Mahdollinen olio

GameObject GetObjectAt	(	Vector	position,
		double	radius
	)		[inline]

Palauttaa peliolion, joka on annetussa paikassa tietyllä säteellä. Jos paikassa ei ole mitään pelioliota, palautetaan null. Jos olioita on useampia, palautetaan ensin lisätty.

Parametrit:

position

Paikkakoordinaatit

Palauttaa:

Mahdollinen olio

GameObject GetObjectAt

(

Vector

position

)

[inline]

Palauttaa peliolion, joka on annetussa paikassa. Jos paikassa ei ole mitään pelioliota, palautetaan null. Jos olioita on useampia, palautetaan ensin lisätty.

Parametrit:

position

Paikkakoordinaatit

Palauttaa:

Mahdollinen olio

override void Initialize

(

)

[inline, protected]

This gets called after the GraphicsDevice has been created. So, this is the place to initialize the resources needed in the game. Except the graphics content, which should be called int LoadContent(), according to the XNA docs.

override void LoadContent

(

)

[inline, protected]

XNA calls this when graphics resources need to be loaded. Note that this can be called multiple times (whenever the graphics device is reset).

static Font LoadFont

(

string

name

)

[inline, static]

Lataa fontin. Fontin tulee olla lisätty content-hakemistoon.

Parametrit:

name	Fontin tiedoston nimi, ilman päätettä.

void LoadGame

(

string

tagName

)

[inline]

Lataa pelin.

Parametrit:

tagName

Pelitilanteen nimi.

static Image LoadImage

(

string

name

)

[inline, static]

Lataa kuvan contentista.

Parametrit:

name	Kuvan nimi (ei tarkennetta)

Palauttaa:

Image-olio

static Image [] LoadImages

(

params string[]

names

)

[inline, static]

Lataa taulukon kuvia contentista.

Parametrit:

name	Kuvien nimet ilman tarkennetta pilkuin eroiteltuna

Palauttaa:

Taulukko Image-olioita

static SoundEffect LoadSoundEffect

(

string

name

)

[inline, static]

Lataa ääniefektin contentista.

Parametrit:

name	Äänen nimi (ei tarkennetta)

Palauttaa:

SoundEffect-olio

static SoundEffect [] LoadSoundEffects

(

params string[]

names

)

[inline, static]

Lataa taulukon ääniefektejä contentista.

Parametrit:

names

Äänien nimet ilman tarkennetta pilkuin eroiteltuna

Palauttaa:

Taulukko SoundEffect-olioita

void Remove

(

Widget

w

)

[inline]

Poistaa widgetin pelistä. Jos haluat tuhota widgetin, kutsu mielummin sen Destroy-metodia.

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

void Remove

(

GameObject

o

)

[inline]

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

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

void SaveGame

(

string

tagName

)

[inline]

Tallentaa pelin.

Parametrit:

tagName

Pelitilanteen nimi.

bool SetWindowSize	(	int	width,
		int	height
	)		[inline]

Asettaa ikkunan koon.

Parametrit:

width	Leveys.
height	Korkeus.

bool SetWindowSize	(	int	width,
		int	height,
		bool	fullscreen
	)		[inline]

Asettaa ikkunan koon ja alustaa pelin käyttämään joko ikkunaa tai koko ruutua.

Parametrit:

width	Leveys.
height	Korkeus.
fullscreen	Koko ruutu jos true, muuten ikkuna.

Palauttaa:

void ShowControlHelp

(

)

[inline]

Näyttää kontrollien ohjetekstit.

virtual void Update

(

Time

time

)

[inline, protected, virtual]

Ajetaan kun pelin tilannetta päivitetään. Päivittämisen voi toteuttaa perityssä luokassa toteuttamalla tämän metodin. Perityn luokan metodissa tulee kutsua kantaluokan metodia.

Uudelleentoteutetaan luokissa PhysicsGame ja TopDownPhysicsGame.

---

Jäsendatan dokumentaatio

const int LayerCount = MaxLayer - MinLayer + 1

Kerrosten määrä.

const int MaxLayer = 3

Suurin mahdollinen kerros.

const int MinLayer = -3

Pienin mahdollinen kerros.

---

Ominaisuuksien dokumentaatio

Accelerometer Accelerometer [get]

Kiihtyvyysanturi. Vain kännykässä.

bool AcceptsFocus [get]

Onko olio valittavissa. Vain valittu (fokusoitu) olio voii kuunnella näppäimistöä ja muita ohjainlaitteita. Peliolio on aina valittavissa.

Camera Camera [get, set]

Kamera, joka näyttää ruudulla näkyvän osan kentästä. Kameraa voidaan siirtää, zoomata tai asettaa seuraamaan tiettyä oliota.

ListenContext ControlContext [get]

Pelin pääohjainkonteksti.

Toteuttaa luokan ControlContexted.

GamePad ControllerFour [get]

Peliohjain neljä.

GamePad ControllerOne [get]

Peliohjain yksi.

GamePad ControllerThree [get]

Peliohjain kolme.

GamePad ControllerTwo [get]

Peliohjain kaksi.

Jypeli.Controls.Controls Controls [static, get]

Pelin kontrollit.

FileManager DataStorage [static, get]

Tietovarasto, johon voi tallentaa tiedostoja pidempiaikaisesti. Sopii esimerkiksi pelitilanteen lataamiseen ja tallentamiseen.

bool DrawPerimeter [get, set]

Kentän reunat näkyvissä tai pois näkyvistä. Huomaa, että tämä ominaisuus ei vaikuta reunojen törmäyskäsittelyyn.

bool IsFullScreen [get, set]

Onko peli kokoruututilassa.

Keyboard Keyboard [get]

Näppäimistö.

Level Level [get]

Aktiivinen kenttä.

MediaPlayer MediaPlayer [get, set]

Mediasoitin.

MessageDisplay MessageDisplay [get, set]

Viestinäyttö, johon voi laittaa viestejä.

Viestinäyttö.

Mouse Mouse [get]

Hiiri.

string Name [static, get, set]

Pelin nimi.

Color PerimeterColor [get, set]

Väri, jolla kentän reunat piirretään.

Phone Phone [get]

Phone-olio esim. puhelimen tärisyttämiseen.

ScreenView Screen [static, get]

Näytön dimensiot, eli koko ja reunat.

Time Time [static, get]

Peliaika. Tätä päivitetään noin 30 kertaa sekunnissa.

string Title [get, set]

Teksti, joka näkyy pelin ikkunassa (jos peli ei ole koko ruudun tilassa).

TouchPanel TouchPanel [get]

Kosketusnäyttö. Vain kännykässä.

Vector Wind [static, get, set]

Tuuli. Vaikuttaa vain efekteihin.

---

Tapahtumien dokumentaatio

Action InstanceInitialized [static]

Tapahtuu kun Game.Instance on alustettu.

---

Dokumentaatio tälle luokalle luotiin seuraavasta tiedostosta:

• C:/Users/tero/AppData/Local/Temp/npo_build/Jypeli/Game.cs