Files
plugin-library/Assets/10.StoryEditor/README.md

30 lines
1.7 KiB
Markdown
Raw Normal View History

<h1>可视化剧本编辑器</h1>
<div style="line-height:2.5">
<h3>创建剧本</h3>
1. 点击Unity顶部菜单栏`Evo/剧本编辑器/创建剧本`
2. 在打开的小窗口中选择要创建剧本的包,然后点击`创建剧本`
3. 新创建的剧本会在`*/Modules/[包体ID]/Main/Res/Graphs`路径下生成
<h3>编辑剧本</h3>
1. 双击剧本打开可视化编辑窗口
2. 右键空白处可以新建节点(节点类型详见后续附录)
3. 按住Exit端口或其他Output端口可以拖拽出一条连接线将其拖到任一节点的Enter端口或其他Input端口可以在两个节点之间建立连接原则上禁止将一个节点的Exit端口与其自身的Enter端口相连其造成的死循环问题自负
4. 原则上剧本需要从`Begin节点`连接到`End节点`
5. 剧本会自动保存但建议在关闭窗口前Ctrl+S进行手动保存以防万一
<h3>导出剧本</h3>
1. 导出剧本前需要先选择`资源加载方式`,为此需要创建一个继承`IResource`接口的类实现接口后选中剧本即可在Inspector面板选择资源加载方式
2. 选择资源加载方式后,点击`导出`即可在同级目录下生成剧本的json文件
<h3>使用剧本</h3>
1. 使用前需要先调用ScriptPlayer.Init初始化剧本执行模块并根据需要将字幕组件SpriteRenderer和音频组件AudioSource传入加载器IResource是必传项
2. 确保剧本的json文件能够被加载到例如热更环境下需要将其打包到对应的AB包中随后调用ScriptPlayer.Play即可播放剧本
3. 在场景结束时需要调用ScriptPlayer.Release释放资源以防止内存泄漏
</div>