VerticesEngine.Utilities.vxIO Class Reference

Collection of static utility methods. More...

Public Member Functions
delegate void	ProgressDelegate (string sMessage)

Static Public Member Functions
static void	EnsureDirExists (string path)
static bool	IsPermissionsRequestRequired ()
static vxMessageBox	OnShowPermissionRequestMessage ()
static void	RequestPermissions ()
static void	ClearTempDirectory ()
	Clears the temp directory.
static StreamReader	LoadTextFile (string path)
static T	LoadJson< T > (string path)
	Loads a content file json.
static void	SaveJson (string path, object obj, bool IsIndented=true)
	Saves a given object to json.
static Texture2D	LoadImage (string path, bool isContentImg=true)
	Load an Image from it's path. this is not for *.xnb files. Note this loads from the content directory.
static void	CompressFile (string sDir, string sRelativePath, GZipStream zipStream)
static bool	DecompressFile (string sDir, GZipStream zipStream, ProgressDelegate progress)
static void	CompressDirectory (string sInDir, string sOutFile, ProgressDelegate progress)
static void	DecompressToDirectory (string sCompressedFile, string sDir, ProgressDelegate progress, bool IsContentFile=true)
static void	CopyDirectory (string SourcePath, string DestinationPath, string filePattern)
	Copies a folder over to another.

Properties
static string	LogDirectory [get]
	Gets the log directory.
static string	PathToRoot [get]
	The path to the game data folder. Android this specifies the app specific directory under '/storage/emulated/0/Android/data/com.yourcompany.yourappid/files'. This will be deleted if your app is ever removed. If there are settings or files which you want to keep then you should save them to the External Storage Directory. You can do so by calling:
static string	PathToRootExternal [get]
static string	PathToSettings [get]
	The path to settings.
static string	PathToProfiles [get]
	The path to profile saved data.
static string	PathToSandbox [get]
	The path to sandbox.
static string	PathToTempFolder [get]
	The path to temp folder.
static string	PathToImportFolder [get]
static string	PathToCacheFolder [get]
	Cache folder which can be cleared sometimes.
static string	PathToLocalizationFiles [get]
	The path to localization files.
static string	PathToWorkshopFolder [get]
static string	PathToMods [get]
static string	ContentRootPath [get]

Detailed Description

Collection of static utility methods.

Member Function Documentation

CopyDirectory()

static void VerticesEngine.Utilities.vxIO.CopyDirectory ( string SourcePath, string DestinationPath, string filePattern )

static

Copies a folder over to another.

Parameters

SourcePath
DestinationPath
filePattern

LoadImage()

static Texture2D VerticesEngine.Utilities.vxIO.LoadImage ( string path, bool isContentImg = true )

static

Load an Image from it's path. this is not for *.xnb files. Note this loads from the content directory.

Parameters

path

Returns

LoadJson< T >()

static T VerticesEngine.Utilities.vxIO.LoadJson< T > ( string path )

static

Loads a content file json.

Template Parameters

T

Parameters

path

Returns

SaveJson()

static void VerticesEngine.Utilities.vxIO.SaveJson ( string path, object obj, bool IsIndented = true )

static

Saves a given object to json.

Parameters

path	The path to save too
obj	The object to serialise

Property Documentation

LogDirectory

string VerticesEngine.Utilities.vxIO.LogDirectory

staticget

Gets the log directory.

The log directory.

PathToRoot

string VerticesEngine.Utilities.vxIO.PathToRoot

staticget

The path to the game data folder. Android this specifies the app specific directory under '/storage/emulated/0/Android/data/com.yourcompany.yourappid/files'. This will be deleted if your app is ever removed. If there are settings or files which you want to keep then you should save them to the External Storage Directory. You can do so by calling:

string externalPath = Path.Combine(Android.OS.Environment.ExternalStorageDirectory.Path, virtexrootfolder , GameName)

---

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

• /github/workspace/src/VerticesEngine/src.shared/Utilities/vxIO.cs