Microsoft.Xna.Framework

Class GameComponent

java.lang.Object

Microsoft.Xna.Framework.GameComponent

All Implemented Interfaces:

IGameComponent, IUpdateable, System.IDisposable

Direct Known Subclasses:

DrawableGameComponent, GamerServicesComponent

public class GameComponent
extends java.lang.Object
implements IGameComponent, IUpdateable, System.IDisposable

Base class for all XNA Framework game components.

Author:

Halofreak1990

Field Summary

Fields

Modifier and Type	Field and Description
System.Event<System.EventArgs>	Disposed Raised when the GameComponent is disposed.
System.Event<System.EventArgs>	EnabledChanged Raised when the Enabled property changes.
System.Event<System.EventArgs>	UpdateOrderChanged Raised when the UpdateOrder property changes.

Constructor Summary

Constructors

Constructor and Description
GameComponent(Game game) Initializes a new instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
void	Dispose() Immediately releases the unmanaged resources used by this object.
protected void	Dispose(boolean disposing) Releases the unmanaged resources used by the GameComponent and optionally releases the managed resources.
boolean	getEnabled() Indicates whether GameComponent.Update should be called when Game.Update is called.
Game	getGame() Gets the Game associated with this GameComponent.
int	getUpdateOrder() Indicates the order in which the GameComponent should be updated relative to other GameComponent instances.
void	Initialize()
protected void	OnEnabledChanged(java.lang.Object sender, System.EventArgs e) Called when the Enabled property changes.
protected void	OnUpdateOrderChanged(java.lang.Object sender, System.EventArgs e) Called when the UpdateOrder property changes.
void	setEnabled(boolean value)
void	setUpdateOrder(int value)
void	Update(GameTime gameTime) Called when the GameComponent needs to be updated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Disposed

public final System.Event<System.EventArgs> Disposed

Raised when the GameComponent is disposed.

EnabledChanged

public final System.Event<System.EventArgs> EnabledChanged

Raised when the Enabled property changes.

UpdateOrderChanged

public final System.Event<System.EventArgs> UpdateOrderChanged

Raised when the UpdateOrder property changes.

Constructor Detail

GameComponent

public GameComponent(Game game)

Initializes a new instance of this class.

Parameters:

game - Game that the game component should be attached to.

Method Detail

getEnabled

public boolean getEnabled()

Indicates whether GameComponent.Update should be called when Game.Update is called.

Specified by:

getEnabled in interface IUpdateable

setEnabled

public void setEnabled(boolean value)

getGame

public Game getGame()

Gets the Game associated with this GameComponent.

getUpdateOrder

public int getUpdateOrder()

Indicates the order in which the GameComponent should be updated relative to other GameComponent instances. Lower values are updated first.

Specified by:

getUpdateOrder in interface IUpdateable

setUpdateOrder

public void setUpdateOrder(int value)

Dispose

public void Dispose()

Immediately releases the unmanaged resources used by this object.

Specified by:

Dispose in interface System.IDisposable

Dispose

protected void Dispose(boolean disposing)

Releases the unmanaged resources used by the GameComponent and optionally releases the managed resources.

Parameters:

disposing - true to release both managed and unmanaged resources; false to release only unmanaged resources.

Initialize

public void Initialize()

Specified by:

Initialize in interface IGameComponent

OnEnabledChanged

protected void OnEnabledChanged(java.lang.Object sender,
                    System.EventArgs e)

Called when the Enabled property changes. Raises the EnabledChanged event.

Parameters:

sender - The GameComponent.

e - Arguments to the EnabledChanged event.

OnUpdateOrderChanged

protected void OnUpdateOrderChanged(java.lang.Object sender,
                        System.EventArgs e)

Called when the UpdateOrder property changes. Raises the UpdateOrderChanged event.

Parameters:

sender - The GameComponent.

e - Arguments to the UpdateOrderChanged event.

Update

public void Update(GameTime gameTime)

Called when the GameComponent needs to be updated. Override this method with component-specific update code.

Specified by:

Update in interface IUpdateable

Parameters:

gameTime - Time elapsed since the last call to Update