FlxBasePreloader: improve the sitelock failure notice #1994

seraku24 · 2016-11-06T02:32:09Z

The existing sitelock failure notice is, well, a little lackluster. Unfortunately, the sitelock functionality within the FlxBasePreloader class is not as easily modified, requiring the programmer to duplicate parts of the logic not dealing with the visuals.

I decided the improvements I made for my own uses should be shared with the world, so here is a PR for including an updated version of the sitelock failure notice. And as pictures are nice, here is how the new default failure notice looks:

As the underlying logic has been reorganized to address the issues mentioned above and several helper functions have been added to aid in the creation of the visual elements, here is a code snippet showing a sample customization in action:

class Preloader extends FlxBasePreloader
{
    public function new():Void {
        super(0, [ "http://placeholder.domain.test/path/document.html" ]);

        siteLockTitleText = "Oops!";
        siteLockBodyText = "Well, it looks like somebody went and did a very bad and naughty thing.\n\n"
            + "Why not try heading over to the following website to play this game?";
    }

    override private function createSiteLockFailureScreen():Void {
        addChild(createSiteLockFailureBackground(0xeeaa33, 0xbb5533));
        addChild(createSiteLockFailureIcon(0xffcc33, 0.5));
        addChild(createSiteLockFailureText(60));
    }

    override private function adjustSiteLockTextFields(titleText:TextField, bodyText:TextField, hyperlinkText:TextField):Void {
        titleText.setTextFormat(new TextFormat("Cambria", 40, 0xffcc33, true, true));
        bodyText.setTextFormat(new TextFormat("Cambria", 25, 0x112244));
        hyperlinkText.setTextFormat(new TextFormat("Consolas", 20, 0xffcc33));
        hyperlinkText.background = true;
        hyperlinkText.backgroundColor = 0x112244;
    }

    // . . .
}

Gama11 · 2016-11-06T13:11:55Z

flixel/system/FlxBasePreloader.hx

