// Copyright (c) 2012-2024 Wojciech Figat. All rights reserved.

using System;

namespace FlaxEngine
{
    /// <summary>
    /// Allows to declare order of the item in the editor.
    /// </summary>
    /// <seealso cref="System.Attribute" />
    [Serializable]
    [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property | AttributeTargets.Delegate | AttributeTargets.Event | AttributeTargets.Method)]
    public sealed class EditorOrderAttribute : Attribute
    {
        /// <summary>
        /// Requested order to perform layout on. Used to order the items.
        /// </summary>
        public int Order;

        private EditorOrderAttribute()
        {
        }

        /// <summary>
        /// Override display order in visual tree for provided model.
        /// </summary>
        /// <remarks>
        /// Current order is resolved runtime, and can change if custom editor class has changed.
        /// </remarks>
        /// <param name="order">The order.</param>
        public EditorOrderAttribute(int order)
        {
            Order = order;
        }
    }
}