docs: update resources API docs
This commit is contained in:
51
docs/api/resources/resource-package/open.md
Normal file
51
docs/api/resources/resource-package/open.md
Normal file
@@ -0,0 +1,51 @@
|
||||
# Open
|
||||
|
||||
打开资源包文件。
|
||||
|
||||
## 方法签名
|
||||
|
||||
```cpp
|
||||
bool Open(const Containers::String& packagePath);
|
||||
```
|
||||
|
||||
## 详细描述
|
||||
|
||||
尝试打开指定路径的资源包文件并解析其文件头和清单。如果文件不存在、格式无效或版本不匹配,方法将返回 `false`。
|
||||
|
||||
包文件格式验证包括:
|
||||
1. 检查魔数是否为 "XCRP"
|
||||
2. 验证版本号是否为支持的版本
|
||||
3. 读取并解析文件清单
|
||||
|
||||
## 参数
|
||||
|
||||
| 参数名 | 类型 | 描述 |
|
||||
|--------|------|------|
|
||||
| `packagePath` | `const Containers::String&` | 资源包文件的完整路径或相对路径 |
|
||||
|
||||
## 返回值
|
||||
|
||||
| 类型 | 描述 |
|
||||
|------|------|
|
||||
| `bool` | 成功打开返回 `true`,失败返回 `false` |
|
||||
|
||||
## 示例
|
||||
|
||||
```cpp
|
||||
ResourcePackage package;
|
||||
|
||||
// 使用相对路径打开
|
||||
if (package.Open("assets/resources.xcp")) {
|
||||
// 包已成功打开
|
||||
}
|
||||
|
||||
// 使用绝对路径打开
|
||||
if (package.Open("D:/Game/assets/resources.xcp")) {
|
||||
// 包已成功打开
|
||||
}
|
||||
```
|
||||
|
||||
## 相关方法
|
||||
|
||||
- [Close](close.md) - 关闭资源包
|
||||
- [IsValid](isvalid.md) - 检查包有效性
|
||||
Reference in New Issue
Block a user