Code cleanup and documentation changes

Author: adamgraham

Assets/Scripts/Bunker.cs

@@ -17,23 +17,23 @@ public class Bunker : MonoBehaviour
     /// <summary>
     /// The sprite renderer component of the bunker.
     /// </summary>
-    private SpriteRenderer _spriteRenderer;
+    public SpriteRenderer spriteRenderer { get; private set; }
 
     /// <summary>
     /// The box collider component of the bunker.
     /// </summary>
-    private BoxCollider2D _collider;
+    public new BoxCollider2D collider { get; private set; }
 
     /// <summary>
     /// The original texture of the sprite so we can clone it.
     /// </summary>
-    private Texture2D _originalTexture;
+    public Texture2D originalTexture { get; private set; }
 
     private void Awake()
     {
-        _spriteRenderer = GetComponent<SpriteRenderer>();
-        _collider = GetComponent<BoxCollider2D>();
-        _originalTexture = _spriteRenderer.sprite.texture;
+        this.spriteRenderer = GetComponent<SpriteRenderer>();
+        this.collider = GetComponent<BoxCollider2D>();
+        this.originalTexture = this.spriteRenderer.sprite.texture;
 
         ResetBunker();
     }
@@ -42,7 +42,7 @@ public void ResetBunker()
     {
         // Each bunker needs a unique instance of the sprite texture since we
         // will be modifying it at the source
-        CopyTexture(_originalTexture);
+        CopyTexture(this.originalTexture);
 
         this.gameObject.SetActive(true);
     }
@@ -58,8 +58,8 @@ private void CopyTexture(Texture2D source)
         copy.Apply();
 
         // Create a new sprite using the copied texture
-        Sprite sprite = Sprite.Create(copy, _spriteRenderer.sprite.rect, new Vector2(0.5f, 0.5f), _spriteRenderer.sprite.pixelsPerUnit);
-        _spriteRenderer.sprite = sprite;
+        Sprite sprite = Sprite.Create(copy, this.spriteRenderer.sprite.rect, new Vector2(0.5f, 0.5f), this.spriteRenderer.sprite.pixelsPerUnit);
+        this.spriteRenderer.sprite = sprite;
     }
 
     public bool CheckPoint(Vector3 hitPoint, out int px, out int py)
@@ -69,14 +69,14 @@ public bool CheckPoint(Vector3 hitPoint, out int px, out int py)
 
         // Offset the point to the corner of the object instead of the center so
         // we can transform to uv coordinates
-        localPoint.x += _collider.size.x / 2;
-        localPoint.y += _collider.size.y / 2;
+        localPoint.x += this.collider.size.x / 2;
+        localPoint.y += this.collider.size.y / 2;
 
-        Texture2D texture = _spriteRenderer.sprite.texture;
+        Texture2D texture = this.spriteRenderer.sprite.texture;
 
         // Transform the point from local space to uv coordinates
-        px = (int)((localPoint.x / _collider.size.x) * texture.width);
-        py = (int)((localPoint.y / _collider.size.y) * texture.height);
+        px = (int)((localPoint.x / this.collider.size.x) * texture.width);
+        py = (int)((localPoint.y / this.collider.size.y) * texture.height);
 
         // Return true if the pixel is not empty (not transparent)
         return texture.GetPixel(px, py).a != 0.0f;
@@ -92,7 +92,7 @@ public bool Splat(Vector3 hitPoint)
             return false;
         }
 
-        Texture2D texture = _spriteRenderer.sprite.texture;
+        Texture2D texture = this.spriteRenderer.sprite.texture;
 
         // Offset the point by half the size of the splat texture so the splat
         // is centered around the hit point
@@ -121,7 +121,6 @@ public bool Splat(Vector3 hitPoint)
             py++;
         }
 
-        // Apply any changes made to the texture
         texture.Apply();
 
         return true;

Assets/Scripts/GameManager.cs

