Tutorials - Spieleentwicklung

1. Was haben wir vor in diesem Tutorial?

Ich möchte mit dir heute Schritt für Schritt ein paar Scripte schreiben, die dir ermöglichen Highscores in dein Spiel einzubinden.

Der Highscore Manager soll in der Lage sein verschiedene Highscores zu speichern, zum Beispiel für leichten, mittleren und schweren Spielmodus.

Wir brauchen 2 Skripte dazu, die später zusammen arbeiten sollen:

2. Verwaltung der Daten

In unserem HighscoreManager müssen wir später unsere Daten speichern, laden, einzelne Einträge ändern und sicher auch noch mehr.

Daher sollten wir als erstes darüber nachdenken, welche Daten wir brauchen und wie wir diese am besten organisieren.

using System.Collections.Generic;
using System;

[Serializable]
public class HighscoreEntry
{
    public string playerName;
    public int score;
}

[Serializable]
public class HighscoreList
{
    public string id;
    public List<HighscoreEntry> highscores;
}

[Serializable]
public class SaveHighscoreData
{
    public List<HighscoreList> allHighscoreLists;
    public string playerName;
}

Die erste Klasse (HighscoreEntry) dient dazu, einen einzelnen Highscoreeintrag zu speichern.

Diese einzelnen Einträge werden in der zweiten Klasse (HighscoreList) zusammengefasst und mit einer id identifizierbar gemacht

Die letzte Klasse dient dazu, die Daten zusammen zu fassen, um speichern und laden zu können.

Werbung (Affiliate - ich bekomme eine kleine Provision, dein Preis ändert sich nicht)

3. Die HighscoreManager-Klasse

Als erstes sollten wir überlegen welche Felder wir benötigen, denn wir müssen uns die verschiedenen Highscorelisten zunächst einmal speichern um Daten zu ergänzen.

Ausserdem wird es nötig sein, den Filename zu speichern, dazu den Spielernamen und wir wollen auch die maximale Anzahl von Einträgen bestimmen können.

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using System;
using System.IO;

public class HighscoreManager : MonoBehaviour
{
  
    [SerializeField] List<HighscoreList> allHighscoreLists;
    [SerializeField] string fileName;
    [SerializeField] string playerName;
    [SerializeField] int maxEntries;
    string path;

Der PlayerName soll von ausserhalb der Klasse erreichbar und änderbar sein, deshalb legen wir eine Property dafür an.

Weiterhin wird der Pfad zum Speichern und Laden aus PersistentDataPath und unserem Filename zusammengebaut. Application.persistentDataPath ist auf jeder Plattform anders, je nach dem, wo Unity speichern darf im jeweiligen Betriebssystem.

Auf OnDestroy soll der Highscore gespeichert werden, daher rufen wir SaveHighscoreLists() auf. Diese Methode müssen wir dann noch schreiben.

    public string PlayerName
    {
        get{ return playerName; }
        set{ playerName = value; }
    }

    void Start()
    {
        path = Path.Combine(Application.persistentDataPath, fileName + ".json");
        LoadHighscoreLists();
    }

