Displaying Score and Text

In this tutorial, you’ll:

• Revise the PlayerController script to store the value of collected PickUp GameObjects
• Create and configure UI Text Elements to display:
  • The count value
  • An end of game message

By the end of this tutorial, your game will look something like this:

Follow the video or text instructions below to declare a new count variable, initialize the variable, and increment it by 1 every time the player collects a PickUp GameObject:

Download Transcript

1. Declare a new count variable.

• Open the PlayerController script for editing.
• Underneath the Rigidbody variable declaration, add the following line of code:

private int count;

2. Initialize the count variable.

• In the Start function, add the following line of code to initialize the count variable at 0:

count = 0; 

3. Increment the count variable.

• In the OnTrigger function, after the line that sets the other GameObject to inactive, add the following line of code:

count = count + 1;

Follow the video or text instructions below to add a Text GameObject named “CountText”, preview the full canvas in 2D view, edit the text, and edit the text position:

Download Transcript

1. Add a Text object named “CountText”.

• In the Hierarchy, right-click > UI > Text - TextMeshPro.
• If a dialog opens to install TextMesh Pro Essentials – select Import TMP Essentials, then close that dialog.
• Rename the Text (TMP) GameObject “CountText”.
  

2. Preview the full canvas in 2D view.

• Select the Canvas GameObject and press the F key to frame the entire GameObject in the Scene view.
• Select the 2D toggle at the top of the Scene view to change to 2D view.
  

3. Edit the text.

• Select the CountText GameObject.
• In the Text box, delete “New Text” and replace it with “Count Text” as a placeholder.
  

4. Edit the text position.

• Select the anchor preset icon at the top of the Rect Transform component to open the Anchors and Presets menu.
• Hold Shift+Alt (macOS: Option) and select the upper-left anchor point. Holding those keys will set the pivot and position for CountText based on the new anchor.
• Change the Rect Transform component’s Pos X value to 10 and Pos Y value to -10 to move it away from the corner a bit.
  
  

Follow the video or text instructions below to create a new SetCountText() function that updates the score UI:

Download Transcript

1. Import the TMPro library.

• Open the PlayerController script in your script editor.
• Add the following new line of code underneath the other “using” statements:

using TMPro;

2. Declare a new text variable.

• Underneath the speed variable, create a new variable for your text:

public TextMeshProUGUI countText;

3. Create a new SetCountText() function.

• Underneath the OnMove function’s closing curly brace, leave a space and add the following new function:

   void SetCountText() 
   {
       countText.text =  "Count: " + count.ToString();
   }

4. Call SetCountText in Start and OnTriggerEnter.

• Add the following line at the end of the Start function to set the text at the beginning of the game:

SetCountText();

• Inside the IF statement for OnTriggerEnter, call the SetCountText function again using the same instruction:

SetCountText();

• Save your script.

5. Assign the CountText variable in the Inspector window.

• Select the Player GameObject in the Hierarchy window, then drag the CountText GameObject into the Count Text slot to reference the UI text element.

Important: This step is very important and easy to miss. If you do not do this step, you will see a NullReferenceException error in the Console window and your game will not work.

6. Test your game.

• The score should now start at 0, then increase by 1 each time the player collects a PickUp GameObject!
• If your game is not working, check the script sample at the end of this tutorial to make sure your code is correct.
  

Follow the video or text instructions below to create a new “You Win” text GameObject, declare a variable for your text that’s disabled at start, display the text when all PickUp GameObjects are collected, and assign the winTextObject variable in the Inspector window:

Download Transcript

1. Create a new “You Win” text GameObject.

• In the Hierarchy window, right-click > UI > Text - TextMeshPro, then rename it something like “WinText”
• In the Inspector window, change the text to “You Win!”
• Set the Vertex Color to black.
• Set the Font Size to 32, and make it bold if you want.
• Set the alignment to Center.
• In the Rect Transform component, set the Pos X value to 0, and the Pos Y to around 100.
• Preview the text in Game view, then save the scene if you’re happy with the text.
  

2. Declare a variable for your text that’s disabled at start.

• In the PlayerController script, create a new public variable, of the type GameObject, and call it “winTextObject”:

public GameObject winTextObject;

• In the Start function, add the following line of code to hide the win text by default at start:

winTextObject.SetActive(false);

3. Display the text when all pickups are collected.

• In the SetCountText function, underneath the instruction setting the count value UI text, add the following IF statement:

       if (count >= 12)
       {
           winTextObject.SetActive(true);
       }

Important: Make sure to change the number “12” to however many PickUp GameObjects you actually have in your game.

4. Assign the winTextObject variable in the Inspector window.

• Save your script and return to Unity Editor.
• Select the Player GameObject in the Hierarchy window, then drag the WinText GameObject from the Hierarchy window into the Win Text Object variable slot.

5. Test your game.

• Save the scene and enter Play mode to test your changes.
• The win text should be displayed when all PickUp GameObjects are collected.

If your script is not working as expected, below is an example of what your code should look like at this point. The comments have been added to make the code more readable.

PlayerController.cs

using System.Collections;
using System.Collections.Generic;
using Unity.VisualScripting;
using UnityEngine;
using UnityEngine.InputSystem;
using TMPro;

public class PlayerController : MonoBehaviour
{
 // Rigidbody of the player.
 private Rigidbody rb; 

 // Variable to keep track of collected "PickUp" objects.
 private int count;

 // Movement along X and Y axes.
 private float movementX;
 private float movementY;

 // Speed at which the player moves.
 public float speed = 0;

 // UI text component to display count of "PickUp" objects collected.
 public TextMeshProUGUI countText;

 // UI object to display winning text.
 public GameObject winTextObject;

 // Start is called before the first frame update.
 void Start()
    {
 // Get and store the Rigidbody component attached to the player.
        rb = GetComponent<Rigidbody>();

 // Initialize count to zero.
        count = 0;

 // Update the count display.
        SetCountText();

 // Initially set the win text to be inactive.
        winTextObject.SetActive(false);
    }
 
 // This function is called when a move input is detected.
 void OnMove(InputValue movementValue)
    {
 // Convert the input value into a Vector2 for movement.
        Vector2 movementVector = movementValue.Get<Vector2>();

 // Store the X and Y components of the movement.
        movementX = movementVector.x; 
        movementY = movementVector.y; 
    }

 // FixedUpdate is called once per fixed frame-rate frame.
 private void FixedUpdate() 
    {
 // Create a 3D movement vector using the X and Y inputs.
        Vector3 movement = new Vector3 (movementX, 0.0f, movementY);

 // Apply force to the Rigidbody to move the player.
        rb.AddForce(movement * speed); 
    }

 
 void OnTriggerEnter(Collider other) 
    {
 // Check if the object the player collided with has the "PickUp" tag.
 if (other.gameObject.CompareTag("PickUp")) 
        {
 // Deactivate the collided object (making it disappear).
            other.gameObject.SetActive(false);

 // Increment the count of "PickUp" objects collected.
            count = count + 1;

 // Update the count display.
            SetCountText();
        }
    }

 // Function to update the displayed count of "PickUp" objects collected.
 void SetCountText() 
    {
 // Update the count text with the current count.
        countText.text = "Count: " + count.ToString();

 // Check if the count has reached or exceeded the win condition.
 if (count >= 12)
        {
 // Display the win text.
            winTextObject.SetActive(true);
        }
    }
}