// Copyright (c) 2026 GeWuYou
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// 
//     http://www.apache.org/licenses/LICENSE-2.0
// 
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

using GFramework.Game.Abstractions.enums;
using Godot;

namespace GFramework.Godot.ui;

/// <summary>
///     顶层 UI 行为类，继承自 CanvasItemUiPageBehaviorBase。
///     此类用于实现系统级弹窗行为，具有不可重入、最高优先级和模态特性。
/// </summary>
/// <typeparam name="T">泛型参数，表示拥有此行为的 CanvasItem 类型。</typeparam>
/// <param name="owner">拥有此行为的 CanvasItem 实例。</param>
/// <param name="key">用于标识此行为的唯一键。</param>
public class TopmostLayerUiPageBehavior<T>(T owner, string key) : CanvasItemUiPageBehaviorBase<T>(owner, key)
    where T : CanvasItem
{
    /// <summary>
    ///     获取当前 UI 行为所在的层级。
    ///     返回值为 UiLayer.Topmost，表示该行为位于最顶层。
    /// </summary>
    public override UiLayer Layer => UiLayer.Topmost;

    /// <summary>
    ///     指示此行为是否可重入。
    ///     返回值为 false，表示不可重入。
    /// </summary>
    public override bool IsReentrant => false;

    /// <summary>
    ///     指示此行为是否为模态行为。
    ///     返回值为 true，表示为模态行为，会阻止其他交互。
    /// </summary>
    public override bool IsModal => true;

    /// <summary>
    ///     指示此行为是否会阻塞输入。
    ///     返回值为 true，表示会阻塞用户输入。
    /// </summary>
    public override bool BlocksInput => true;
}