xuanchi/XCEngine
1
1
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: sync api and planning docs

Browse Source
This commit is contained in:
ssdfasd
2026-04-08 16:07:03 +08:00
parent 08c3278e10
commit 31756847ab
1826 changed files with 44502 additions and 29645 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/api/XCEngine/Scripting/IScriptRuntime/TryGetAvailableScriptClasses.md
View File

@@ -22,9 +22,16 @@ virtual bool TryGetAvailableScriptClasses(
- 返回 `true`：后端支持类发现，且当前返回的数据可用。
- 返回 `false`：后端未初始化、当前没有这项能力，或发现流程失败。
调用前实现应清空 `outClasses`；`ScriptEngine::TryGetAvailableScriptClasses()` 会在此基础上继续过滤空类名并排序。
## 契约要求
- 实现应在调用前清空 `outClasses`。
- 返回的应该是“可绑定类”，而不是后端里任意可见类型；例如抽象类、工具类或不满足脚本基类约束的类型，通常不应暴露给调用方。
- 描述里应尽量带上稳定的 `assemblyName`，因为上层会基于它做过滤和重绑定。
- 接口本身不强制排序，但提供稳定顺序是推荐行为；`ScriptEngine::TryGetAvailableScriptClasses()` 会在此基础上继续过滤空类名并排序。
## 相关文档
- [IScriptRuntime](IScriptRuntime.md)
- [ScriptEngine::TryGetAvailableScriptClasses](../ScriptEngine/TryGetAvailableScriptClasses.md)
- [NullScriptRuntime::TryGetAvailableScriptClasses](../NullScriptRuntime/TryGetAvailableScriptClasses.md)
- [MonoScriptRuntime::TryGetAvailableScriptClasses](../Mono/MonoScriptRuntime/TryGetAvailableScriptClasses.md)