Light Shows

The final component we are going to add to our game is light shows. We want to implement

Background light show for BWTHome
Ramp lightshow to indicate the shots that will spawn birds
Flash when we take a photo

Default Lamps

Following the example of the P3SampleApp, we create a series of default light values for every light. We are going to use the Names and Tags to define these defaults. We want to default the playfield inserts to be off. There is no consistent Tag for this, so we will create a static method to identify these playfield inserts.

We will create a new class with some helper static definitions. Create Assets/Scripts/Modes/LightShows/BWTLedManager.cs

Assets/Scripts/Modes/LightShows/BWTLedManager.cs

using System;
using System.Collections.Generic;
using Multimorphic.NetProcMachine.Machine;

namespace Gammagoat.BWT.Modes
{
    public class BRWDLedManager 
    {		
        public static readonly HashSet<string> Inserts = new HashSet<string>
        {
            // Heist
            "sideLoop", "jailRight", "jailLeft",
            // WAMONH
            "sideLoopLeft", "viP", "miniLoopLeft", "cameraTarget", "sideLoopRight", "ticketCounterArrow",
            "vIp", "hamsterTarget", "rightRamp", "suppliesLower", "miniLoopRight", "rightLoop", "Vip",
            "leftRamp", "leftLoop", "suppliesArrow", "suppliesUpper", //TODO finish
        };
        public static readonly ushort[] DarkGrey = new ushort[] {10, 10, 10, 255};
        public static readonly ushort[] Sunlight = new ushort[] {253, 251, 211, 255};

        public static bool IsPlayfiedInsert(string name)
        {
            return Inserts.Contains(name);
        }
        public static bool IsCabinetLed(LED led)
        {
            if (Array.Exists<string>(led.Tags, x => x == "BaseP3"))
            {
                if (led.Name.Contains("scoop") || led.Name.Contains("wall") || led.Name.Contains("SideModule"))
                {
                    return false;
                }
                return true;
            }
            return false;
        }
    }
}

Now we are ready to define DefaultLamps. We will define

Green
- SideModule
- Walls
- Scoops
DarkGrey
- Flashers
- Inserts
LightGreen
- BaseP3 (cabinet lights, speaker lights, backbox)
Sunlight
- playfield lights
- everything else

Here is the implementation.

Assets/Scipts/Modes/BWTHomeMode.cs

        private void DefaultLamps()
        {
            for (int i=0; i<LEDScripts.Count; i++)
            {
                if (LEDScripts[i].led.Name.Contains ("SideModule"))
                    LEDScripts[i] = LEDHelpers.OnLED (p3, LEDScripts[i], Multimorphic.P3.Colors.Color.green);
                else if (BRWDLedManager.IsPlayfiedInsert(LEDScripts[i].led.Name))
                    LEDScripts[i] = LEDHelpers.OnLED (p3, LEDScripts[i], BRWDLedManager.DarkGrey);
                else if (LEDScripts[i].led.Name.Contains ("flasher"))
                    LEDScripts[i] = LEDHelpers.OnLED (p3, LEDScripts[i], BRWDLedManager.DarkGrey);
                else if (LEDScripts[i].led.Name.Contains ("wall") || LEDScripts[i].led.Name.Contains("scoop"))
                    LEDScripts[i] = LEDHelpers.OnLED (p3, LEDScripts[i], Multimorphic.P3.Colors.Color.green);
                else if (LEDScripts[i].led.Name == "playfield")
                    LEDScripts[i] = LEDHelpers.OnLED(p3, LEDScripts[i], BRWDLedManager.Sunlight);
                else if (Array.Exists<string>(LEDScripts[i].led.Tags, x => x == "BaseP3"))
                    LEDScripts[i] = LEDHelpers.OnLED(p3, LEDScripts[i], Multimorphic.P3.Colors.Color.lightorange );
                else 
                    LEDScripts[i] = LEDHelpers.OnLED (p3, LEDScripts[i], BRWDLedManager.Sunlight);
            }
        }

In mode_started add a call to DefaultLamps().

Assets/Scipts/Modes/BWTHomeMode.cs

            // Gammagoat.BWT.Modes.BWTHomeMode.mode_started

            DefaultLamps();

There are some high priority light shows for the backbox and playfield that are added by the BaseGameMode. Disable this by adding this to the constructor of BWTBaseGameMode

