sbox-public/engine/Sandbox.Engine/Systems/Doo/Doo.Block.cs

namespace Sandbox;

using System.Text.Json.Serialization;

public partial class Doo
{
	/// <summary>
	/// Base class for all executable blocks within a Doo.
	/// </summary>
	[JsonDerivedType( typeof( DelayBlock ), "del" )]
	[JsonDerivedType( typeof( SetBlock ), "set" )]
	[JsonDerivedType( typeof( InvokeBlock ), "ivk" )]
	[JsonDerivedType( typeof( ReturnBlock ), "ret" )]
	[JsonDerivedType( typeof( ForBlock ), "for" )]
	[Expose]
	public partial class Block
	{
		/// <summary>
		/// Optional list of child blocks nested inside this block.
		/// </summary>
		[JsonIgnore( Condition = JsonIgnoreCondition.WhenWritingNull )]
		public List<Block> Body { get; set; }

		/// <summary>
		/// Returns a human-readable string describing this block for display in the editor.
		/// </summary>
		public virtual string GetNodeString()
		{
			return "unhandled block";
		}

		/// <summary>
		/// Returns true if this can have child nodes
		/// </summary>
		public virtual bool HasBody() => false;

		/// <summary>
		/// Reset this block to some sensible defaults. This is called when 
		/// the block is first added, so this is a good opportunity to set up default 
		/// values for properties.
		/// </summary>
		public virtual void Reset()
		{

		}

		/// <summary>
		/// Recursively collects all variable names referenced by this block and its children.
		/// </summary>
		public virtual void CollectArguments( HashSet<string> arguments )
		{
			if ( Body == null ) return;

			foreach ( var b in Body )
			{
				b.CollectArguments( arguments );
			}
		}
	}
}