Main Game class system. More...

Inheritance diagram for SiliconStudio.Paradox.Game:

Public Member Functions
	Game ()
	Initializes a new instance of the Game class. More...

Public Member Functions inherited from SiliconStudio.Paradox.Games.GameBase
void	Exit ()
	Exits the game. More...

void	ResetElapsedTime ()
	Resets the elapsed time counter. More...

void	Run (GameContext gameContext=null)
	Call this method to initialize the game, begin running the game loop, and start processing events for the game. More...

void	SuppressDraw ()
	Prevents calls to Draw until the next Update. More...

void	Tick ()
	Updates the game's clock and calls Update and Draw. More...

Public Member Functions inherited from SiliconStudio.Core.ComponentBase
void	Dispose ()

override string	ToString ()

Protected Member Functions
override void	Destroy ()
	Disposes of object resources. More...

override void	Initialize ()
	Called after the Game and GraphicsDevice are created, but before LoadContent. Reference page contains code sample. More...

override void	EndDraw (bool present)
	Ends the drawing of a frame. This method is preceeded by calls to Draw and BeginDraw. More...

virtual Task	LoadContent ()
	Loads the content. More...

virtual LogListener	GetLogListener ()

Protected Member Functions inherited from SiliconStudio.Paradox.Games.GameBase
	GameBase ()
	Initializes a new instance of the GameBase class. More...

virtual bool	BeginDraw ()
	Starts the drawing of a frame. This method is followed by calls to Draw and EndDraw. More...

virtual void	BeginRun ()
	Called after all components are initialized but before the first update in the game loop. More...

override void	Destroy ()
	Disposes of object resources. More...

virtual void	Draw (GameTime gameTime)
	Reference page contains code sample. More...

virtual void	EndRun ()
	Called after the game loop has stopped running before exiting. More...

virtual void	OnActivated (object sender, EventArgs args)
	Raises the Activated event. Override this method to add code to handle when the game gains focus. More...

virtual void	OnDeactivated (object sender, EventArgs args)
	Raises the Deactivated event. Override this method to add code to handle when the game loses focus. More...

virtual void	OnExiting (object sender, EventArgs args)
	Raises an Exiting event. Override this method to add code to handle when the game is exiting. More...

virtual void	OnWindowCreated ()

virtual bool	ShowMissingRequirementMessage (Exception exception)
	This is used to display an error message if there is no suitable graphics device or sound card. More...

virtual void	UnloadContent ()
	Called when graphics resources need to be unloaded. Override this method to unload any game-specific graphics resources. More...

virtual void	Update (GameTime gameTime)
	Reference page contains links to related conceptual articles. More...

Protected Member Functions inherited from SiliconStudio.Core.ComponentBase
	ComponentBase ()
	Initializes a new instance of the ComponentBase class. More...

	ComponentBase (string name)
	Initializes a new instance of the ComponentBase class. More...

virtual void	OnNameChanged ()
	Called when Name property was changed. More...

Properties
GraphicsDeviceManager	GraphicsDeviceManager `[get, set]`
	Gets the graphics device manager. More...

RenderSystem	RenderSystem `[get, set]`
	Gets the render system. More...

ScriptSystem	Script `[get, set]`
	Gets the script system. More...

InputManager	Input `[get, set]`
	Gets the input manager. More...

EntitySystem	Entities `[get, set]`
	Gets the entity system. More...

EffectSystem	EffectSystem `[get, set]`
	Gets the effect system. More...

AudioSystem	Audio `[get, set]`
	Gets the audio system. More...

UISystem	UI `[get, set]`
	Gets the UI system. More...

SpriteAnimationSystem	SpriteAnimation `[get, set]`
	Gets the sprite animation system. More...

IFontSystem	Font `[get]`
	Gets the font system. More...

ConsoleLogMode	ConsoleLogMode `[get, set]`
	Gets or sets the console log mode. See remarks. More...

LogMessageType	ConsoleLogLevel `[get, set]`
	Gets or sets the default console log level. More...

Properties inherited from SiliconStudio.Paradox.Games.GameBase
GameTime	UpdateTime `[get]`
	Gets the current update time from the start of the game. More...

GameTime	DrawTime `[get]`
	Gets the current draw time from the start of the game. More...

float	DrawInterpolationFactor `[get, set]`
	Gets the draw interpolation factor, which is (UpdateTime - DrawTime) / TargetElapsedTime. If IsFixedTimeStep is false, it will be 0 as UpdateTime and DrawTime will be equal. More...

TimerTick	PlayTime `[get]`
	Gets the play time, can be changed to match to the time of the current rendering scene. More...

AssetManager	Asset `[get, set]`
	Gets or sets the AssetManager. More...

GameSystemCollection	GameSystems `[get, set]`
	Gets the game components registered by this game. More...

