docs(scripting): add baseline api reference and guide
This commit is contained in:
@@ -0,0 +1,39 @@
|
||||
# ScriptComponent::SetScriptClass
|
||||
|
||||
**命名空间**: `XCEngine::Scripting`
|
||||
|
||||
**类型**: `method`
|
||||
|
||||
**头文件**: `XCEngine/Scripting/ScriptComponent.h`
|
||||
|
||||
## 签名
|
||||
|
||||
```cpp
|
||||
void SetScriptClass(
|
||||
const std::string& namespaceName,
|
||||
const std::string& className);
|
||||
|
||||
void SetScriptClass(
|
||||
const std::string& assemblyName,
|
||||
const std::string& namespaceName,
|
||||
const std::string& className);
|
||||
```
|
||||
|
||||
## 作用
|
||||
|
||||
设置当前脚本组件绑定的托管类信息。
|
||||
|
||||
## 当前实现行为
|
||||
|
||||
- 两个重载都会先记录“之前是否已经有脚本类”。
|
||||
- 然后覆盖程序集名、命名空间和类名。
|
||||
- 只有在“之前没有脚本类,设置后有脚本类”时,才会主动调用 `ScriptEngine::Get().OnScriptComponentEnabled(this)`。
|
||||
|
||||
## 设计含义
|
||||
|
||||
当前实现把“首次绑定脚本类”视作一个启用事件,但并没有把“换到另一个脚本类”也当成完整重建流程。这是一个当前版本的真实边界,用户不应该误以为修改类名会自动完成热切换。
|
||||
|
||||
## 相关文档
|
||||
|
||||
- [HasScriptClass](HasScriptClass.md)
|
||||
- [OnEnable](OnEnable.md)
|
||||
Reference in New Issue
Block a user