VerticesEngine.vxEngine Class Reference

The vxEngine is a component which manages one or more vxGameBaseScreen instances. It maintains a stack of screens, calls their Update and Draw methods at the appropriate times, and automatically routes input to the topmost active screen. More...

Inheritance diagram for VerticesEngine.vxEngine:

Public Member Functions
string	CMDLineArgsToString ()
	Gets the CMDL ine arguments as string.
void	Dispose ()
T	GetCurrentScene< T > ()
	Returns the current scene.
void	DrawDebugFlag ()
void	DrawVersionInfo (Color color, float alpha)
	Draws the version info in the corner of the screen.

Static Public Member Functions
static void	ConfigureProcess ()
	Configures the process for this game. This needs to be called from your Program.cs file and before the vxGame is instantiated.
static T	AddSystem< T > ()
	Add a subsystem of type vxIEngineSubSystem. It must be scene subsystem.
static T	GetSubSystem< T > ()
	Get the subsystem of type T
static bool	TryGetSubSystem< T > (out T subSystem)
	Tries to get the subsystem of type T
static void	OnCrash (Exception ex)
	Hook this up when the game crashes to catch issues.

Public Attributes
readonly string[]	CMDLineArgs
	The cmd line arguments.
vxGameplaySceneBase	CurrentScene
	The Current Gameplay Screen that is being run.
bool	Pause = false
bool	AlwaysRun = true

Static Public Attributes
static bool	IsBatchMode = false
	Is this running in batch mode, i.e. will there be no user interaction?

Properties
static vxEngine	Instance [get]
	Returns the instance of the Vertices Engine.
static vxGame	Game [get]
	The reference to the current game that is being run by the engine.
static vxBuildType	BuildType [get]
	Gets the type of the build config. This is set internally but can be changed by launching with specific launch options.
static vxPlatformOS	PlatformOS [get]
	Gets the OS type of the platform.
static vxPlatformHardwareType	PlatformType [get]
	Specifies whether this game is running on Desktop, Console, Mobile or Web.
static vxPlatformType	ReleasePlatformType [get]
	Which platform is this version meant to released on, i.e. Steam, ItchIO, Android etc...
static vxGraphicalBackend	GraphicalBackend [get]
	Gets the type graphical backend that's being used (i.e. OpenGL, DirectX etc...)
static string	EngineVersion [get]
	Gets the Vertices Engine version. Note this is different than the game version.

Detailed Description

The vxEngine is a component which manages one or more vxGameBaseScreen instances. It maintains a stack of screens, calls their Update and Draw methods at the appropriate times, and automatically routes input to the topmost active screen.

Member Function Documentation

AddSystem< T >()

static T VerticesEngine.vxEngine.AddSystem< T > ( )

static

Add a subsystem of type vxIEngineSubSystem. It must be scene subsystem.

Template Parameters

T

Returns

Exceptions

Exception

Type Constraints

T

:

vxIEngineSubSystem

CMDLineArgsToString()

string VerticesEngine.vxEngine.CMDLineArgsToString

(

)

Gets the CMDL ine arguments as string.

Returns

The CMDL ine arguments as string.

DrawVersionInfo()

void VerticesEngine.vxEngine.DrawVersionInfo	(	Color	color,
		float	alpha )

Draws the version info in the corner of the screen.

Parameters

color	Color to draw the text with.
alpha	Alpha to draw with, usually the TransitionAlpha value for the current screen.

GetCurrentScene< T >()

T VerticesEngine.vxEngine.GetCurrentScene< T >

(

)

Returns the current scene.

Template Parameters

T

Returns

Type Constraints

T

:

vxGameplaySceneBase

GetSubSystem< T >()

static T VerticesEngine.vxEngine.GetSubSystem< T > ( )

static

Get the subsystem of type T

Template Parameters

T

Returns

Type Constraints

T

:

vxIEngineSubSystem

OnCrash()

static void VerticesEngine.vxEngine.OnCrash ( Exception ex )

static

Hook this up when the game crashes to catch issues.

Parameters

ex

TryGetSubSystem< T >()

static bool VerticesEngine.vxEngine.TryGetSubSystem< T > ( out T subSystem )

static

Tries to get the subsystem of type T

Template Parameters

T

Parameters

subSystem

Returns

Type Constraints

T

:

vxIEngineSubSystem

Property Documentation

BuildType

vxBuildType VerticesEngine.vxEngine.BuildType

staticget

Gets the type of the build config. This is set internally but can be changed by launching with specific launch options.

The type of the build config.

EngineVersion

string VerticesEngine.vxEngine.EngineVersion

staticget

Gets the Vertices Engine version. Note this is different than the game version.

The vxEngine version.

PlatformOS

vxPlatformOS VerticesEngine.vxEngine.PlatformOS

staticget

Gets the OS type of the platform.

The type of the platorm.

---

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

• /github/workspace/src/VerticesEngine/src.shared/vxEngine.cs
• /github/workspace/src/VerticesEngine/src.shared/vxEngine.Debug.cs