@@ -65,93 +65,73 @@ private void Awake()
 
     private void Start()
     {
-        // Register callbacks for game state
         this.player.killed += OnPlayerKilled;
         this.mysteryShip.killed += OnMysteryShipKilled;
         this.invaders.killed += OnInvaderKilled;
 
-        // Start a new game
         NewGame();
     }
 
     private void Update()
     {
-        // Start a new game once the player presses 'Return'
         if (this.lives <= 0 && Input.GetKeyDown(KeyCode.Return)) {
             NewGame();
         }
     }
 
     private void NewGame()
     {
-        // Hide the game over UI
         this.gameOverUI.SetActive(false);
 
-        // Reset score and lives
         SetScore(0);
         SetLives(3);
-
-        // Start the first round
         NewRound();
     }
 
     private void NewRound()
     {
-        // Reset all of the invaders
         this.invaders.ResetInvaders();
         this.invaders.gameObject.SetActive(true);
 
-        // Reset all of the bunkers
         for (int i = 0; i < this.bunkers.Length; i++) {
             this.bunkers[i].ResetBunker();
         }
 
-        // Spawn the player
         Respawn();
     }
 
     private void Respawn()
     {
-        // Reset the position of the player
         Vector3 position = this.player.transform.position;
         position.x = 0.0f;
         this.player.transform.position = position;
-
-        // Re-enable the player game object
         this.player.gameObject.SetActive(true);
     }
 
     private void GameOver()
     {
-        // Show the game over UI and hide the invaders
         this.gameOverUI.SetActive(true);
         this.invaders.gameObject.SetActive(false);
     }
 
     private void SetScore(int score)
     {
-        // Set score and update UI text
         this.score = score;
         this.scoreText.text = this.score.ToString().PadLeft(4, '0');
     }
 
     private void SetLives(int lives)
     {
-        // Set lives and update UI text
         this.lives = Mathf.Max(lives, 0);
         this.livesText.text = this.lives.ToString();
     }
 
     private void OnPlayerKilled()
     {
-        // Decrement lives by 1
         SetLives(this.lives - 1);
 
-        // Temporarily disable the player game object
         this.player.gameObject.SetActive(false);
 
-        // Start the round over again after 1 second or trigger the game over
-        // state if out of lives
         if (this.lives > 0) {
             Invoke(nameof(NewRound), 1.0f);
         } else {
@@ -161,18 +141,15 @@ private void OnPlayerKilled()
 
     private void OnInvaderKilled(Invader invader)
     {
-        // Increment score by how much the invader is worth
         SetScore(this.score + invader.score);
 
-        // Start a new round after all invaders have been killed
         if (this.invaders.AmountKilled == this.invaders.TotalAmount) {
             NewRound();
         }
     }
 
     private void OnMysteryShipKilled(MysteryShip mysteryShip)
     {
-        // Increment score by how much the mystery ship is worth
         SetScore(this.score + mysteryShip.score);
     }
 

Assets/Scripts/Invader.cs

@@ -9,7 +9,7 @@ public class Invader : MonoBehaviour
     /// <summary>
     /// The sprite renderer component of the invader.
     /// </summary>
-    private SpriteRenderer _spriteRenderer;
+    public SpriteRenderer spriteRenderer { get; private set; }
 
     /// <summary>
     /// The sprites that are animated on the invader.
@@ -26,7 +26,7 @@ public class Invader : MonoBehaviour
     /// <summary>
     /// The index of the current sprite being rendered.
     /// </summary>
-    private int _animationFrame;
+    public int animationFrame { get; private set; }
 
     /// <summary>
     /// The amount of points the invader is worth when killed.
@@ -41,34 +41,29 @@ public class Invader : MonoBehaviour
 
     private void Awake()
     {
-        // Get a reference to the sprite renderer so we can animate the sprite
-        _spriteRenderer = GetComponent<SpriteRenderer>();
-        _spriteRenderer.sprite = this.animationSprites[0];
+        this.spriteRenderer = GetComponent<SpriteRenderer>();
+        this.spriteRenderer.sprite = this.animationSprites[0];
     }
 
     private void Start()
     {
-        // Start an animation loop to cycle between sprites
         InvokeRepeating(nameof(AnimateSprite), this.animationTime, this.animationTime);
     }
 
     private void AnimateSprite()
     {
-        // Move to the next animation frame
-        _animationFrame++;
+        this.animationFrame++;
 
         // Loop back to the start if the animation frame exceeds the length
-        if (_animationFrame >= this.animationSprites.Length) {
-            _animationFrame = 0;
+        if (this.animationFrame >= this.animationSprites.Length) {
+            this.animationFrame = 0;
         }
 
-        // Set the sprite based on the current animation frame
-        _spriteRenderer.sprite = this.animationSprites[_animationFrame];
+        this.spriteRenderer.sprite = this.animationSprites[this.animationFrame];
     }
 
     private void OnTriggerEnter2D(Collider2D other)
     {
-        // The invader dies when hit by the laser
         if (other.gameObject.layer == LayerMask.NameToLayer("Laser")) {
             this.killed?.Invoke(this);
         }

Assets/Scripts/Invaders.cs

@@ -28,7 +28,7 @@ public class Invaders : MonoBehaviour
     /// <summary>
     /// The initial position of the invaders so they can be reset.
     /// </summary>
-    private Vector3 _initialPosition;
+    public Vector3 initialPosition { get; private set; }
 
     /// <summary>
     /// The callback invoked when an invader is killed.
@@ -83,8 +83,7 @@ public class Invaders : MonoBehaviour
 
     private void Awake()
     {
-        // Store the initial position so we can reset after each round
-        _initialPosition = this.transform.position;
+        this.initialPosition = this.transform.position;
 
         // Form the grid of invaders
         for (int i = 0; i < this.rows; i++)
@@ -111,7 +110,6 @@ private void Awake()
 
     private void Start()
     {
-        // Invoke a missile attack every given amount of seconds
         InvokeRepeating(nameof(MissileAttack), this.missileSpawnRate, this.missileSpawnRate);
     }
 
@@ -145,8 +143,6 @@ private void Update()
     {
         // Evaluate the speed of the invaders based on how many have been killed
         float speed = this.speed.Evaluate(this.PercentKilled);
-
-        // Move all of the invaders in the current direction
         this.transform.position += this.direction * speed * Time.deltaTime;
 
         // Transform the viewport to world coordinates so we can check when the
@@ -190,27 +186,18 @@ private void AdvanceRow()
 
     private void OnInvaderKilled(Invader invader)
     {
-        // Disable the invader that was killed
         invader.gameObject.SetActive(false);
 
-        // Increment the amount of invaders killed so the game manager can check
-        // if they are all dead
         this.AmountKilled++;
-
-        // Invoke the kill callback
         this.killed(invader);
     }
 
     public void ResetInvaders()
     {
-        // Reset state
         this.AmountKilled = 0;
         this.direction = Vector3.right;
+        this.transform.position = this.initialPosition;
 
-        // Reset the position of the invaders back to the top
-        this.transform.position = _initialPosition;
-
-        // Re-enable all of the invaders that were killed
         foreach (Transform invader in this.transform) {
             invader.gameObject.SetActive(true);
         }