+	}
+
+    private function createSiteLockFailureBackground(innerColor:UInt, outerColor:UInt):Shape
+	{


This code uses a mix of tabs and spaces. Technically haxe-checkstyle / CodeClimate should catch this, but I've had issues with that in the past IIRC... :/

I guess it's because of HaxeCheckstyle/haxe-checkstyle#278.

Sorry about this. VSCode normally does the right thing by matching the formatting of the file you are editing. However, I use spaces in my own code, so any new files that I write will use spaces instead of tabs. Since I had to do a big copy-paste job for this one, the spaces I normally used leaked in here. I thought I caught that and normalized it, but I think that may have only been for a few lines here and there.

gamedevsam

This is a good change, but please add indication on how users can override default values.

gamedevsam · 2017-04-24T11:01:35Z

flixel/system/FlxBasePreloader.hx

 	 */
 	public static inline var LOCAL:String = #if flash "local" #else "localhost" #end;
-	
+


Why the extra lines?

Extra lines? Are you referring to the whitespace normalization? If so, there should not be any "extra" lines. I will of course double-check once I get this branch rebased to address the changes you requested below as well as the conflicts due to the PR's old age.

gamedevsam · 2017-04-24T11:03:54Z

flixel/system/FlxBasePreloader.hx

+
+	/**
+	 * The title text to display on the sitelock failure screen.
+	 * NOTE: This string should be reviewed for accuracy and may need to be localized.


Provide hint on how user can override this text, ex:

* To override this variable, create a new preloader class that extends FlxBasePreloader, and override the default value in new function before you call super();

Added clarification on how to customize as well as a providing a simple example.

gamedevsam · 2017-04-24T11:04:08Z

flixel/system/FlxBasePreloader.hx

+
+	/**
+	 * The body text to display on the sitelock failure screen.
+	 * NOTE: This string should be reviewed for accuracy and may need to be localized.


gamedevsam · 2017-04-24T19:31:27Z

@Gama11 any reservations about this change?

Gama11 · 2017-04-24T19:37:09Z

Can we add @since tags to new API? Also wrap class names in docs etc in backticks for markdown formatting.

More generally, this seems like a lot of effort for a fairly niche / little-used feature, but hey, it's already here now, and it looks nice. :)

Gama11 · 2017-04-24T19:37:53Z

flixel/system/FlxBasePreloader.hx

+		addChild(createSiteLockFailureText(30));
+	}
+
+	private function createSiteLockFailureBackground(innerColor:UInt, outerColor:UInt):Shape


Any reason not to use FlxColor for colors?

Not sure. I'm fairly certain FlxColor would work. I most likely wrote it this way since the underlying graphics APIs expect UInt.

seraku24 · 2017-04-24T20:12:51Z

@Gama11 What do I need to put in for a @since tag? Just 4.2.0 (ignoring the revision)?

Gama11 · 2017-04-24T20:14:46Z

4.3.0 actually, since that will be the next release. Example:

https://github.com/HaxeFlixel/flixel/blob/dev/flixel/FlxCamera.hx#L1529

Improved the visuals of the failure notice. Revised the default failure notice text. Enabled easy customization of the failure notice text and formatting. Provide example for customizing title/body text. Added since tags for 4.3.0. Changed UInt to FlxColor for color-based arguments. Fix Travis build break against Haxe 3.2.0. An Array<Int> is not being converted to a Vector<Float> when compiled with the older version of Haxe. Making the first element an explicit floating-point value will force the type to Array<Float> which, hopefully, should convert as expected.

seraku24 · 2017-04-24T22:02:13Z

Okay, that should do it. Thanks, @Gama11 and @gamedevsam for all the feedback and help.

Gama11 · 2017-04-26T17:05:41Z

This doesn't really affect #2055 (for better or worse), so I'll go ahead and merge it.

Definitely looks a lot nicer than before, thanks!

Gama11 reviewed Nov 6, 2016

View reviewed changes

gamedevsam suggested changes Apr 24, 2017

View reviewed changes

seraku24 force-pushed the seraku24-improve-sitelock branch from 74617c2 to fb461c7 Compare April 24, 2017 16:31

Gama11 reviewed Apr 24, 2017

View reviewed changes

seraku24 force-pushed the seraku24-improve-sitelock branch from 0d091bf to 593d33d Compare April 24, 2017 21:57

Gama11 changed the title ~~Improving the sitelock failure notice.~~ FlxBasePreloader: improve the sitelock failure notice Apr 26, 2017

Gama11 added the Improvement label Apr 26, 2017

Gama11 mentioned this pull request Apr 26, 2017

FlxPreloader sitelock not triggering anymore #2055

Closed

Minor style changes

a431996

Gama11 merged commit 6050040 into HaxeFlixel:dev Apr 26, 2017

seraku24 deleted the seraku24-improve-sitelock branch April 26, 2017 21:06

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

FlxBasePreloader: improve the sitelock failure notice #1994

FlxBasePreloader: improve the sitelock failure notice #1994

seraku24 commented Nov 6, 2016

Gama11 Nov 6, 2016

Gama11 Nov 6, 2016

seraku24 Nov 6, 2016

gamedevsam left a comment

gamedevsam Apr 24, 2017

seraku24 Apr 24, 2017

gamedevsam Apr 24, 2017

seraku24 Apr 24, 2017

gamedevsam Apr 24, 2017

gamedevsam commented Apr 24, 2017

Gama11 commented Apr 24, 2017

Gama11 Apr 24, 2017

seraku24 Apr 24, 2017 •

edited

Loading

seraku24 commented Apr 24, 2017

Gama11 commented Apr 24, 2017

seraku24 commented Apr 24, 2017 •

edited

Loading

Gama11 commented Apr 26, 2017

		*/
		public static inline var LOCAL:String = #if flash "local" #else "localhost" #end;

FlxBasePreloader: improve the sitelock failure notice #1994

FlxBasePreloader: improve the sitelock failure notice #1994

Conversation

seraku24 commented Nov 6, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gamedevsam left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gamedevsam commented Apr 24, 2017

Gama11 commented Apr 24, 2017

Choose a reason for hiding this comment

seraku24 Apr 24, 2017 • edited Loading

Choose a reason for hiding this comment

seraku24 commented Apr 24, 2017

Gama11 commented Apr 24, 2017

seraku24 commented Apr 24, 2017 • edited Loading

Gama11 commented Apr 26, 2017

seraku24 Apr 24, 2017 •

edited

Loading

seraku24 commented Apr 24, 2017 •

edited

Loading