Hi, I am working on adding a quest entry UI on screen, which will announce the newest quest name.
For example, a quest entry "kill 30 enemies" is activated. Then the UI will pop with the text: "Kill 30 enemies". If the player receive a new quest called "Save Amy", then the UI will replace the old quest text with "Save Amy".
I am using playmaker and it has a "get quest entry" action, which let me store quest entry text as a variable and display the quest entry on screen. but it gets the text of specific quest entry, not the newest quest entry. So it is not possible to track the newest activated quest and store it as a variable like this.
public TextMeshProUGUI newest; // Assign in inspector.
void OnQuestEntryStateChange(QuestEntryArgs args)
{
var state = QuestLog.GetQuestEntryState(args.questName, args.entryNumber);
if (state == QuestState.Active) newest.text = QuestLog.GetQuestEntry(args.questName, args.entryNumber);
}
Note: The other method, OnQuestStateChange(), is called when a quest or a quest entry changes state. In your Playmaker FSM, you'll want to check if the quest has just become active. Or use OnQuestStateChange() like this:
private List<string> activatedQuests = new List<string>(); // You'll want to reset this when starting a new game or loading a game.
void OnQuestStateChange(string quest)
{
if (activatedQuests.Contains(quest)) return; // Not interested if it's already been activated.
if (QuestLog.IsQuestActive(quest))
{
activatedQuests.Add(quest);
newest.text = quest;
}
}
Create a Text Table asset if you haven't already. (Assets > Create > Pixel Crushers > Common > Text > Text Table)
There's a reference manual in Plugins / Pixel Crushers / Common / Documentation if you want to read about text tables, but they should be relatively intuitive to edit.
Add entries for "No Active Quests" and "No Completed Quests", and add your translations for them.
Then assign the Text Table asset to the Dialogue Manager's Display Settings > Localization Settings > Text Table.
public TextMeshProUGUI newest; // Assign in inspector.
void OnQuestEntryStateChange(QuestEntryArgs args)
{
var state = QuestLog.GetQuestEntryState(args.questName, args.entryNumber);
if (state == QuestState.Active) newest.text = QuestLog.GetQuestEntry(args.questName, args.entryNumber);
}
Is this written correctly?
QuestScript.png (34.3 KiB) Viewed 95 times
I wrote this and attached it to TMPro as a component. The text does not change. I can't understand how scripts work
Make sure it's on the Dialogue Manager GameObject or one of its children. The OnQuestEntryStateChange is only called on the Dialogue Manager hierarchy.
Make sure it's on the Dialogue Manager GameObject or one of its children. The OnQuestEntryStateChange is only called on the Dialogue Manager hierarchy.
I put the component on Dialogue Manager GameObject now, but it still does not change the text.
Another problem is, my dialogue manager uses Don't Destory on Load, so how can I reference the UI Text from a different prefab in every scene if it only works on Dialogue Manager GameObject?
using UnityEngine;
using PixelCrushers.DialogueSystem;
public class ShowNewestQuestEntry : MonoBehaviour
{
// Other scripts can hook into this event to be notified on quest entry changes:
public System.Action<string> ActivatedQuestEntry;
// If this script is on the Dialogue Manager, the Dialogue System will
// call this method when a quest state changes. We need to check this
// in case the quest was just activated and it has an entry that's
// already active on start.
void OnQuestStateChange(string questName)
{
if (string.IsNullOrEmpty(questName)) return;
QuestState state = QuestLog.GetQuestState(questName);
Debug.Log($"Quest {questName} changed to state {state}");
if (state == QuestState.Active)
{
for (int entryNumber = 1; entryNumber <= QuestLog.GetQuestEntryCount(questName); entryNumber++)
{
QuestState entryState = QuestLog.GetQuestEntryState(questName, entryNumber);
if (entryState == QuestState.Active)
{
string questEntryText = QuestLog.GetQuestEntry(questName, entryNumber);
if (string.IsNullOrEmpty(questEntryText) || questEntryText == "nil") continue;
ActivatedQuestEntry?.Invoke(questEntryText);
}
}
}
}
// If this script is on the Dialogue Manager, the Dialogue System will
// call this method when a quest entry state changes.
void OnQuestEntryStateChange(QuestEntryArgs args)
{
QuestState state = QuestLog.GetQuestEntryState(args.questName, args.entryNumber);
Debug.Log($"Quest {args.questName} entry {args.entryNumber} changed to state {state}");
if (state == QuestState.Active)
{
string questEntryText = QuestLog.GetQuestEntry(args.questName, args.entryNumber);
ActivatedQuestEntry?.Invoke(questEntryText);
}
}
}
On a UI with a Text or TextMeshProUGUI that doesn't have to be in the Dialogue Manager's hierarchy:
using UnityEngine;
using PixelCrushers;
/// <summary>
/// This script finds the ShowNewestQuestEntry script on the Dialogue Manager
/// and hooks into its ActivatedQuestEntry event to be informed when a quest
/// entry has become active.
/// </summary>
public class NewestQuestEntryUI : MonoBehaviour
{
public UITextField newEntryText;
private ShowNewestQuestEntry showNewestQuestEntry;
private void Start()
{
showNewestQuestEntry = FindObjectOfType<ShowNewestQuestEntry>();
if (showNewestQuestEntry == null)
{
Debug.LogWarning("Can't find ShowNewestQuestEntry script.");
}
else
{
Debug.Log("Hooking into ShowNewestQuestEntry.ActivatedQuestEntry event");
showNewestQuestEntry.ActivatedQuestEntry += OnActivatedQuestEntry;
}
}
private void OnDestroy()
{
if (showNewestQuestEntry != null)
{
showNewestQuestEntry.ActivatedQuestEntry -= OnActivatedQuestEntry;
}
}
// This method runs when a quest entry state becomes active.
// It sets the newEntryText's content to the quest entry text.
private void OnActivatedQuestEntry(string questEntryText)
{
newEntryText.text = questEntryText;
}
}
I attached both scripts it kinda worked. The text changed but it only changes during the conversation. As soon as the conversation is over (dialogue UI no longer active) the text quickly become "nil".
Is it possible to store the quest entry string somewhere and keep the entry displayed until the entry is updated again?
Yes. Move your Caption Text where it's not inside your dialogue UI. It must still be in a Canvas, though, since that's a requirement for Text or TextMeshProUGUI components. But if it's in the dialogue UI it will only be visible while the dialogue UI is open (i.e., while a conversation is active).
