开发者自定义验证
工作台本身会对用户配置的数据(配置文件中dist.public
或者dist.server
下的配置项)进行简单的验证,开发者也可以对用户配置的数据进行验证。
说明
验证文件必须是一个js文件,文件里只有一个对象(不需要把它赋值给变量)。
对象的key
key对应配置文件中dist.public
或者dist.server
下的配置项的key。
值value
value为验证函数。在对数据进行验证的时候,会传入数据的值,并运行该函数进行验证。如果验证通过,则该函数返回true;如果验证不通过,则该函数返回验证不通过的原因(字符串)。
注意事项
1. `vaule`的类型必须为函数。
2. 需要将该自定义验证文件的路径设置为在配置表的`static.validateConfig`的值。
示例
示例中,如果用户通过工作台修改了配置表中dist.public.gameTitle
的值,且通过了工作台本身的验证,则使用示例中gameTitle
对应的函数对修改值进行验证。
// 验证文件 validateConfig.js
{
gameTitle: function(value) {
if (value.indexOf('标题') > -1) {
return '不能包含标题两个字';
}
return true;
}
}
配置表里的相关配置:
{
"static": {
"author": "Vincent",
"banner": "XXX.png",
"desc": "小恐龙快闪是一款躲避游戏",
"version": "1.0.4",
"name": "小恐龙快闪",
"tags": "分数|闪躲|手速",
// 当定义开发者自定义验证时,此项为必须
"validateConfig": "/example/validateConfig.js"
},
"dist": {
"public": {
"gameTitle": {
"value": "小恐龙快闪"
}
},
"server": {
"maxScore": 60
}
}
}