    private void OnDestroy()
    {
        SaveHighscoreLists();
    }

Im nächsten Schritt gib es eine Methode, die eine Liste zurückgibt die mittels der id in der Gesamt-Highscoreliste gesucht wird.

HighscoreList GetHighscoreListById(string id)
{
	foreach (var highscoreList in allHighscoreLists)
	{
		if (id == highscoreList.id)
		{
			return highscoreList;
		}
	}
	return null;
}

Dann gibt es eine Methode, welche eine Highscoreliste per Id sucht (über die zuvor implementierte Methode). Diese wird anschließend sortiert.

Da dies hier ein Anfängertutorial ist, sortieren wir per BubbleSort-Algorithmus. Dabei wird ein Score in der Liste mit seinem Nachfolger verglichen. Wenn der Nachfolger größer ist, tauschen beide (oder andersrum, je nach Sortierrichtung). Und das solange, bis der Fall, dass ein Nachfolger größer ist, nicht mehr eintritt. Dann ist die Liste sortiert.

Die Schwierigkeit, hier eine fertige Sortiermethode von der Klasse List zu nutzen ist folgende: Die Klasse HighscoreEntry, die in der Liste gespeichert ist, beinhaltet nicht nur den Score sondern auch den Namen des Spielers. Wir müssten also angeben, nach welchen Kreterien hier sortiert werden soll. Das geht zwar auch, gehört aber nicht in dieses Anfängertutorial.

public HighscoreList GetHighscoreList(string id, bool highestFirst)
{
	HighscoreList highscoreList = GetHighscoreListById(id);
	if (highscoreList == null) return null;

	var highsc = highscoreList.highscores;

	bool sort = false;

	while (!sort) //Bubble Sort
	{
		sort = true;
		for (int i = 0; i < highsc.Count - 1; i++)
		{
			bool change = highsc[i].score > highsc[i + 1].score;
			if (highestFirst) change = highsc[i].score < highsc[i + 1].score;

			if (change)
			{
				sort = false;
				(highsc[i], highsc[i + 1]) = (highsc[i + 1], highsc[i]);                
			}
		}
	}
	return highscoreList;
}

Die nächste Methode prüft, ob es sich wirklich um einen Highscore handelt und gibt einen entsprechenden Wahrheitswert (true oder false) zurück.

public bool IsHighscore(string id, int score, bool highestFirst)
{
	if (score < 1) return false;

	var highscoreList = GetHighscoreList(id, highestFirst);
	if (highscoreList == null) return false;

	var highsc = highscoreList.highscores;

	if (highsc.Count < maxEntries)
		return true;

	if (highestFirst)
		return score > highsc[highsc.Count - 1].score;

	return score < highsc[highsc.Count - 1].score;
}

Anschließend nutzen wir die obige Methode, um zu schauen, ob es ein Highscore ist, der erzeugt werden soll. Wenn ja wird dieser Highscoreeintrag angelegt.

public void NewHighscoreEntry(string id, int score, bool highestFirst = true)
{
	if (!IsHighscore(id, score, highestFirst)) return;
	Debug.Log("Score is a Highscore");

	var entry = new HighscoreEntry();

	entry.playerName = playerName;
	entry.score = score;

	var highscoreList = GetHighscoreList(id, highestFirst);

	if (highscoreList == null)
	{
		Debug.LogError("Highscorelist not found, please check id");
		return;
	}

	highscoreList.highscores.Add(entry);

	GetHighscoreList(id, highestFirst);

	var highscoreCount = highscoreList.highscores.Count;

	if (highscoreCount > maxEntries)
		highscoreList.highscores.RemoveAt(maxEntries);

	SaveHighscoreLists();
}

Die nachfolgende Methode gibt eine Highscoreliste in Form von drei Texten zurück: Ranking, Namen und Scores. Die Texte sind jeweils umgebrochen, man kann Sie also direkt in einem Unity-Text ausgeben.

public (string, string, string) GetHighscoresAsTextColumns(string id, bool highestFirst)
{
	var list = GetHighscoreList(id, highestFirst);
	var nL = System.Environment.NewLine;

	string ranks = string.Empty;
	string names = string.Empty;
	string scores = string.Empty;

	for (int i = 0; i < list.highscores.Count; i++)
	{
		ranks += (i + 1).ToString() + nL;
		names += list.highscores[i].playerName + nL;
		scores += list.highscores[i].score.ToString() + nL;
	}

	return (ranks, names, scores);
}

Was jetzt noch fehlt, ist das Speichern und Laden. Dazu wird die SaveHighscoreData-Klasse genutzt. Diese wird beim Speichern in Json umgewandelt und mit File.WriteAllText geschrieben.

Bei Laden geschieht das ganze genau umgedreht. Das heißt der File wird zuerst gelesen als Json Datei und dann wird daraus eine Instanz von SaveHighscoreData erzeugt.

void LoadHighscoreLists()
{      
	if (File.Exists(path))
	{
		Debug.Log(path);
		string loadJson = File.ReadAllText(path);

		if (!string.IsNullOrEmpty(loadJson)) { 
			var saveData = JsonUtility.FromJson<SaveHighscoreData>(loadJson);
			allHighscoreLists = saveData.allHighscoreLists;
			playerName = saveData.playerName;               
		}
	}
}

void SaveHighscoreLists()
{       
	var saveData = new SaveHighscoreData();
	saveData.allHighscoreLists = allHighscoreLists;
	saveData.playerName = playerName;
	
	string saveJson = JsonUtility.ToJson(saveData);
	File.WriteAllText(path, saveJson);
}

Hier nochmal die ganze Klasse "HighscoreManager" zusammengefasst:

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using System;
using System.IO;

public class HighscoreManager : MonoBehaviour
{
  
