PatchSettings
Coding Style wiki
PatchSettings 是 AssetLoader 的補丁設定類(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
| 名稱 | 型別 | 預設值 | 說明 |
|---|---|---|---|
| appCfgName | string | "AppInfo" | APP 配置檔的名稱。 |
| appCfgExtension | string | ".json" | APP 配置檔的副檔名。 |
Patch Config Settings
| 名稱 | 型別 | 預設值 | 說明 |
|---|---|---|---|
| patchCfgName | string | "PatchInfo" | 補丁配置檔的名稱。 |
| patchCfgExtension | string | ".json" | 補丁配置檔的副檔名。 |
Bundle URL Config Settings
| 名稱 | 型別 | 預設值 | 說明 |
|---|---|---|---|
| bundleUrlCfgCipher | byte | (不公開) | 佈署配置檔(資源請求端點)的 XOR 加解密金鑰(配合 CIPHER_HEADER 檔頭使用)。 |
| bundleUrlCfgName | string | "CdnConfig" | 佈署配置檔(資源請求端點)的名稱。 |
| bundleUrlCfgExtension | string | ".dat" | 佈署配置檔(資源請求端點)的副檔名。 |
Folder Settings
| 名稱 | 型別 | 預設值 | 說明 |
|---|---|---|---|
| rootFolderName | string | "CDN" | CDN 輸出資源的根資料夾名稱。 |
| dlcFolderName | string | "DLC" | DLC 資源包存放的子資料夾名稱。 |
注意 副檔名欄位必須包含點號(如 .dat、.cfg、.json)。
常數
| 常數 | 型別 | 值 | 說明 |
|---|---|---|---|
| CIPHER_HEADER | short | (不公開) | 加密配置檔的檔頭標記。佈署配置檔加密時會寫入此 2 位元組檔頭,讀取時據此判斷是否需解密。 |
| META_FILE_EXTENSION | string | ".meta" | META 檔案副檔名。 |
| APP_CFG_BAK_EXTENSION | string | ".bak" | APP 配置檔備份(Backup)副檔名。 |
| PATCH_CFG_BAK_EXTENSION | string | ".bak" | 補丁配置檔備份(Backup)副檔名。 |
| BUNDLE_IP | string | "bundle_ip" | 佈署配置檔中「資源請求端點」的鍵名。 |
| BUNDLE_FALLBACK_IP | string | "bundle_fallback_ip" | 佈署配置檔中「資源備援請求端點」的鍵名。 |
| STORE_LINK | string | "store_link" | 佈署配置檔中「商店連結」的鍵名。 |
提醒 BUNDLE_IP、BUNDLE_FALLBACK_IP、STORE_LINK 可作為 BundleConfig.GetValueFromUrlCfg 的鍵名參數使用。