跳到主要内容
版本:v3

PatchSettings

重要 注意 提醒

Coding Style wiki


PatchSettingsAssetLoader 的补丁设置类(ScriptableObject),集中定义热更新与资源包相关的配置文件名称、扩展名、加密密钥与输出文件夹名称等全局设置,运行时通过静态属性 settings 访问。

命名空间OxGFrame.AssetLoader
类型public class(继承 ScriptableObject
源码PatchSettings.cs
using OxGFrame.AssetLoader;

提醒 可通过编辑器菜单 Assets → Create → OxGFrame → Create Settings → Create Patch Settings in Resources 创建 PatchSettings.asset 自定义设置资产(将自动创建于所选文件夹的 Resources 子文件夹内);未创建时一律使用默认值。

属性

settings

public static PatchSettings settings { get; }

返回值

PatchSettings — 全局设置实例(单例)。

说明

获取全局设置实例。首次访问时从 Resources 加载名为 PatchSettings 的设置资产;未找到资产时,自动以默认值创建实例(并输出使用默认设置的日志)。

示例

// 组合 APP 配置文件的完整文件名(默认 AppInfo.json)
string appCfgFileName = $"{PatchSettings.settings.appCfgName}{PatchSettings.settings.appCfgExtension}";

字段

App Config Settings

名称类型默认值说明
appCfgNamestring"AppInfo"APP 配置文件的名称。
appCfgExtensionstring".json"APP 配置文件的扩展名。

Patch Config Settings

名称类型默认值说明
patchCfgNamestring"PatchInfo"补丁配置文件的名称。
patchCfgExtensionstring".json"补丁配置文件的扩展名。

Bundle URL Config Settings

名称类型默认值说明
bundleUrlCfgCipherbyte(不公开)部署配置文件(资源请求端点)的 XOR 加解密密钥(配合 CIPHER_HEADER 文件头使用)。
bundleUrlCfgNamestring"CdnConfig"部署配置文件(资源请求端点)的名称。
bundleUrlCfgExtensionstring".dat"部署配置文件(资源请求端点)的扩展名。

Folder Settings

名称类型默认值说明
rootFolderNamestring"CDN"CDN 输出资源的根文件夹名称。
dlcFolderNamestring"DLC"DLC 资源包存放的子文件夹名称。

注意 扩展名字段必须包含点号(如 .dat.cfg.json)。

常量

常量类型说明
CIPHER_HEADERshort(不公开)加密配置文件的文件头标记。部署配置文件加密时会写入此 2 字节文件头,读取时据此判断是否需解密。
META_FILE_EXTENSIONstring".meta"META 文件扩展名。
APP_CFG_BAK_EXTENSIONstring".bak"APP 配置文件备份(Backup)扩展名。
PATCH_CFG_BAK_EXTENSIONstring".bak"补丁配置文件备份(Backup)扩展名。
BUNDLE_IPstring"bundle_ip"部署配置文件中「资源请求端点」的键名。
BUNDLE_FALLBACK_IPstring"bundle_fallback_ip"部署配置文件中「资源备用请求端点」的键名。
STORE_LINKstring"store_link"部署配置文件中「商店链接」的键名。

提醒 BUNDLE_IPBUNDLE_FALLBACK_IPSTORE_LINK 可作为 BundleConfig.GetValueFromUrlCfg 的键名参数使用。