ClassGeneratedValueSerializedTable.cs

// Copyright (c) 2020-2023 Vladimir Popov zor1994@gmail.com https://github.com/ZorPastaman/Simple-Blackboard

using System;
using System.Collections.Generic;
using System.Runtime.CompilerServices;
using JetBrains.Annotations;
using UnityEngine;
using Zor.SimpleBlackboard.Core;
using Zor.SimpleBlackboard.Helpers;

namespace Zor.SimpleBlackboard.Serialization
{
	/// <summary>
	/// <para>Serialized table that has set keys and generates class values at runtime.</para>
	/// <para>Inherit this class and override <see cref="GetValue"/> to get this functionality.</para>
	/// </summary>
	/// <typeparam name="T">Class type of the generated value.</typeparam>
	public abstract class ClassGeneratedValueSerializedTable<T> : GeneratedValueSerializedTable_Base where T : class
	{
#pragma warning disable CS0649
		[SerializeField] private string[] m_Keys;
#pragma warning restore CS0649

		/// <inheritdoc/>
		public sealed override Type valueType
		{
			[MethodImpl(MethodImplOptions.AggressiveInlining), Pure]
			get => typeof(T);
		}

		/// <summary>
		/// How many keys are contained in this <see cref="ClassGeneratedValueSerializedTable{T}"/>.
		/// </summary>
		public int keysCount
		{
			[MethodImpl(MethodImplOptions.AggressiveInlining), Pure]
			get => m_Keys.Length;
		}

		/// <summary>
		/// Gets a key at the <paramref name="index"/>.
		/// </summary>
		/// <param name="index"></param>
		/// <returns>
		/// A property as a pair of <see cref="string"/> and <typeparamref name="T"/>.
		/// </returns>
		[MethodImpl(MethodImplOptions.AggressiveInlining), NotNull, Pure]
		public string GetKey(int index)
		{
			return m_Keys[index];
		}

		/// <summary>
		/// Sets the <paramref name="key"/> at the <paramref name="index"/>.
		/// </summary>
		/// <param name="key"></param>
		/// <param name="index"></param>
		[MethodImpl(MethodImplOptions.AggressiveInlining)]
		public void SetKey([NotNull] string key, int index)
		{
			m_Keys[index] = key;
		}

		/// <summary>
		/// Sets <paramref name="keys"/>.
		/// </summary>
		/// <param name="keys"></param>
		public void SetKeys([NotNull] string[] keys)
		{
			int count = keys.Length;

			if (m_Keys.Length != count)
			{
				m_Keys = new string[count];
			}

			Array.Copy(keys, 0, m_Keys, 0, count);
		}

		/// <inheritdoc/>
		public sealed override void Apply(Blackboard blackboard)
		{
			for (int i = 0, count = m_Keys.Length; i < count; ++i)
			{
				blackboard.SetClassValue(new BlackboardPropertyName(m_Keys[i]), GetValue());
			}
		}

		/// <inheritdoc/>
		public sealed override void GetKeys(List<(string, Type)> keys)
		{
			int count = m_Keys.Length;
			ListHelper.EnsureCapacity(keys, count);

			for (int i = 0; i < count; ++i)
			{
				keys.Add((m_Keys[i], valueType));
			}
		}

		/// <summary>
		/// Gets a generated value.
		/// </summary>
		/// <returns>Generated value.</returns>
		protected abstract T GetValue();
	}
}