A game specific setting which should be serialised to an *.ini file. More...

Inheritance diagram for VerticesEngine.vxGameSettingsAttribute:

Public Member Functions
	vxGameSettingsAttribute (string displayname, string description="", bool isSavedToINI=true, bool isMenuSetting=true, vxGameEnviromentType usage=vxGameEnviromentType.TwoDimensional\|vxGameEnviromentType.ThreeDimensional\|vxGameEnviromentType.VR)
	An engine setting. If isMenuSetting is false, this value will be set and serialised to a corresponding *.ini file.

Public Member Functions inherited from VerticesEngine.vxSettingsAttribute
	vxSettingsAttribute (string displayname, string description="", bool isSavedToINI=true, bool isMenuSetting=false)
	This tags a class as a sandbox item and allows you to explicitly set the asset path.

Additional Inherited Members
Properties inherited from VerticesEngine.vxSettingsAttribute
string	DisplayName `[get]`

string	Description `[get]`

bool	IsSavedToINIFile `[get]`
	Should this setting be saved to an ini file.

bool	IsMenuSetting `[get]`
	Is this setting a menu setting, or should it only show in an ini file.

Detailed Description

A game specific setting which should be serialised to an *.ini file.

Constructor & Destructor Documentation

VerticesEngine.vxGameSettingsAttribute.vxGameSettingsAttribute	(	string	displayname,
		string	description = "",
		bool	isSavedToINI = true,
		bool	isMenuSetting = true,
		vxGameEnviromentType	usage = vxGameEnviromentType::TwoDimensional \| vxGameEnviromentType::ThreeDimensional \| vxGameEnviromentType::VR )

An engine setting. If isMenuSetting is false, this value will be set and serialised to a corresponding *.ini file.

Parameters

displayname	The display name for this setting.
description	The description for this setting.
isSavedToINI	Is this setting saved to it's ini file?
isMenuSetting	Is this setting a menu setting?Note: only Properties are loaded as menu items
usage	Is this setting 2D or 3D specific, or is it used for both?

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

/github/workspace/src/VerticesEngine/src.shared/Attributes/Settings/vxGameSettingsAttribute.cs