From 879dd15ade3fef6965edd3af715e596b54eea3a6 Mon Sep 17 00:00:00 2001 From: hyde zhou Date: Wed, 21 Dec 2022 16:14:41 +0800 Subject: [PATCH] simplify effect settings (#13862) --- cocos/core/effect-settings.ts | 106 +--------------------------------- 1 file changed, 2 insertions(+), 104 deletions(-) diff --git a/cocos/core/effect-settings.ts b/cocos/core/effect-settings.ts index 13fc7caa6f..c04be172f2 100644 --- a/cocos/core/effect-settings.ts +++ b/cocos/core/effect-settings.ts @@ -27,56 +27,11 @@ import { legacyCC } from './global-exports'; declare const fsUtils: any; -/** - * @zh - * Settings 中的默认分组,通常与模块一一对应。 - * - * @en - * The default grouping in Settings, which usually corresponds to the module. - */ -enum Category { - PATH = 'path', - ENGINE = 'engine', - ASSETS = 'assets', - SCRIPTING = 'scripting', - PHYSICS = 'physics', - RENDERING = 'rendering', - LAUNCH = 'launch', - SCREEN = 'screen', - SPLASH_SCREEN = 'splashScreen', - ANIMATION = 'animation', - PROFILING = 'profiling', - PLUGINS = 'plugins', -} - -/** - * @zh - * 配置模块用于获取 settings.json 配置文件中的配置信息,同时你可以覆盖一些配置从而影响引擎的启动和运行,可参考 [game.init] 的参数选项说明。你可以通过 [settings] 访问此模块单例。 - * @en - * The Settings module is used to get the configuration information in the settings.json configuration file, - * and you can override some of the configuration to affect the launch and running of the engine, as described in the [game.init] parameter options. - * You can access this single instance of the module via [settings]. - */ export class EffectSettings { - static Category = Category; - - /** - * Initialization - * @internal - */ - init (path = '', overrides: Record = {}): Promise { - if (!legacyCC.rendering || !legacyCC.rendering.enableEffectImport) { + init (path = ''): Promise { + if (!legacyCC.rendering || !legacyCC.rendering.enableEffectImport || !path) { return Promise.resolve(); } - for (const categoryName in overrides) { - const category = overrides[categoryName]; - if (category) { - for (const name in category) { - this.overrideSettings(categoryName, name, category[name]); - } - } - } - if (!path) return Promise.resolve(); return new Promise((resolve, reject) => { if (!HTML5 && !path.startsWith('http')) { fsUtils.readArrayBuffer(path, (err: Error, arrayBuffer: ArrayBuffer) => { @@ -102,68 +57,11 @@ export class EffectSettings { } }); } - - /** - * @zh - * 覆盖一部分配置数据。 - * - * @en - * Override some configuration info in Settings module. - * - * @param category @en The category you want to override. @zh 想要覆盖的分组。 - * @param name @en The name of the configuration in the category you want to override. @zh 分组中想要覆盖的具体配置名称。 - * @param value @en The value of the configuration you want to override. @zh 想要覆盖的具体值。 - * - * @example - * ```ts - * console.log(settings.querySettings(Settings.Category.ASSETS, 'server')); // print https://www.cocos.com - * settings.overrideSettings(Settings.Category.ASSETS, 'server', 'http://www.test.com'); - * console.log(settings.querySettings(Settings.Category.ASSETS, 'server')); // print http://www.test.com - * ``` - */ - overrideSettings (category: Category | string, name: string, value: T) { - } - - /** - * @zh - * 查询配置模块中具体分组中的具体配置值。 - * - * @en - * Query specific configuration values in specific category in the settings module. - * - * @param category @en The name of category to query. @zh 想要查询的分组名称。 - * @param name @en The name of configuration in category to query. @zh 分组中想要查询的具体的配置名称。 - * @returns @en The value of configuration to query. @zh 想要查询的具体配置值。 - * - * @example - * ```ts - * console.log(settings.querySettings(Settings.Category.ENGINE, 'debug')); // print false - * ``` - */ - querySettings (category: Category | string, name: string): T | null { - return null; - } - - queryBuffer (): ArrayBuffer | null { - return this._data; - } - get data (): ArrayBuffer | null { return this._data; } - private _data: ArrayBuffer | null = null; } -export declare namespace Settings { - export type Category = typeof Category; -} - -/** - * @zh - * Settings 模块单例,你能通过此单例访问 settings.json 中的配置数据。 - * @en - * Settings module singleton, through this you can access the configuration data in settings.json. - */ export const effectSettings = new EffectSettings(); legacyCC.effectSettings = effectSettings;