docs: update resources API docs
This commit is contained in:
52
docs/api/resources/resource-package/exists.md
Normal file
52
docs/api/resources/resource-package/exists.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Exists
|
||||
|
||||
检查指定文件是否存在于资源包中。
|
||||
|
||||
## 方法签名
|
||||
|
||||
```cpp
|
||||
bool Exists(const Containers::String& relativePath) const;
|
||||
```
|
||||
|
||||
## 详细描述
|
||||
|
||||
检查资源包中是否存在指定相对路径的文件。使用斜杠 `/` 作为路径分隔符,支持带或不带文件扩展名的路径。
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数名 | 类型 | 描述 |
|
||||
|--------|------|------|
|
||||
| `relativePath` | `const Containers::String&` | 文件的相对路径,相对于包内根目录 |
|
||||
|
||||
## 返回值
|
||||
|
||||
| 类型 | 描述 |
|
||||
|------|------|
|
||||
| `bool` | 文件存在返回 `true`,不存在返回 `false` |
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
ResourcePackage package;
|
||||
package.Open("assets/resources.xcp");
|
||||
|
||||
// 检查不同类型的文件
|
||||
if (package.Exists("textures/player.png")) {
|
||||
printf("Player texture exists\n");
|
||||
}
|
||||
|
||||
if (package.Exists("audio/bgm_main.ogg")) {
|
||||
printf("Background music exists\n");
|
||||
}
|
||||
|
||||
// 使用通配符检查(当前实现会按字面量匹配)
|
||||
if (package.Exists("shaders/*")) {
|
||||
// 注意:当前实现不支持真正的通配符匹配
|
||||
}
|
||||
```
|
||||
|
||||
## 相关方法
|
||||
|
||||
- [Read](read.md) - 读取文件内容
|
||||
- [GetSize](getsize.md) - 获取文件大小
|
||||
- [Enumerate](enumerate.md) - 枚举文件
|
||||
Reference in New Issue
Block a user