Custom schema - Revision history

185.216.49.30 at 15:04, 30 October 2017

2017-10-30T15:04:07Z

Bablakeluke at 16:45, 18 March 2017

2017-03-18T16:45:52Z

151.229.186.156 at 09:31, 14 January 2017

2017-01-14T09:31:54Z

151.229.186.156 at 20:47, 13 January 2017

2017-01-13T20:47:00Z

151.229.186.156: /* Creating your own */

2017-01-13T20:35:40Z

‎Creating your own

151.229.186.156: Created page with "Custom protocols:// (officially called a 'schema') are a great way of extending PowerUI. By default it comes with a few non-standard ones: * Resources Protocol|resources://..."

2017-01-13T20:34:15Z

Created page with "Custom protocols:// (officially called a 'schema') are a great way of extending PowerUI. By default it comes with a few non-standard ones: * Resources Protocol|resources://..."

New page

Custom protocols:// (officially called a 'schema') are a great way of extending PowerUI. By default it comes with a few non-standard ones:

* [[Resources Protocol|resources://]]
Loads the named content from any Resources folder within your project (you can have multiple folders called Resources). ''The'' most heavily used protocol in PowerUI.

* [[Scene Protocol|scene://]]
Loads the named scene ''(it must be included in build settings!)''

* [[Camera Protocol|camera://]]
Returns an image; specifically the output of the named camera

* [[Dynamic Protocol|dynamic://]]
Accesses dynamic textures which are being written to by code

* [[Bundle Protocol|bundle://]]
Accesses content within an AssetBundle.

== Creating your own ==

For inspiration, you'll find the built in ones here:

<blockquote>
PowerUI\Source\File Protocols
</blockquote>

All you need to do is add a C# class which inherits FileProtocol. PowerUI will automatically find it for you. Here's an example; it's a simplified version of file://:

<syntaxhighlight lang="csharp">

using UnityEngine;
using Css;
using Dom;

namespace PowerUI{

public class MyProtocol:FileProtocol{

/// <summary>Returns all protocol names:// that can be used for this protocol.</summary>
public override string[] GetNames(){
return new string[]{"myprotocol"};
}

/// <summary>Get the raw data.</summary>
public override void OnGetData(ContentPackage package){

// Path without the protocol:
string rawPath=package.location.Path;

// If the path is ok..
if(rawPath=="test"){

// Some random data:
byte[] data=new byte[4];

// Optionally add some extra headers:
package.responseHeaders["Hello"]="My extra header";

// Optionally state that the headers have been received (if this happens ahead of time) along with the content length:
package.ReceivedHeaders(data.Length);

// The important line! Say we've received the data:
package.ReceivedData(data,0,data.Length);

}else{

// If we couldn't find it..
package.Failed(404);

}

// - Advanced - Handling partial (range) responses
/*
int partialStart;
int partialEnd;
package.GetRange(out partialStart,out partialEnd)
See DriveProtocol.cs (file://) for more info
*/

}

}

}

</syntaxhighlight>

@@ Line 17: / Line 17: @@
 * [[Cache Protocol|cache://]]
-The ImageCache which lets you display any generic Texture2D or RenderTexture on your UI.
+The ImageCache which lets you display any generic Texture2D or RenderTexture on your UI. Largely depreciated - nowadays just use anElement.image = yourTexture; to set the background image to a Unity texture.
 * [[Dynamic Protocol|dynamic://]]

@@ Line 7: / Line 7: @@
 Loads the named scene ''(it must be included in build settings!)''
-* [[Window Protocol|window://]]
+* [[Widget Protocol|widget://]] or [[Widget Protocol|window://]]
-Opens up a window.
+Opens up a widget. These are the same.
 * [[Resize Protocol|resize://]]

@@ Line 6: / Line 6: @@
 * [[Scene Protocol|scene://]]
 Loads the named scene ''(it must be included in build settings!)''
 * [[Camera Protocol|camera://]]

@@ Line 43: / Line 43: @@
+         }
-	/// <summary>Get the raw data.</summary>
+	    /// <summary>Get the raw data.</summary>
-	public override void OnGetData(ContentPackage package){
+	    public override void OnGetData(ContentPackage package){
-		// Path without the protocol:
+		    // Path without the protocol:
-		string rawPath=package.location.Path;
+		    string rawPath=package.location.Path;
- 		// If the path is ok..
+ 		    // If the path is ok..
-		if(rawPath=="test"){
+		    if(rawPath=="test"){
-			// Some random data:
+			    // Some random data:
-			byte[] data=new byte[4];
+			    byte[] data=new byte[4];
-			// Optionally add some extra headers:
+			    // Optionally add some extra headers:
-			package.responseHeaders["Hello"]="My extra header";
+			    package.responseHeaders["Hello"]="My extra header";
-			// Optionally state that the headers have been received (if this happens ahead of time) along with the content length:
+			    // Optionally state that the headers have been received (if this happens ahead of time) along with the content length:
-			package.ReceivedHeaders(data.Length);
+			    package.ReceivedHeaders(data.Length);
-			// The important line! Say we've received the data:
+			    // The important line! Say we've received the data:
-			package.ReceivedData(data,0,data.Length);
+			    package.ReceivedData(data,0,data.Length);
-		}else{
+		    }else{
-			// If we couldn't find it..
+			    // If we couldn't find it..
-			package.Failed(404);
+			    package.Failed(404);
-−
+		    }
-		// - Advanced - Handling partial (range) responses
+		    // - Advanced - Handling partial (range) responses
-		/*
+		    /*
-		int partialStart;
+		    int partialStart;
-		int partialEnd;
+		    int partialEnd;
-		package.GetRange(out partialStart,out partialEnd)
+		    package.GetRange(out partialStart,out partialEnd)
-		See DriveProtocol.cs (file://) for more info
+		    See DriveProtocol.cs (file://) for more info
-		*/
+		    */
-−
+	    }
+     }