PowerUI.FileProtocols Class Reference

Detailed Description

Manages all current file protocols://. File protocols such as http, cache, dynamic, scene etc enable PowerUI to load files in custom ways - for example if your game uses a specialised cdn, you may easily implement it as a new FileProtocol.

Static Public Member Functions
static void	Setup ()
	Sets up all available file protocols by scanning around for all classes which inherit from the FileProtocol type. Called internally by UI.Setup. More...
static void	Add (FileProtocol protocol)
	Adds the given file protocol to the global set for use. Note that you do not need to call this manually; Just deriving from FileProtocol is all that is required. More...
static FileProtocol	Get (string protocol)
	Gets a protocol by the given name. More...

Static Public Attributes
static string	UnrecognisedProtocolHandler ="http"
	Http is used for any unrecognised protocols. This is useful with e.g. links to apps, such as ms-windows-store:// When a link like that occurs, and it's not overriden with a custom handler, http will deal with it (and subsequently pop it up externally). More...
static Dictionary< string, FileProtocol >	Protocols
	The set of available protocols. Use get to access. More...

Member Function Documentation

static void PowerUI.FileProtocols.Add ( FileProtocol  protocol)

inlinestatic

Adds the given file protocol to the global set for use. Note that you do not need to call this manually; Just deriving from FileProtocol is all that is required.

Parameters

protocol

The new protocol to add.

static FileProtocol PowerUI.FileProtocols.Get ( string  protocol)

inlinestatic

Gets a protocol by the given name.

Parameters

protocol

The name of the protocol, e.g. "http".

Returns

A FileProtocol if found; null otherwise.

static void PowerUI.FileProtocols.Setup ( )

inlinestatic

Sets up all available file protocols by scanning around for all classes which inherit from the FileProtocol type. Called internally by UI.Setup.

Member Data Documentation

Dictionary<string,FileProtocol> PowerUI.FileProtocols.Protocols

static

The set of available protocols. Use get to access.

string PowerUI.FileProtocols.UnrecognisedProtocolHandler ="http"

static

Http is used for any unrecognised protocols. This is useful with e.g. links to apps, such as ms-windows-store:// When a link like that occurs, and it's not overriden with a custom handler, http will deal with it (and subsequently pop it up externally).