下载手机 APP

个人星火ts使用教程--如何调用自己创建的自定义类的内容

精华修改于2023/09/181410 浏览主题教程

前言：今天给大家带来一个ts相关的教程。因为官方的自定义脚本教程少了点东西。

像我当初看完还是不太懂怎么用。

条件：教程要求有一定的代码基础。不会的看了其实也不会

主旨：教一些会写ts代码但不熟悉星火环境的小伙伴，让他们在星火内写代码。

教学内容大纲：

1.游戏脚本触发流程

2.利用自定义脚本，在游戏开始时调用main函数

3.脚本的格式

4.脚本间的互相调用

5.按自己的需求写各种类、函数、变量来实现功能

6.其余注意事项

正文：

1.游戏脚本触发流程

之前用的cocos等引擎，通常是把脚本绑在场景的某个节点。然后开始之后会自动激活节点上的脚本，从而驱使游戏开始。

而星火的流程则是：创建自定义脚本文件+函数，添加一个游戏开始的触发器，来触发游戏的Main函数。同时，在代码结构上也与之前遇到的有些许不同，详见下文。

TapTap

2.利用自定义脚本，在游戏开始时调用main函数

先按官方教程V2触发器手写TS、lua代码 | 星火编辑器文档 (xd.com)先创建一个Mian脚本，并在触发编辑器内调用。

后面再根据自己的需要补充内容添加到Main函数中,将Main作为主函数去进行游戏的初始化等操作

TapTap

3.脚本的格式

3.1.之前写的脚本通常以类为最小单元，每个脚本基本都是一个类。格式通常都由引用声明、类的具体内容构成

TapTap

3.2.而星火的则略有不同。

星火的脚本需要声明在【当前项目名的同名模块】下，详见【项目根路径\script\trigger_module_main_1.ts】这个文件。

TapTap

且脚本内容为【命名空间】-【常规类class+数编交互函数】。

当然如果你的类只有类之间的交互，不用跟数编交互，则不用数编交互函数。

TapTap

命名空间的格式：module 空间名称{ }。

命名空间直接复制【项目根路径\script\trigger_module_main_1.ts】这个文件的命名空间即可

TapTap

数编交互函数的格式：export let 函数名:()=>void =():void=>{ }

举例：

如果函数名是 createrUnit,

变量为 unitName:string

返回值类型为Unit。

则函数为 ------ export let createrUnit:(unitName:string)=>Unit=(unitName:string):Unit=>{ }

TapTap

4.脚本间的互相调用

4.1.脚本之间的互相调用

因为各个类都在同一个命名空间下，类之间的互相调用不需要import。之间输入类名互相调用即可。

如果遇到同个命名空间下调用不了的情况，记得回到编辑器界面上保存。保存的时候编辑器会编译生成.lua.map文件。在拥有lua.map后才会视为在同个模块下。

TapTap

4.2.脚本调用星火自带库

脚本要调用星火自带库也许要在保存脚本后才可以。不保存的时候，调用星火自带的类、方法等会报错。

5.在之后，你就可以按之前在其他引擎上一样，写代码来实现功能了

如果不知道api的话，可以查看下文【6.1-用触发编辑器写函数，查看APi】

TapTap

6.其他注意事项

6.1先用触发编辑器写函数，查看APi

这一步的话，主要是当你写代码找不到API的时候，可以用该方法，看一下触编用的api是哪个，然后搬用它的API。

比如：

我不知道怎么生成单位，就在触发器写【生成单位】的函数

我不知道怎么隔时间触发动作，就在触发器写【隔时间做xx】的函数

TapTap

编辑完毕后保存，让编辑器编译。

触发编辑器编译的内容会出现在项目\script\trigger_module_main_1.ts 这个文件中。

实验后，这样获取api有时候会比在库里查找要快，因为你不能确定该函数在哪个类里。

TapTap

6.2.由于星火编辑器的实际流程是将ts转化为lua再运行，所以ts最好是严格模式，否则在某些情况下会出现莫名的bug。

比如：泛型函数一定要补齐类型。像这个<number>一定要补上，否则在转化为lua的时候，id会被填到number的位置上，而number的位置会留空，导致报错。

TapTap

6.3.前端代码：

前端与后端的结构相同。

不过后端的代码放在【项目/script/xxxxx】,前端的代码放在【项目/ui/script/xxxxx】

前后端代码的同一功能的api有时候名字是不同的。如果找不到对应的api，记得用6.1方法查找

目前总结的就这些，希望能帮到部分从其他引擎转过来的小伙伴

星火编辑器应用

7.9