API
Return to top
DataFile
编辑

工具 / DataFile

DataFile Class
​

数据文件获取工具

Table of contents ​

Methods
​

asyncLoad(fileName: string): Promise<string>
读取配置
exists(fileName: string): boolean
判断配置是否存在

Methods ​

asyncLoad
​

• Static asyncLoad(fileName): Promise<string>

读取配置

Parameters ​

fileName string配置文件的文件名 range: 依据文件名长度而定

Returns ​

Promise<string>配置内容

Precautions

配置文件不存在或文件名不合法将返回空字符串

使用示例:创建一个名为"DataFileExample"的脚本，并挂载到一个物体上。代码如下：
ts
@Component
export default class DataFileExample extends Script {
    protected async onStart(): `Promise`<`void`\> {
        let data = await DataFile.asyncLoad("level2_3");
        console.log(`data: ${data}`);
    }
}
@Component
export default class DataFileExample extends Script {
    protected async onStart(): `Promise`<`void`\> {
        let data = await DataFile.asyncLoad("level2_3");
        console.log(`data: ${data}`);
    }
}

exists
​

• Static exists(fileName): boolean

判断配置是否存在

Parameters ​

fileName string配置文件的文件名 range: 依据文件名长度而定

Returns ​

boolean配置是否存在

Precautions

文件名不合法将返回false，文件名称要求为a-z、A-Z、0-9、_

使用示例:创建一个名为"DataFileExample"的脚本，并挂载到一个物体上。代码如下：
ts
@Component
export default class DataFileExample extends Script {
    protected onStart(): void {
        let exists = DataFile.exist("level2_3");
        console.log(`exists: ${exists}`);
    }
}
@Component
export default class DataFileExample extends Script {
    protected onStart(): void {
        let exists = DataFile.exist("level2_3");
        console.log(`exists: ${exists}`);
    }
}