Class ScriptType

Source/Editor/Scripting/ScriptType.cs:716–1463

The structure that wraps the script type with support for native C++ scripts, managed C# scripts, Visual Scripts and custom scripts.

    /// The structure that wraps the script type with support for native C++ scripts, managed C# scripts, Visual Scripts and custom scripts.
    /// </summary>
    [HideInEditor]
    public readonly struct ScriptType : IEquatable<ScriptType>
    {
        private readonly Type _managed;
        private readonly IScriptType _custom;

        /// <summary>
        /// A <see cref="ScriptType" /> that is null (invalid).
        /// </summary>
        public static readonly ScriptType Null;

        /// <summary>
        /// A <see cref="ScriptType" /> that is System.Void.
        /// </summary>
        public static readonly ScriptType Void = new ScriptType(typeof(void));

        /// <summary>
        /// A <see cref="ScriptType" /> that is System.Object.
        /// </summary>
        public static readonly ScriptType Object = new ScriptType(typeof(object));

        /// <summary>
        /// A <see cref="ScriptType" /> that is FlaxEngine.Object.
        /// </summary>
        public static readonly ScriptType FlaxObject = new ScriptType(typeof(FlaxEngine.Object));

        /// <summary>
        /// Gets the type of the script as <see cref="System.Type"/>.
        /// </summary>
        public Type Type => _managed;

        /// <summary>
        /// Gets the type of the script as <see cref="FlaxEditor.Scripting.IScriptType"/>.
        /// </summary>
        public IScriptType IScriptType => _custom;

        /// <summary>
        /// Gets a type display name (eg. name of the class or enum without leading namespace).
        /// </summary>
        public string Name
        {
            get
            {
                if (_custom != null)
                    return _custom.Name;
                if (_managed == null)
                    return string.Empty;
                return _managed.GetTypeDisplayName();
            }
        }

        /// <summary>
        /// Gets a full namespace of the type.
        /// </summary>
        public string Namespace => _managed?.Namespace ?? _custom?.Namespace;

        /// <summary>
        /// Gets a full name of the type including leading namespace and any nested types names. Uniquely identifies the type and can be used to find it via <see cref="TypeUtils.GetType(string)"/>.