PowerUI.CacheProtocol Class Reference

Detailed Description

This protocol is used if you have a Texture, RenderTexture or SPA object and want it on the screen. You must add the object to the ImageCache with a name, then use cache://thename to access it.

Inheritance diagram for PowerUI.CacheProtocol:
PowerUI.FileProtocol

Public Member Functions

override string[] GetNames ()
 Returns all protocol names:// that can be used for this protocol. More...
 
override void OnGetGraphic (ImagePackage package)
 Attempts to get a graphic from the given location using this protocol. More...
 
- Public Member Functions inherited from PowerUI.FileProtocol
virtual CachedContent GetCached (Dom.Location location)
 Attempts to get cached data for the given location. Used to enable caching (off by default). More...
 
virtual DomainData GetDomain (Dom.Location location)
 Gets the domain data for the given location. More...
 
virtual string GetRelative (Dom.Location location)
 Gets the relative path for the given location. More...
 
CachedContent GetCached (Dom.Location location, bool create)
 Attempts to get cached data for the given location. More...
 
virtual string ContentType (Location path)
 Used to determine the content type for the file from the given path. More...
 
virtual bool FullAccess (Location path)
 Does the item at the given location have full access to the code security domain? Used by Nitro. If it does not have full access, the Nitro security domain is asked about the path instead. If you're unsure, leave this false! If your game uses simple web browsing, this essentially stops somebody writing dangerous Nitro on a remote webpage and directing your game at it. More...
 
void OnGetData (ContentPackage package)
 Gets binary data, checking the cache first. More...
 
virtual void OnGetDataNow (ContentPackage package)
 Get generic binary at the given path using this protocol. Used for e.g. fonts. Once it's been retrieved, this must call package.GotData(theText) internally. Note that you can call this directly to avoid all cache checking. More...
 
virtual void OnGetAudio (AudioPackage package)
 Get the file at the given path as any supported audio format. Once it's been retrieved, this must call package.GotAudio(theObject) internally. More...
 
virtual void OnFollowLink (HtmlElement linkElement, Location path)
 The user clicked on the given link which points to the given path. More...
 

Additional Inherited Members

- Static Public Attributes inherited from PowerUI.FileProtocol
static InternalEventHandler OnRequestStarted
 An event called when any request is started. Useful for debugging networking (and is used by the network inspector). More...
 

Member Function Documentation

override string [] PowerUI.CacheProtocol.GetNames ( )
inlinevirtual

Returns all protocol names:// that can be used for this protocol.

Reimplemented from PowerUI.FileProtocol.

override void PowerUI.CacheProtocol.OnGetGraphic ( ImagePackage  package)
inlinevirtual

Attempts to get a graphic from the given location using this protocol.

Parameters
packageThe image request. GotGraphic must be called on this when the protocol is done.
pathThe location of the file to retrieve using this protocol.

Reimplemented from PowerUI.FileProtocol.