GameContext	Context `[get, set]`
	Gets the game context. More...

GraphicsDevice	GraphicsDevice `[get]`
	Gets the graphics device. More...

TimeSpan	InactiveSleepTime `[get, set]`
	Gets or sets the inactive sleep time. More...

bool	IsActive `[get, set]`
	Gets a value indicating whether this instance is active. More...

bool	IsFixedTimeStep `[get, set]`
	Gets or sets a value indicating whether this instance is fixed time step. More...

bool	IsDrawDesynchronized `[get, set]`
	Gets or sets a value indicating whether draw can happen as fast as possible, even when IsFixedTimeStep is set. More...

bool	EarlyExit `[get, set]`

bool	IsMouseVisible `[get, set]`
	Gets or sets a value indicating whether the mouse should be visible. More...

LaunchParameters	LaunchParameters `[get, set]`
	Gets the launch parameters. More...

bool	IsRunning `[get, set]`
	Gets a value indicating whether is running. More...

ServiceRegistry	Services `[get, set]`
	Gets the service container. More...

TimeSpan	TargetElapsedTime `[get, set]`
	Gets or sets the target elapsed time. More...

GameWindow	Window `[get]`
	Gets the abstract window. More...

GameState	State `[get, set]`

Vector3	VirtualResolution `[get, set]`

Properties inherited from SiliconStudio.Core.ComponentBase
long	Id `[get, set]`

string	Name `[get, set]`
	Gets or sets the name of this component. More...

bool	IsDisposed `[get, set]`
	Has the component been disposed or not yet. More...

Properties inherited from SiliconStudio.Core.IComponent
long	Id `[get]`
	Gets the id of this component. More...

string	Name `[get]`
	Gets the name of this component. More...

Properties inherited from SiliconStudio.Core.IReferencable
int	ReferenceCount `[get]`
	Gets the reference count of this instance. More...

Properties inherited from SiliconStudio.Core.ICollectorHolder
ObjectCollector	Collector `[get]`
	Gets the collector. More...

Properties inherited from SiliconStudio.Paradox.Games.IGame
GameTime	UpdateTime `[get]`
	Gets the current game time. More...

GameTime	DrawTime `[get]`
	Gets the current draw time. More...

float	DrawInterpolationFactor `[get]`
	Gets the draw interpolation factor, which is (UpdateTime - DrawTime) / TargetElapsedTime. If IsFixedTimeStep is false, it will be 0 as UpdateTime and DrawTime will be equal. More...

TimerTick	PlayTime `[get]`
	Gets the play time, can be changed to match to the time of the current rendering scene. More...

AssetManager	Asset `[get]`
	Gets or sets the AssetManager. More...

GameSystemCollection	GameSystems `[get]`
	Gets the game components registered by this game. More...

GameContext	Context `[get]`
	Gets the game context. More...

GraphicsDevice	GraphicsDevice `[get]`
	Gets the graphics device. More...

TimeSpan	InactiveSleepTime `[get, set]`
	Gets or sets the inactive sleep time. More...

bool	IsActive `[get]`
	Gets a value indicating whether this instance is active. More...

bool	IsFixedTimeStep `[get, set]`
	Gets or sets a value indicating whether this instance is fixed time step. More...

bool	IsDrawDesynchronized `[get, set]`
	Gets or sets a value indicating whether draw can happen as fast as possible, even when IsFixedTimeStep is set. More...

bool	IsMouseVisible `[get, set]`
	Gets or sets a value indicating whether the mouse should be visible. More...

LaunchParameters	LaunchParameters `[get]`
	Gets the launch parameters. More...

bool	IsRunning `[get]`
	Gets a value indicating whether is running. More...

ServiceRegistry	Services `[get]`
	Gets the service container. More...

TimeSpan	TargetElapsedTime `[get, set]`
	Gets or sets the target elapsed time. More...

GameWindow	Window `[get]`
	Gets the abstract window. More...

GameState	State `[get, set]`
	Gets or sets the state. More...

Properties inherited from SiliconStudio.Paradox.Games.IVirtualResolution
Vector3	VirtualResolution `[get, set]`
	Gets or sets the screen virtual resolution to use for this game. More...

Additional Inherited Members
Public Attributes inherited from SiliconStudio.Core.ComponentBase
PropertyContainer	Tags
	Gets the attached properties to this component. More...

Protected Attributes inherited from SiliconStudio.Paradox.Games.GameBase
readonly ILogger	Log

Events inherited from SiliconStudio.Paradox.Games.GameBase
EventHandler< EventArgs >	Activated
	Occurs when [activated]. More...

EventHandler< EventArgs >	Deactivated
	Occurs when [deactivated]. More...

EventHandler< EventArgs >	Exiting
	Occurs when [exiting]. More...

