Quest.cs

// The Quest struct only contains the dynamic quest properties, so that the
// static properties can be read from the scriptable object. The benefits are
// low bandwidth and easy Player database saving (saves always refer to the
// scriptable quest, so we can change that any time).
//
// Quests have to be structs in order to work with SyncLists.
using System;
using System.Collections.Generic;
using System.Text;
using UnityEngine;

namespace uMMORPG
{
    [Serializable]
    public partial struct Quest
    {
        // hashcode used to reference the real ScriptableQuest (can't link to data
        // directly because synclist only supports simple types). and syncing a
        // string's hashcode instead of the string takes WAY less bandwidth.
        public int hash;

        // the progress field can be used by inheriting from ScriptableQuests
        // -> the field can be:
        //    * kill counters for 1 monster
        //    * kill counters for 4 monsters (split into 4 bytes, so 4 x 255 kills)
        //    * simple boolean checks (1/0)
        //    * checklists (by setting the 32 bits to 1/0)
        // -> could use long for 64 bits if needed later, or even multiple fields
        public int progress;

        // a quest is complete after finishing it at the npc and getting rewards
        public bool completed;

        // constructors
        public Quest(ScriptableQuest data)
        {
            hash = data.name.GetStableHashCode();
            progress = 0;
            completed = false;
        }

        // wrappers for easier access
        public ScriptableQuest data
        {
            get
            {
                // show a useful error message if the key can't be found
                // note: ScriptableQuest.OnValidate 'is in resource folder' check
                //       causes Unity SendMessage warnings and false positives.
                //       this solution is a lot better.
                if (!ScriptableQuest.All.ContainsKey(hash))
                    throw new KeyNotFoundException("There is no ScriptableQuest with hash=" + hash + ". Make sure that all ScriptableQuests are in the Resources folder so they are loaded properly.");
                return ScriptableQuest.All[hash];
            }
        }
        public string name => data.name;
        public int requiredLevel => data.requiredLevel;
        public string predecessor => data.predecessor != null ? data.predecessor.name : "";
        public long rewardGold => data.rewardGold;
        public long rewardExperience => data.rewardExperience;
        public ScriptableItem rewardItem => data.rewardItem;

        // events
        public void OnKilled(Player player, int questIndex, Entity victim) { data.OnKilled(player, questIndex, victim); }
        public void OnLocation(Player player, int questIndex, Collider location) { data.OnLocation(player, questIndex, location); }

        // completion
        public bool IsFulfilled(Player player) { return data.IsFulfilled(player, this); }
        public void OnCompleted(Player player) { data.OnCompleted(player, this); }

        // fill in all variables into the tooltip
        // this saves us lots of ugly string concatenation code. we can't do it in
        // ScriptableQuest because some variables can only be replaced here, hence we
        // would end up with some variables not replaced in the string when calling
        // Tooltip() from the data.
        // -> note: each tooltip can have any variables, or none if needed
        public string ToolTip(Player player)
        {
            // note: caching StringBuilder is worse for GC because .Clear frees the internal array and reallocates.
            // note: field0 tooltip part is done in the scriptable quest, because it
            //       might be a number, might be 'Yes'/'No', etc.
            StringBuilder tip = new StringBuilder(data.ToolTip(player, this));
            tip.Replace("{STATUS}", IsFulfilled(player) ? "<i>Complete!</i>" : "");

            // addon system hooks
            Utils.InvokeMany(typeof(Quest), this, "ToolTip_", tip);

            return tip.ToString();
        }
    }
}