VerticesEngine.vxGame Class Reference

This is the foundational class of the entire engine. You will need to create a class which inherit from vxGame and provide the proper overrides for configuration. More...

Inheritance diagram for VerticesEngine.vxGame:

Public Member Functions
virtual string	GetProcessName ()
	Get's the running process name for this game.
bool	IsCmdArgPassed (string cmdarg)
	Has a command line argument been passed through?
void	OnGameStart (vxBaseScene BackgroundScene, vxBaseScene StartMenuScreen)
	Starts the game with the specefied Backgound Scene and Start menu. Override if you want anything more than just the basic 'background screen with menu over top.'.
virtual void	InitDebugCommands ()
virtual void	OnGetModSDK ()
	This method is called when the user clicks on the 'get mod sdk' button.
virtual void	OnUploadMod ()
	This is called when the user wants to upload a mod.
virtual void	OnWorkshopItemOpen (vxIWorkshopItem item)
	This is called when a workshop item is opened.
virtual string	GetAppGuid ()
	An internal guid used for identifying an app.

Public Attributes
GameInitializationStage	InitializationStage = GameInitializationStage.PrimaryStartup
readonly vxGameEnviromentType	GameType
	The type of the game.
readonly vxOrientationType	MainOrientation = vxOrientationType.Landscape
	The main orientation.

Protected Member Functions
virtual string	GetAppID ()
	vxGame ()
	Initializes a new instance of the VerticesEngine.vxGame class.
virtual void	InitOverlays ()
	Initialise any and all overlays. This is often used for adding Admob views in iOS and Android as well as for handling Steam Overlay code.
override void	Initialize ()
override void	LoadContent ()
	Loads graphics content.
virtual string	GetEngineLicense ()
virtual void	InitInAppProducts ()
	Setups the In App Products. This is where you'll want to Add Products and Restore Purchases as well.
virtual void	OnRenderPipelineInitialised (vxRenderPipeline renderPipeline)
	Called when the render pipeline has been initialised. Use this method to register your own vxRenderPasss.
override void	Update (GameTime gameTime)
override void	Draw (GameTime gameTime)
	This is called when the game should draw itself.
override void	OnExiting (object sender, EventArgs args)
override void	UnloadContent ()
override void	Dispose (bool disposing)

Properties
string	Name [get]
	Gets the name of this game.
virtual string	Version [get]
	Gets the game version.
string	AppID [get]
	The App ID which is used by a large number of different platforms.
virtual bool	IsDemo [get]
	Is this game in demo mode?
bool	IsGameUpdated [get, set]
	Gets a value indicating whether this VerticesEngine.vxGame has been updated since last launch Check this whether to show a custom update screen.
bool	HasControlsSettings [get]
	The has controls settings.
bool	HasGraphicsSettings [get]
	The has graphics settings.
bool	HasAudioSettings [get]
	The has audio settings.
bool	HasLanguageSettings [get]
	The has language settings.
bool	HasNetworkCapabilities [get]
	Does this game require the network code to be setup at start.
bool	HasProfileSupport [get]
bool	HasLeaderboards [get]
bool	HasAchievements [get]
bool	HasInAppPurchases [get]
	Does this game have in app purchases.
virtual bool	IsDebugMenuAvailable [get]
	Is the debug menu available?
virtual string	SandboxIconPath [get]
	The Sanbox Icon path.

Detailed Description

This is the foundational class of the entire engine. You will need to create a class which inherit from vxGame and provide the proper overrides for configuration.

You will need to provide a VerticesEngine.vxGameConfigurationsAttribute which provides configuration data for the engine to use your game instance.

[vxGameConfigurations(GameName = "My Game Name", 
GameType = vxGameEnviromentType.ThreeDimensional, MainOrientation = vxOrientationType.Landscape,
ConfigOptions = 
    vxGameConfigFlags.AudioSettings | 
    vxGameConfigFlags.GraphicsSettings | 
    vxGameConfigFlags.ControlsSettings | 
    vxGameConfigFlags.LeaderboardsSupport |
    vxGameConfigFlags.LanguageSettings
    #if <strong>STEAM</strong> || <strong>ITCHIO</strong>
    | vxGameConfigFlags.PlayerProfileSupport 
    #endif
    )]
    public MyGame : vxGame
    {
        ...
    }

Member Function Documentation

GetAppGuid()

virtual string VerticesEngine.vxGame.GetAppGuid ( )

virtual

An internal guid used for identifying an app.

Returns

GetProcessName()

virtual string VerticesEngine.vxGame.GetProcessName ( )

virtual

Get's the running process name for this game.

Returns

InitInAppProducts()

virtual void VerticesEngine.vxGame.InitInAppProducts ( )

protectedvirtual

Setups the In App Products. This is where you'll want to Add Products and Restore Purchases as well.

Below is some code

// Register an available product with the game
vxInAppProductManager.Instance.AddProduct(InAppProductTypes.RemoveAdsItem, new vxInAppProduct("Go Ad Free",
     vxInAppProductType.NonConsumable,
     new vxPlatformString("", "sku_key_remove_ads")));
 
// You'll want to restore purchases after
vxInAppProductManager.Instance.RestorePurchases();

IsCmdArgPassed()

bool VerticesEngine.vxGame.IsCmdArgPassed

(

string

cmdarg

)

Has a command line argument been passed through?

Parameters

cmdarg

Returns

OnRenderPipelineInitialised()

virtual void VerticesEngine.vxGame.OnRenderPipelineInitialised ( vxRenderPipeline renderPipeline )

protectedvirtual

Called when the render pipeline has been initialised. Use this method to register your own vxRenderPasss.

The stock effects are added to the renderer at this step. If you'd like to modify or add your own vxRenderPass you can do so here by calling the following:

// adds a scene blur post processa the end of the render pipeline
 renderer.AddRenderFeature<vxSceneBlurPostProcess>();

Parameters

renderPipeline

OnWorkshopItemOpen()

virtual void VerticesEngine.vxGame.OnWorkshopItemOpen ( vxIWorkshopItem item )

virtual

This is called when a workshop item is opened.

Parameters

item	The workshop item to open

Property Documentation

IsGameUpdated

bool VerticesEngine.vxGame.IsGameUpdated

getset

Gets a value indicating whether this VerticesEngine.vxGame has been updated since last launch Check this whether to show a custom update screen.

Note

This will use the version saved in the Game.ini file.

Returns

true if has game updated; otherwise, false.

Name

string VerticesEngine.vxGame.Name

get

Gets the name of this game.

The name of the game.

Version

virtual string VerticesEngine.vxGame.Version

get

Gets the game version.

Returns

The game version.

---

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

• /github/workspace/src/VerticesEngine/src.shared/vxGame.cs