GFramework/GFramework.Game/Scene/Handler/SceneTransitionHandlerBase.cs
GeWuYou fb14d7122c docs(style): 更新文档中的命名空间导入格式
- 将所有小写的命名空间导入更正为首字母大写格式
- 统一 GFramework 框架的命名空间引用规范
- 修复 core、ecs、godot 等模块的命名空间导入错误
- 标准化文档示例代码中的 using 语句格式
- 确保所有文档中的命名空间引用保持一致性
- 更新 global using 语句以匹配正确的命名空间格式
2026-03-10 07:18:49 +08:00

55 lines
2.4 KiB
C#
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

// 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 GFramework.Game.Abstractions.Scene;
namespace GFramework.Game.Scene.Handler;
/// <summary>
/// 场景过渡处理器抽象基类,提供了 ISceneTransitionHandler 接口的默认实现。
/// 派生类只需重写必要的方法即可快速实现自定义处理器。
/// </summary>
public abstract class SceneTransitionHandlerBase : ISceneTransitionHandler
{
/// <summary>
/// 获取处理器适用的场景过渡阶段。
/// 默认为所有阶段BeforeChange 和 AfterChange
/// </summary>
public virtual SceneTransitionPhases Phases => SceneTransitionPhases.All;
/// <summary>
/// 获取处理器的执行优先级。
/// 派生类必须实现此属性以指定优先级。
/// </summary>
public abstract int Priority { get; }
/// <summary>
/// 判断处理器是否应该处理当前场景过渡事件。
/// 默认实现总是返回 true派生类可以重写此方法以添加自定义过滤逻辑。
/// </summary>
/// <param name="event">场景过渡事件。</param>
/// <param name="phases">当前执行的阶段。</param>
/// <returns>默认返回 true表示总是处理。</returns>
public virtual bool ShouldHandle(SceneTransitionEvent @event, SceneTransitionPhases phases)
=> true;
/// <summary>
/// 异步处理场景过渡事件。
/// 派生类必须实现此方法以定义具体的处理逻辑。
/// </summary>
/// <param name="event">场景过渡事件,包含切换的上下文信息。</param>
/// <param name="cancellationToken">取消令牌,用于支持操作取消。</param>
/// <returns>表示处理操作完成的异步任务。</returns>
public abstract Task HandleAsync(SceneTransitionEvent @event, CancellationToken cancellationToken);
}