EventHandler< EventArgs >	WindowCreated
	Occurs when [window created]. More...

EventHandler < GameUnhandledExceptionEventArgs >	UnhandledException

EventHandler< EventArgs >	VirtualResolutionChanged

Events inherited from SiliconStudio.Paradox.Games.IGame
EventHandler< EventArgs >	Activated
	Occurs when [activated]. More...

EventHandler< EventArgs >	Deactivated
	Occurs when [deactivated]. More...

EventHandler< EventArgs >	Exiting
	Occurs when [exiting]. More...

EventHandler< EventArgs >	WindowCreated
	Occurs when [window created]. More...

Events inherited from SiliconStudio.Paradox.Games.IVirtualResolution
EventHandler< EventArgs >	VirtualResolutionChanged
	Occurs when the virtual resolution changed. More...

Detailed Description

Main Game class system.

Definition at line 32 of file Game.cs.

Constructor & Destructor Documentation

SiliconStudio.Paradox.Game.Game ( )

Initializes a new instance of the Game class.

Definition at line 157 of file Game.cs.

Member Function Documentation

override void SiliconStudio.Paradox.Game.Destroy ( )

protectedvirtual

Disposes of object resources.

Reimplemented from SiliconStudio.Core.ComponentBase.

Definition at line 210 of file Game.cs.

override void SiliconStudio.Paradox.Game.EndDraw ( bool present )

protectedvirtual

Ends the drawing of a frame. This method is preceeded by calls to Draw and BeginDraw.

Reimplemented from SiliconStudio.Paradox.Games.GameBase.

Definition at line 285 of file Game.cs.

References SiliconStudio.Paradox.Graphics.Replace.

virtual LogListener SiliconStudio.Paradox.Game.GetLogListener ( )

protectedvirtual

Definition at line 326 of file Game.cs.

override void SiliconStudio.Paradox.Game.Initialize ( )

protectedvirtual

Called after the Game and GraphicsDevice are created, but before LoadContent. Reference page contains code sample.

Reimplemented from SiliconStudio.Paradox.Games.GameBase.

Definition at line 218 of file Game.cs.

References SiliconStudio.Paradox.Graphics.GraphicsDevice.BackBuffer, and SiliconStudio.Paradox.Graphics.RenderTarget.Height.

virtual Task SiliconStudio.Paradox.Game.LoadContent ( )

protectedvirtual

Loads the content.

Reimplemented in SiliconStudio.Paradox.Graphics.Regression.GraphicsTestBase.

Definition at line 316 of file Game.cs.

Property Documentation

AudioSystem SiliconStudio.Paradox.Game.Audio

getset

Gets the audio system.

The audio.

Definition at line 78 of file Game.cs.

LogMessageType SiliconStudio.Paradox.Game.ConsoleLogLevel

getset

Gets or sets the default console log level.

The console log level.

Definition at line 138 of file Game.cs.

ConsoleLogMode SiliconStudio.Paradox.Game.ConsoleLogMode

getset

Gets or sets the console log mode. See remarks.

The console log mode.

Defines how the console will be displayed when running the game. By default, on Windows, It will open only on debug if there are any messages logged.

Definition at line 117 of file Game.cs.

EffectSystem SiliconStudio.Paradox.Game.EffectSystem

getset

Gets the effect system.

The effect system.

Definition at line 72 of file Game.cs.

EntitySystem SiliconStudio.Paradox.Game.Entities

getset

Gets the entity system.

The entity system.

Definition at line 66 of file Game.cs.

IFontSystem SiliconStudio.Paradox.Game.Font

get

Gets the font system.

The font system.

Exceptions

System.InvalidOperationException The font system is not initialized yet

Definition at line 98 of file Game.cs.

GraphicsDeviceManager SiliconStudio.Paradox.Game.GraphicsDeviceManager

getset

Gets the graphics device manager.

The graphics device manager.

Definition at line 42 of file Game.cs.

InputManager SiliconStudio.Paradox.Game.Input

getset

Gets the input manager.

The input.

Definition at line 60 of file Game.cs.

RenderSystem SiliconStudio.Paradox.Game.RenderSystem

getset

Gets the render system.

The render system.

Definition at line 48 of file Game.cs.

ScriptSystem SiliconStudio.Paradox.Game.Script

getset

Gets the script system.

The script.

Definition at line 54 of file Game.cs.

SpriteAnimationSystem SiliconStudio.Paradox.Game.SpriteAnimation

getset

Gets the sprite animation system.

The sprite animation system.

Definition at line 90 of file Game.cs.

UISystem SiliconStudio.Paradox.Game.UI

getset

Gets the UI system.

The UI.

Definition at line 84 of file Game.cs.

The documentation for this class was generated from the following file:

D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/engine/SiliconStudio.Paradox.Engine/Game.cs

Public Member Functions

Protected Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation