UnrealEngineUWP/Engine/Source/Programs/UnrealBuildTool/Configuration/UEBuildPlugin.cs

// Copyright Epic Games, Inc. All Rights Reserved.

using System.Collections.Generic;
using EpicGames.Core;

namespace UnrealBuildTool
{
	/// <summary>
	/// Stores information about a plugin that is being built for a target
	/// </summary>
	class UEBuildPlugin
	{
		/// <summary>
		/// Information about the plugin
		/// </summary>
		public PluginInfo Info;

		/// <summary>
		/// Modules that this plugin belongs to
		/// </summary>
		public List<UEBuildModuleCPP> Modules = new List<UEBuildModuleCPP>();

		/// <summary>
		/// Recursive
		/// </summary>
		public HashSet<UEBuildPlugin>? Dependencies;

		/// <summary>
		/// Whether the descriptor for this plugin is needed at runtime; because it has modules or content which is used, or because it references another module that does.
		/// </summary>
		public bool bDescriptorNeededAtRuntime;

		/// <summary>
		/// Whether this descriptor is referenced non-optionally by something else; a project file or other plugin. This is recursively applied to the plugin's references.
		/// </summary>
		public bool bDescriptorReferencedExplicitly;

		/// <summary>
		/// Chain of references to this plugin
		/// </summary>
		public string ReferenceChain;

		/// <summary>
		/// Constructor
		/// </summary>
		/// <param name="Info">The static plugin information</param>
		/// <param name="ReferenceChain">Chain of references to this plugin</param>
		public UEBuildPlugin(PluginInfo Info, string ReferenceChain)
		{
			this.Info = Info;
			this.ReferenceChain = ReferenceChain;
		}

		/// <summary>
		/// Accessor for the name of this plugin
		/// </summary>
		public string Name => Info.Name;

		/// <summary>
		/// Accessor for the file for this plugin
		/// </summary>
		public FileReference File => Info.File;

		/// <summary>
		/// Accessor for the child files for this plugin
		/// </summary>
		public List<FileReference> ChildFiles => Info.ChildFiles;

		/// <summary>
		/// Accessor for the type of the plugin
		/// </summary>
		public PluginType Type => Info.Type;

		/// <summary>
		/// Accessor for this plugin's root directory
		/// </summary>
		public DirectoryReference Directory => Info.Directory;

		/// <summary>
		/// Accessor for this plugin's descriptor
		/// </summary>
		public PluginDescriptor Descriptor => Info.Descriptor;

		/// <summary>
		/// Returns the name of this plugin for debugging
		/// </summary>
		/// <returns>Name of the plugin</returns>
		public override string ToString()
		{
			return Info.Name;
		}
	}
}