using GFramework.Core.utility;
using GFramework.Game.Abstractions.assets;
namespace GFramework.Game.assets;
///
/// 资源目录系统抽象基类,用于管理和注册游戏中的场景和资源。
/// 提供了统一的接口来注册和查询不同类型的资产(如游戏单元、模板、普通资源)。
/// 子类需要实现 方法以完成具体资产的注册逻辑。
///
public abstract class AbstractAssetCatalogUtility : AbstractContextUtility, IAssetCatalogUtility
{
private readonly Dictionary _assets = new();
private readonly Dictionary _scenePages = new();
private readonly Dictionary _sceneUnits = new();
///
/// 系统初始化时调用,用于触发资产注册流程。
/// 此方法会调用抽象方法 ,由子类提供实际注册逻辑。
///
protected override void OnInit()
{
RegisterAssets();
}
///
/// 抽象方法,必须在子类中重写。用于定义具体的资产注册逻辑。
/// 在此方法中应通过调用各种 Register 方法将资产信息添加到系统中。
///
protected abstract void RegisterAssets();
#region Register(内部 or Module 使用)
///
/// 注册场景单元到资产目录中
///
/// 场景单元的唯一标识键
/// 场景单元资源的路径
/// 当指定的键已存在时抛出异常
public void RegisterSceneUnit(string key, string path)
{
// 尝试添加场景单元,如果键已存在则抛出异常
if (!_sceneUnits.TryAdd(key, new AssetCatalog.SceneUnitId(path)))
throw new InvalidOperationException($"SceneUnit key duplicated: {key}");
}
///
/// 通过资产目录映射注册场景单元
///
/// 包含场景单元信息的资产目录映射对象
/// 当映射ID不是SceneUnitId类型或键已存在时抛出异常
public void RegisterSceneUnit(AssetCatalog.AssetCatalogMapping mapping)
{
// 验证映射ID是否为SceneUnitId类型
if (mapping.Id is not AssetCatalog.SceneUnitId sceneId)
throw new InvalidOperationException("Mapping ID is not a SceneUnitId");
// 尝试添加场景单元,如果键已存在则抛出异常
if (!_sceneUnits.TryAdd(mapping.Key, sceneId))
throw new InvalidOperationException($"Scene key duplicated: {mapping.Key}");
}
///
/// 注册场景页面模板
///
/// 场景页面的唯一标识键
/// 场景页面资源路径
/// 当键已存在时抛出异常
public void RegisterScenePage(string key, string path)
{
if (!_scenePages.TryAdd(key, new AssetCatalog.ScenePageId(path)))
throw new InvalidOperationException($"Template key duplicated: {key}");
}
///
/// 通过资产目录映射注册场景页面
///
/// 包含场景页面信息的资产目录映射对象
/// 当映射ID不是ScenePageId类型或键已存在时抛出异常
public void RegisterScenePage(AssetCatalog.AssetCatalogMapping mapping)
{
// 验证映射ID是否为ScenePageId类型
if (mapping.Id is not AssetCatalog.ScenePageId templateId)
throw new InvalidOperationException("Mapping ID is not a ScenePageId");
// 尝试添加场景页面,如果键已存在则抛出异常
if (!_scenePages.TryAdd(mapping.Key, templateId))
throw new InvalidOperationException($"Template key duplicated: {mapping.Key}");
}
///
/// 注册一个通用资源(Asset),使用指定的键和路径。
///
/// 唯一标识该资源的字符串键。
/// 该资源对应的资源路径。
/// 当键已存在时抛出异常。
public void RegisterAsset(string key, string path)
{
if (!_assets.TryAdd(key, new AssetCatalog.AssetId(path)))
throw new InvalidOperationException($"Asset key duplicated: {key}");
}
///
/// 根据映射对象注册一个通用资源(Asset)。
///
/// 包含键与ID映射关系的对象。
///
/// 当映射ID不是 类型或键重复时抛出异常。
///
public void RegisterAsset(AssetCatalog.AssetCatalogMapping mapping)
{
if (mapping.Id is not AssetCatalog.AssetId assetId)
throw new InvalidOperationException("Mapping ID is not a AssetId");
if (!_assets.TryAdd(mapping.Key, assetId))
throw new InvalidOperationException($"Asset key duplicated: {mapping.Key}");
}
#endregion
#region Query(对外)
///
/// 根据指定的键获取场景单元标识符
///
/// 用于查找场景单元的键值
/// 返回与指定键对应的场景单元标识符
public AssetCatalog.SceneUnitId GetSceneUnit(string key)
{
return _sceneUnits[key];
}
///
/// 根据指定的键获取场景页面标识符
///
/// 用于查找场景页面的键值
/// 返回与指定键对应的场景页面标识符
public AssetCatalog.ScenePageId GetScenePage(string key)
{
return _scenePages[key];
}
///
/// 获取指定键对应的通用资源ID。
///
/// 要查找的通用资源键。
/// 对应的通用资源ID。
/// 如果未找到指定键则抛出异常。
public AssetCatalog.AssetId GetAsset(string key)
{
return _assets[key];
}
///
/// 检查是否存在指定键的场景单元
///
/// 用于查找场景单元的键值
/// 存在返回true,否则返回false
public bool HasSceneUnit(string key)
{
return _sceneUnits.ContainsKey(key);
}
///
/// 检查是否存在指定键的场景页面
///
/// 用于查找场景页面的键值
/// 存在返回true,否则返回false
public bool HasScenePage(string key)
{
return _scenePages.ContainsKey(key);
}
///
/// 判断是否存在指定键的通用资源。
///
/// 要检查的通用资源键。
/// 若存在返回 true,否则返回 false。
public bool HasAsset(string key)
{
return _assets.ContainsKey(key);
}
#endregion
}