SerializedTable_Base.cs

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

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

namespace Zor.SimpleBlackboard.Serialization
{
	/// <summary>
	/// <para>Base class for a serialized table.</para>
	/// <para>Inherit this for a special functionality.</para>
	/// <para>If you need a common functionality, inherit <see cref="StructGeneratedValueSerializedTable{T}"/>,
	/// <see cref="StructSerializedValueSerializedTable{T}"/>, <see cref="ClassGeneratedValueSerializedTable{T}"/>
	/// or <see cref="ClassSerializedValueSerializedTable{T}"/>.</para>
	/// </summary>
	public abstract class SerializedTable_Base : ScriptableObject
	{
		/// <summary>
		/// Type of serialized value in this table.
		/// </summary>
		[NotNull]
		public abstract Type valueType { [Pure] get; }

		/// <summary>
		/// Applies its properties to <paramref name="blackboard"/>.
		/// </summary>
		/// <param name="blackboard">Applies its properties to this.</param>
		public abstract void Apply([NotNull] Blackboard blackboard);

		/// <summary>
		/// Gets keys and their types and adds them to <paramref name="keys"/>.
		/// </summary>
		/// <param name="keys">Keys are added to this.</param>
		public abstract void GetKeys([NotNull] List<(string, Type)> keys);

		protected virtual void OnValidate()
		{
		}
	}
}