    [SerializeField] List<HighscoreList> allHighscoreLists;
    [SerializeField] string fileName;
    [SerializeField] string playerName;
    [SerializeField] int maxEntries;
    string path;

    public string PlayerName
    {
        get{ return playerName; }
        set{ playerName = value; }
    }

    void Start()
    {
        path = Path.Combine(Application.persistentDataPath, fileName + ".json");
        LoadHighscoreLists();
    }

    private void OnDestroy()
    {
        SaveHighscoreLists();
    }

    HighscoreList GetHighscoreListById(string id)
    {
        foreach (var highscoreList in allHighscoreLists)
        {
            if (id == highscoreList.id)
            {
                return highscoreList;
            }
        }
        return null;
    }

    public HighscoreList GetHighscoreList(string id, bool highestFirst)
    {
        HighscoreList highscoreList = GetHighscoreListById(id);
        if (highscoreList == null) return null;

        var highsc = highscoreList.highscores;

        bool sort = false;
        while (!sort) //Bubble Sort
        {
            sort = true;
            for (int i = 0; i < highsc.Count - 1; i++)
            {
                bool change = highsc[i].score > highsc[i + 1].score;
                if (highestFirst) change = highsc[i].score < highsc[i + 1].score;

                if (change)
                {
                    sort = false;
                    (highsc[i], highsc[i + 1]) = (highsc[i + 1], highsc[i]);                
                }
            }
        }
        return highscoreList;
    }
    public bool IsHighscore(string id, int score, bool highestFirst)
    {
        if (score < 1) return false;

        var highscoreList = GetHighscoreList(id, highestFirst);
        if (highscoreList == null) return false;

        var highsc = highscoreList.highscores;

        if (highsc.Count < maxEntries)
            return true;

        if (highestFirst)
            return score > highsc[highsc.Count - 1].score;

        return score < highsc[highsc.Count - 1].score;
    }

    public void NewHighscoreEntry(string id, int score, bool highestFirst = true)
    {
        if (!IsHighscore(id, score, highestFirst)) return;
        Debug.Log("Score is a Highscore");

        var entry = new HighscoreEntry();

        entry.playerName = playerName;
        entry.score = score;

        var highscoreList = GetHighscoreList(id, highestFirst);

        if (highscoreList == null)
        {
            Debug.LogError("Highscorelist not found, please check id");
            return;
        }

        highscoreList.highscores.Add(entry);

        GetHighscoreList(id, highestFirst);

        var highscoreCount = highscoreList.highscores.Count;

        if (highscoreCount > maxEntries)
            highscoreList.highscores.RemoveAt(maxEntries);

        SaveHighscoreLists();
    }

