Add beam modifier system.

Author: RubyNova

Assets/Scenes/MattsTestingLab.unity

@@ -1684,6 +1684,7 @@ MonoBehaviour:
   m_EditorClassIdentifier: 
   _renderer: {fileID: 331883125}
   _axisHelper: {fileID: 2037731236}
+  _beamModifierData: {fileID: 0}
   _lightBeamLength: 20
   _mode: 1
 --- !u!1 &474129002
@@ -1840,6 +1841,7 @@ MonoBehaviour:
   m_EditorClassIdentifier: 
   _renderer: {fileID: 474129004}
   _axisHelper: {fileID: 961317270}
+  _beamModifierData: {fileID: 0}
   _lightBeamLength: 20
   _mode: 1
 --- !u!1 &496010798
@@ -1996,6 +1998,7 @@ MonoBehaviour:
   m_EditorClassIdentifier: 
   _renderer: {fileID: 496010800}
   _axisHelper: {fileID: 1327103495}
+  _beamModifierData: {fileID: 0}
   _lightBeamLength: 20
   _mode: 1
 --- !u!1 &604183311
@@ -5282,6 +5285,7 @@ MonoBehaviour:
   m_EditorClassIdentifier: 
   _renderer: {fileID: 1226129313}
   _axisHelper: {fileID: 1087210529}
+  _beamModifierData: {fileID: 0}
   _lightBeamLength: 20
   _mode: 1
 --- !u!1 &1327103492
@@ -5430,6 +5434,7 @@ GameObject:
   - component: {fileID: 1597989004}
   - component: {fileID: 1597989003}
   - component: {fileID: 1597989002}
+  - component: {fileID: 1597989005}
   m_Layer: 0
   m_Name: DummyControllerSource
   m_TagString: Untagged
@@ -5558,6 +5563,7 @@ MonoBehaviour:
   m_EditorClassIdentifier: 
   _renderer: {fileID: 1597989002}
   _axisHelper: {fileID: 0}
+  _beamModifierData: {fileID: 1597989005}
   _lightBeamLength: 20
   _mode: 0
 --- !u!4 &1597989004
@@ -5575,6 +5581,20 @@ Transform:
   m_Children: []
   m_Father: {fileID: 0}
   m_LocalEulerAnglesHint: {x: 0, y: 0, z: 0}
+--- !u!114 &1597989005
+MonoBehaviour:
+  m_ObjectHideFlags: 0
+  m_CorrespondingSourceObject: {fileID: 0}
+  m_PrefabInstance: {fileID: 0}
+  m_PrefabAsset: {fileID: 0}
+  m_GameObject: {fileID: 1597989001}
+  m_Enabled: 1
+  m_EditorHideFlags: 0
+  m_Script: {fileID: 11500000, guid: 44c483be8df52a043b562df9c2fe4e89, type: 3}
+  m_Name: 
+  m_EditorClassIdentifier: 
+  _colour: {r: 1, g: 0.6136042, b: 0, a: 1}
+  _beamForce: 200
 --- !u!1 &1782676293
 GameObject:
   m_ObjectHideFlags: 0
@@ -5714,6 +5734,7 @@ MonoBehaviour:
   m_EditorClassIdentifier: 
   _renderer: {fileID: 1782676294}
   _axisHelper: {fileID: 604183313}
+  _beamModifierData: {fileID: 0}
   _lightBeamLength: 20
   _mode: 1
 --- !u!4 &1782676296

Assets/Scripts/Controllers/PlayerController.cs

@@ -1,3 +1,5 @@
+using System;
+using Environment;
 using UnityEngine;
 using UnityEngine.Events;
 using UnityEngine.InputSystem;
@@ -158,5 +160,21 @@ private void SwapCharacters()
             }
         }
 
+        public void RegisterIncomingBeamForce(LightBeamController sender, int beamPriority, Vector2 senderBeamDirection, float beamForce)
+        {
+            // TODO: This method is called every tick that the beam detects the player. The beam priority is a value that increments the more controllers this single beam of light
+            // has been through. The senderBeamDirection dictates the direction the beam is flowing. The beamForce value is a raw force to be applied in the given direction, the simplest
+            // application of this being senderBeamDirection * beamForce, but I didn't want to just "implement that" in this way. I might change the beamForce parameter to a vec2
+            // as we implement new beam modifiers and discover we have a need for that, but since im just following my nose for now, this is the best I got for ya. - Matt
+            print("Player registers force!");
+        }
+
+        internal void UnregisterIncomingBeamForce(LightBeamController sender, int beamPriority)
+        {
+            // TODO: This method is only called once by the sending beam controller to effectively flag the player is no longer under the control of that particular light beam controller.
+            // This method exists to help you clean up any state, or help you track multiple controllers if your implementation requires it, and need a way to figure out which controllers to
+            // stop caring about. - Matt
+            print("Player unregisters force!");
+        }
     }
 }

