Here's an example that uses PlayerPrefs:
VN_PlayerPrefsAchievementsExample_2016-08-22.unitypackage
The files are in Dialogue System Extras > Visual Novel Framework > Example > PlayerPrefs Achievements Example.
To use it in your own project:
1. Import the Scripts folder from PlayerPrefs Achievements Example.
2. Add an Achievements Panel to the Dialogue Manager's Canvas. Add UI elements for each achievement. Add a "close" button to the Achievements Panel, and set its OnClick() event to: Achievements Panel: GameObject.SetActive: unticked. (See the example PlayerPrefs Achievements Example Start scene.)
3. Add the Achievements script to your Dialogue Manager. Add achievements to the Achievements list. Give each one a name and assign the UI element from the Achievements Panel.
4. Add an Achievements button to your Start Panel > MenuButtons. The OnClick() event should have two entries:
- Achievements Panel: GameObject.SetActive: ticked
- Achievements (the script you just added to the Dialogue Manager): UpdateIcons.
5. Add an Achievements button to your Gameplay Panel > Menu Panel. The OnClick() event should have the two entries as above:
- Achievements Panel: GameObject.SetActive: ticked
- Achievements (the script you just added to the Dialogue Manager): UpdateIcons.
6. In your dialogue database, when the player earns an achievement, put
AddAchievement("achievementName") in the
Script field. In the example database, the Script field is:
Code: Select all
AddAchievement("MadeGirlAngry");
ShowAlert("Achievement: Made Girl Angry")
To reset the achievements, inspect the Achievements script on the Dialogue Manager, and click "Reset Achievements".
The Achievements script is below for your reference. There's also a very simple editor script that adds the Reset Achievements button to the Achievements inspector.
Code: Select all
using UnityEngine;
using System;
using System.Collections.Generic;
using PixelCrushers.DialogueSystem;
public class Achievements: MonoBehaviour
{
[Serializable]
public class Achievement
{
public string name;
public GameObject icon;
}
public List<Achievement> achievements = new List<Achievement>();
private void Start()
{
Lua.RegisterFunction("AddAchievement", this, SymbolExtensions.GetMethodInfo(() => AddAchievement(string.Empty)));
UpdateIcons();
}
public void AddAchievement(string achievementName)
{
if (string.IsNullOrEmpty(achievementName))
{
Debug.LogError("AddAchievement was provided a blank achievement name");
}
else if (achievements.Find(x => string.Equals(x.name, achievementName)) == null)
{
Debug.LogError("Achievement '" + achievementName + "' is not defined in the Achievements component");
}
else
{
PlayerPrefs.SetInt(achievementName, 1);
}
}
public void UpdateIcons()
{
foreach (var achievement in achievements)
{
if (achievement != null)
{
if (string.IsNullOrEmpty(achievement.name))
{
Debug.LogError("Achievement name is blank");
}
else if (achievement.icon == null)
{
Debug.LogError("Achievement '" + achievement.icon + "' icon is unassigned");
}
else
{
var hasAchievement = PlayerPrefs.GetInt(achievement.name, 0) == 1;
achievement.icon.SetActive(hasAchievement);
}
}
}
}
}