    public (string, string, string) GetHighscoresAsTextColumns(string id, bool highestFirst)
    {
        var list = GetHighscoreList(id, highestFirst);
        var nL = System.Environment.NewLine;

        string ranks = string.Empty;
        string names = string.Empty;
        string scores = string.Empty;

        for (int i = 0; i < list.highscores.Count; i++)
        {
            ranks += (i + 1).ToString() + nL;
            names += list.highscores[i].playerName + nL;
            scores += list.highscores[i].score.ToString() + nL;
        }

        return (ranks, names, scores);
    }

    void LoadHighscoreLists()
    {      
        if (File.Exists(path))
        {
            Debug.Log(path);
            string loadJson = File.ReadAllText(path);

            if (!string.IsNullOrEmpty(loadJson)) { 
                var saveData = JsonUtility.FromJson<SaveHighscoreData>(loadJson);
                allHighscoreLists = saveData.allHighscoreLists;
                playerName = saveData.playerName;               
            }
        }
    }

    void SaveHighscoreLists()
    {       
        var saveData = new SaveHighscoreData();
        saveData.allHighscoreLists = allHighscoreLists;
        saveData.playerName = playerName;
        
        string saveJson = JsonUtility.ToJson(saveData);
        File.WriteAllText(path, saveJson);
    }
}

4. Wie gehts jetzt weiter? Wie benutzte ich das im Spiel?

Die Komponente HighscoreManager in Unity

Um den Manager zu nutzen, musst Du Ihn natürlich auf ein GameObject ziehen und entsprechend die Komponente einstellen.

Beispiel für Leaderboard Canvas in Unity

Anschließend könntest Du dir eine Nutzeroberfläche machen mit Unity-Canvas.

Dort hast du z.B. ein Textfeld, indem der Nutzer seinen Namen eingeben kann. Dies blendest Du nur ein, wenn Du zuvor geprüft hast, ob es ein Highscore ist.

Dann wartest Du auf die Eintragung des Namens und trägst den Highscore in die Liste ein.

Falls es kein neuer Highscore ist, zeigst Du gleich die Bestenliste an und stellst einen Button zum Weiterspielen zur Verfügung.

Das folgende Script macht schon einen Teil davon, den Rest schaffst Du selbst!

using System.Collections;
using System.Collections.Generic;
using UnityEngine;
using TMPro;

public class HighscoreUI : MonoBehaviour
{
    [SerializeField] GameObject nameInput;
    [SerializeField] GameObject leaderboard;
    [SerializeField] GameObject playButton;
    HighscoreManager highscore;

    string id = "easy";  //ToDo: ggf. richtige Id beziehen    
    int newScore = 1000; //ToDo: richtigen Score beziehen

    private void OnEnable()
    {
        highscore = FindObjectOfType<HighscoreManager>();

        if (highscore == null)
            return;

       //ToDo: TextFeld, Leaderboard-tabelle und Playbutton anfangs ausblenden
     
       if (highscore.IsHighscore(id, newScore, true))
            ShowNameInput();

       //ToDo: falls kein Highscore direkt leaderboard anzeigen
    }

    void ShowNameInput()
    {
        nameInput.SetActive(true);

        var inputField = nameInput.GetComponentInChildren<TMP_InputField>();
        if (inputField != null)
        {
            //ToDo: onSubmit-Listener des Textfeld anmelden, welche "NameIsSubmitted" aufruft              
        }            
    }

    void NameIsSubmitted( string name )
    {
        //ToDo: Nutze die Funktionen von HighscoreManager um den Score in die List zu schreiben
        //zeige anschließend den Score an, vlt. InputFeld ausblenden
    }

    void ShowLeaderboard()
    {       
        leaderboard.SetActive(true);
        playButton.SetActive(true);

        //ToDo: Leaderboard anzeigen       
    }
}

Viel Spaß!

Unity Tutorial: Einfaches Highscore-Manager Script

1. Was haben wir vor in diesem Tutorial?

2. Verwaltung der Daten

3. Die HighscoreManager-Klasse

4. Wie gehts jetzt weiter? Wie benutzte ich das im Spiel?

Das Thema als Video