Screen Fading (Fade to black/ Whiteouts) - Revision history

151.229.136.200 at 19:14, 26 March 2017

2017-03-26T19:14:35Z

Bablakeluke at 16:33, 18 March 2017

2017-03-18T16:33:22Z

Bablakeluke: Now uses the Promise Web API.

2017-03-04T16:05:01Z

Now uses the Promise Web API.

Bablakeluke: /* Files */

2017-03-04T15:32:22Z

‎Files

151.229.186.156 at 12:30, 14 January 2017

2017-01-14T12:30:19Z

151.229.186.156 at 11:59, 14 January 2017

2017-01-14T11:59:16Z

151.229.186.156: /* Usage */

2017-01-14T11:54:55Z

‎Usage

151.229.186.156: /* Files */

2017-01-14T11:54:34Z

‎Files

151.229.186.156: /* Files */

2017-01-14T11:53:17Z

‎Files

151.229.186.156 at 11:52, 14 January 2017

2017-01-14T11:52:28Z

← Older revision		Revision as of 19:14, 26 March 2017
Line 1:		Line 1:
−	Fading the screen out to some colour (usually black or white) is an essential piece of screenplay. ~~Here's a~~ [[Widget Templates\|widget template]] which enables screen fading ~~in PowerUI~~.	+	Fading the screen out to some colour (usually black or white) is an essential piece of screenplay. A [[Widget Templates\|widget template]] called 'screenfade' has been built in which enables screen fading.

	== Usage ==		== Usage ==

@@ Line 1: / Line 1: @@
-Fading the screen out to some colour (usually black or white) is an essential piece of screenplay. Here's a [[Window Templates|window template]] which enables screen fading in PowerUI.
+Fading the screen out to some colour (usually black or white) is an essential piece of screenplay. Here's a [[Widget Templates|widget template]] which enables screen fading in PowerUI.
 == Usage ==
-The bonus of it being a window template is that you can instantly trigger it from an anchor tag using the [[Window Protocol|window:// protocol]] like so:
+The bonus of it being a widget template is that you can instantly trigger it from an anchor tag using the [[Widget Protocol|widget:// protocol]] like so:
 <syntaxhighlight lang="html">
 <!-- Linear fade the screen to black and take 3 seconds doing it -->
-<a href='window://screenfade?to=black&time=3s' onload='calledWhenFaded'>Fade out now.</a>
+<a href='widget://screenfade?to=black&time=3s' onload='calledWhenFaded'>Fade out now.</a>
 </syntaxhighlight>
-If you'd like to call it from scripts, use ScreenFade.Fade:
+If you'd like to call it from scripts, use aDocument.fade:
 <syntaxhighlight lang="csharp">
 // Fade the main UI to black, taking 2 seconds:
-ScreenFade.Fade(UI.document,Color.black,2f);
+UI.document.fade(Color.black,2f);
 </syntaxhighlight>
-Or to cue it from dialogue, cue a "screenfade" window with the following globals:
+Or to cue it from dialogue, cue a "screenfade" widget with the following globals:
 {| class="wikitable"
@@ Line 46: / Line 46: @@
 == Stacking ==
-As it's a window, you can also stack other windows on top of it, by using theFadeWindow.open(..). This is great for e.g. pause menus where you'd like the screen to fade to black (or to some semi-transparent colour) and display a pause menu on top.
+As it's a widget, you can also stack other widgets on top of it, by using theFadeWidget.open(..). This is great for e.g. pause menus where you'd like the screen to fade to black (or to some semi-transparent colour) and display a pause menu on top.

@@ Line 55: / Line 55: @@
 // MIT license (Free to do whatever you want with)
 using System;
@@ Line 71: / Line 73: @@
 	/// <summary>A helper function for fading the screen in the given document.</summary>
 	[Values.Preserve]
-	public static void Fade(PowerUI.HtmlDocument doc,UnityEngine.Color to,float timeInSeconds){
+	public static Promise Fade(PowerUI.HtmlDocument doc,UnityEngine.Color to,float timeInSeconds){
 		// Create globals:
@@ Line 81: / Line 85: @@
 		// Open up the window:
-		doc.sparkWindows.open("screenfade",null,globals);
+		var w=doc.sparkWindows.open("screenfade",null,globals);
+	}

← Older revision		Revision as of 15:32, 4 March 2017
Line 70:		Line 70:

	/// <summary>A helper function for fading the screen in the given document.</summary>		/// <summary>A helper function for fading the screen in the given document.</summary>
		+	[Values.Preserve]
	public static void Fade(PowerUI.HtmlDocument doc,UnityEngine.Color to,float timeInSeconds){		public static void Fade(PowerUI.HtmlDocument doc,UnityEngine.Color to,float timeInSeconds){

@@ Line 43: / Line 43: @@
 | "2s", "1500ms"
 |}
 == Files ==

@@ Line 21: / Line 21: @@
 </syntaxhighlight>
-Or to cue it from dialogue, use ScreenFade.Cue with the following globals:
+Or to cue it from dialogue, use cue a "screenfade" window with the following globals:
 {| class="wikitable"

@@ Line 64: / Line 64: @@
 [Dom.TagName("screenfade")]
 public class ScreenFade : Windows.Window{
 	/// <summary>A helper function for fading the screen in the given document.</summary>

@@ Line 70: / Line 70: @@
 		// Open up the window using the globals from the event:
 		e.open("screenfade",null);
+	}