Assets/Scripts/Environment/Debug.meta

@@ -1,4 +1,5 @@
 using System;
+using Controllers;
 using UnityEngine;
 
 namespace Environment
@@ -12,18 +13,26 @@ public class LightBeamController : MonoBehaviour
         [SerializeField]
         private Transform _axisHelper;
 
+        [SerializeField]
+        private LightBeamModifier _beamModifierData;
+
         [Header("Configuration")]
         [SerializeField]
         private float _lightBeamLength;
 
         [SerializeField]
         private LightBeamMode _mode;
+
         private Quaternion _cachedStartRotation;
         private LightBeamController _targetHit;
         private Vector3? _contactPoint;
         private Vector3 _senderDirection;
-        private RaycastHit2D[] _beamRaycastData = new RaycastHit2D[2];
+        private RaycastHit2D[] _beamRaycastData = new RaycastHit2D[3];
         private ContactFilter2D _beamRaycastFilter;
+        private int _beamPriority;
+        private PlayerController _player;
+
+        public LightBeamModifier BeamModifierData => _beamModifierData;
 
         private Vector3? RegisterPotentialBeamHit()
         {
@@ -37,17 +46,35 @@ public class LightBeamController : MonoBehaviour
                     _targetHit = null;
                 }
 
+                if (_player != null)
+                {
+                    _beamModifierData.ClearBeamEffect(this, _beamPriority, _player);
+                    _player = null;
+                }
+
                 return null;
             }
 
             RaycastHit2D? hitInfo = null;
+
+            bool appliedForceToPlayerThisFrame = false;
 
             foreach (var hit in _beamRaycastData)
             {
                 if (hit.transform != null && hit.transform.GetComponentInChildren<LightBeamController>() != this)
                 {
-                    hitInfo = hit;
-                    break;
+                    _player = hit.transform.GetComponentInChildren<PlayerController>();
+
+                    if (_player != null && !appliedForceToPlayerThisFrame)
+                    {
+                        appliedForceToPlayerThisFrame = true;
+                        _beamModifierData.ApplyBeamEffect(this, _beamPriority, _player, transform.right);
+                    }
+                    else
+                    {
+                        hitInfo = hit;
+                        break;
+                    }
                 }
             }
 
@@ -100,6 +127,8 @@ private void ProduceBeam()
             var translatedPosition = transform.position;
             translatedPosition += transform.right * _lightBeamLength;
             _renderer.SetPositions(new[] { _contactPoint ?? transform.position, potentialHitPoint ?? translatedPosition});
+            _renderer.startColor = _beamModifierData.Colour; 
+            _renderer.endColor = _beamModifierData.Colour; 
         }
 
         protected void Start()
@@ -142,6 +171,7 @@ public void RegisterHit(LightBeamController sender, Vector3 hitPoint)
             switch (_mode)
             {
                 case LightBeamMode.Bounce:
+                    _beamModifierData = sender.BeamModifierData;
                     var reflectedDirection = Vector2.Reflect(_senderDirection, _axisHelper.up);
                     var reflectedAngle = Mathf.Atan2(reflectedDirection.y, reflectedDirection.x) * Mathf.Rad2Deg;
                     transform.rotation = Quaternion.Euler(0, 0, reflectedAngle);
@@ -167,6 +197,11 @@ public void UnregisterHit()
                 _targetHit = null;
             }
 
+            if (_mode == LightBeamMode.Bounce)
+            {
+                _beamModifierData = null;   
+            }
+
             transform.rotation = _cachedStartRotation;
             _renderer.enabled = false;
             _contactPoint = null;

Assets/Scripts/Environment/LightBeamController.cs

@@ -0,0 +1,27 @@
+using Controllers;
+using UnityEngine;
+
+namespace Environment
+{
+    public abstract class LightBeamModifier : MonoBehaviour
+    {
+        [Header("Configuration")]
+        [SerializeField]
+        private Color _colour;
+        
+        [SerializeField]
+        private float _beamForce;
+
+        public Color Colour => _colour;
+
+        public virtual void ApplyBeamEffect(LightBeamController sender, int beamPriority, PlayerController player, Vector2 senderBeamDirection)
+        {
+            player.RegisterIncomingBeamForce(sender, beamPriority, senderBeamDirection, _beamForce);
+        }
+
+        public virtual void ClearBeamEffect(LightBeamController sender, int beamPriority, PlayerController player)
+        {
+            player.UnregisterIncomingBeamForce(sender, beamPriority);
+        }
+    }
+}