Assets/Scipts/Modes/BWTBaseGameMode.cs

            // Gammagoat.BWT.Modes.BWTBaseGameMode.BWTBaseGameMode

            base.useBackboxColorsMode = false;

Highlighting the Ramps

Next we will create a generic light show to highlight our ramps using the information in the configuration. Create a new GameMode in Assets/Scripts/Modes/LightShows/HighlightRampMode.cs

Assets/Scripts/Modes/LightShows/HighlightRampMode.cs

using System;
using System.Text.RegularExpressions;
using System.Collections.Generic;
using System.Diagnostics;

using Multimorphic.NetProcMachine.LEDs;
using Multimorphic.P3;

namespace Gammagoat.BWT.Modes
{
    public class HighlightRampMode : BWTGameMode
    {       
        private List<KeyValuePair<string, float>> _sortedLEDs;
        private List<List<string>> _entranceLEDs;
        List<LEDScript> LocalLEDScripts;

        public HighlightRampMode (P3Controller controller, int priority, List<List<string>> entranceLEDs )
            : base(controller, priority)
        {
            _entranceLEDs = entranceLEDs;
        }
       
        public override void mode_started ()
        {
            LocalLEDScripts = new List<LEDScript>();
        }

        public override void mode_stopped ()
        {
            for (int i=0; i<LocalLEDScripts.Count; i++)
            {
                p3.LEDController.RemoveScript(LocalLEDScripts[i]);
            }
            LocalLEDScripts.Clear();
            base.mode_stopped();
        }
    }
}

This creates a mode that stores the list of entranceLEDs in its constructor. It removes all the LightShows in mode_stopped, but we don’t yet create any light shows.

Create a helper method that parses the entranceLEDs and generates a list of pairs. We use a KeyValuePair as a basic pair type. This is a hack, but it is a hack I use a lot in Unity because there is no built-in Pair generic in C#. I could write one, but this works.

We are going to handle two types of lights. Named lights like you will get from the entranceLEDs on for example Heist, and light strings like on CCR.

This method will not work in general because it will get the direction wrong for some paths, but it will work for the ramps on CCR.

Assets/Scripts/Modes/LightShows/HighlightRampMode.cs

        private void AddLedsToList(List<List<string>> lightList, out List<KeyValuePair<string, float>> output)
        {
            Regex re = new Regex("^(.*)([0-9]+)-([0-9]+)$");
            output = new List<KeyValuePair<string, float>>();

            foreach (List<string> list in lightList)
            {
                int index=0;
                foreach (string name in list)
                {
                    // led string like "rightRampInner0-131"
                    if (name.Contains("-"))
                    {
                        Match m = re.Match(name);
                        string baseName = m.Groups[1].Value;
                        int startIndex = Int32.Parse(m.Groups[2].Value);
                        int endIndex = Int32.Parse(m.Groups[3].Value);
                        Debug.Assert(startIndex <= endIndex, "startIndex is less than endIndex on name:" + name);
                        for (int i = startIndex; i<= endIndex; i++ )
                        {
                            string ledName = baseName + i.ToString();
                            float dist = (float)i / (float)endIndex;
                            output.Add(new KeyValuePair<string, float>(baseName + i.ToString(), dist)); 
                        }
                    }
                    // Named led like "leftRamp"
                    else
                    {
                        output.Add(new KeyValuePair<string, float>(name, (float)index / (float)list.Count));
                    }
                    index++;
                }
            }
        }

Now we can write our mode_started.

Assets/Scripts/Modes/LightShows/HighlightRampMode.cs

        public override void mode_started ()
        {
            _sortedLEDs = new List<KeyValuePair<string, float>>();
            AddLedsToList(_entranceLEDs, out _sortedLEDs );
            LocalLEDScripts = new List<LEDScript>();
            foreach (KeyValuePair<string, float> pair in _sortedLEDs)
            {
                LEDScript script = new LEDScript( p3.LEDs[pair.Key], this.Priority);
                script.AddCommand(Multimorphic.P3.Colors.Color.yellow, 0.1, 1);
                script.AddCommand(Multimorphic.P3.Colors.Color.grey, 0.5, 1);
                LocalLEDScripts.Add (script);
                float offset = pair.Value * 4.0f;
                offset -= (float)Math.Floor(offset);
                p3.LEDController.AddScript(script, -1, offset*2);
            }
        }

In BirdRampMode, create a new private member variable to store our new light shows.