下载手机 APP

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

修改于2024/03/15900 浏览主题教程

2024/03/15更新声明：

修改脚本文件名称，之前命名是Main。有人开发时用main作为文件名称，导致与项目自带的main文件重名。
跟其他开发者沟通后发现新流程，链接如下：

个人星火ts使用教程--如何调用自己的ts脚本(新流程) - 星火编辑器主题教程 - TapTap 星火编辑器论坛

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

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

教学内容大纲：

游戏脚本触发流程
触发流程具象化--利用自定义脚本，在游戏开始时调用main函数
脚本的格式
常规ts脚本格式
星火脚本格式
命名空间格式
数遍交互函数格式
脚本调用
自定义脚本的互相调用
自定义脚本调用星火自带库脚本
按自己的需求写各种类、函数、变量来实现功能
另一种简便化的调用方法：自定义脚本。
其余注意事项
查找星火自带库API的一种方法
TsToLua的一些注意事项
前端代码位置

正文：

1.游戏脚本触发流程

之前用的cocos等引擎，通常是把脚本绑在场景的某个节点。然后开始之后会自动激活节点上的脚本，从而驱使游戏开始。而星火的流程则是：创建自定义脚本文件+函数，添加一个游戏开始的触发器，来触发游戏的Main函数。同时，在代码结构上也与之前遇到的有些许不同，详见下文。

TapTap

2.触发流程具象化--利用自定义脚本，在游戏开始时调用main函数

2.1.具体流程说明：

创建自定义脚本。（具体操作详见下文，此处先讲整体流程+概念）
在自定义脚本下创建自定义函数。
在对应的ts脚本内实现对应内容，再写一个 export let 函数来调用对应的方法
[自定义脚本文件下的自定义函数] 与 [export let 函数] 对应。调用 [export let 函数] 时，会调用ts类中实际生效的函数，从而实现各种类里面的方法。
所以，只需要在触发器内调用[自定义函数]，就可以调用到ts类中的实际函数
其中，[自定义函数]和[export let 函数]作为[触发编辑器]与[ts脚本]互相关联的接口

TapTap

调用流程图

TapTap

流程图具象化

2.2.具体操作

TapTap

点击文件夹[我的地图]右侧的+号，选中[新建自定义脚本文件]

TapTap

输入脚本名称（不能与项目原有的文件重名），比如main

TapTap

选中文件，右侧文件模式改成[ts]

TapTap

找到对应的路径，打开ts文件。（不能与项目原有的文件重名），比如main

TapTap

写具体游戏需求+export let 函数，具体格式查看下方3.2星火脚本格式

TapTap

另一个脚本功能参考，上面是具体的内容，下面是转接口

TapTap

有开发者反馈按上述步骤做了会出现如下报错。后来发现他的脚本文件名称与项目自带的main文件重名了。

3.脚本的格式

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

TapTap

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

且脚本内容为【命名空间】-【常规类class+数编交互函数】。当然如果你的类只有类之间的交互，不用跟数编交互，则不用数编交互函数。

TapTap

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

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

TapTap

3.2.2.数编交互函数的格式：export let 函数名:函数类型 =具体函数

举例：

TapTap

上述函数的结构如下：

函数名 createrUnit

类型 (unitName:string)=>Unit

具体函数 (unitName:string):Unit=>{ }

4.脚本间的调用

4.1.自定义脚本的互相调用：

因为所有类都在同一个module下，所以类之间的互相调用不需要import。直接输入类名互相调用即可。如果遇到同个命名空间下调用不了的情况，记得回到编辑器界面上保存。保存的时候编辑器会编译生成.lua.map文件。在拥有lua.map后才会视为在同个module下。

TapTap

4.2.自定义脚本调用星火自带库脚本：

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

5.上述讲了【调用的流程】【脚本的格式】【脚本间怎么互相调用】。在之后，你就可以按之前在其他引擎上一样，写代码来实现功能了。如果不知道api的话，可以查看下文【6.1-用触发编辑器写函数，查看APi】

TapTap

6.另一种简便化的调用方法：自定义脚本

使用说明：这种方式是直接在触发器内使用【动作】--【自定义脚本】。在输入框内输入想要的代码即可调用。

优点：这种方式不需要在函数下声明脚本也可以生效。

TapTap

缺点：在写一些需要参数的函数时，可能不知道参数的名称叫啥，需要到trigger_module_main_1.ts查看变量名称。而自定义函数则可以直接拖拽上面的变量来填空。

在技能、buff等数遍的时候，很难查找到对应的变量名称，因此一般我都用自定义函数，而不用自定义脚本

TapTap

TapTap

7.其他注意事项

7.1.查找星火自带库的API的一种方法。

先用触发编辑器写函数，查看APi这一步的话，主要是当你写代码找不到API的时候，可以用该方法，看一下触编用的api是哪个，然后搬用它的API。比如：我不知道怎么生成单位，就在触发器写【生成单位】的函数我不知道怎么隔时间触发动作，就在触发器写【隔时间做xx】的函数

TapTap

编辑完毕后保存，让编辑器编译。触发编辑器编译的内容会出现在项目\script\trigger_module_main_1.ts 这个文件中。实验后，这样获取api有时候会比在库里查找要快，因为你不能确定该函数在哪个类里。

TapTap

7.2.TsToLua的一些注意事项。

由于星火编辑器的实际流程是将ts转化为lua再运行，所以ts最好是严格模式，否则在某些情况下会出现莫名的bug。比如：泛型函数一定要补齐类型。像这个<number>一定要补上，否则在转化为lua的时候，id会被填到number的位置上，而number的位置会留空，导致报错。

TapTap

7.3.前端代码：前端与后端的结构相同。不过后端的代码放在【项目/script/xxxxx】,前端的代码放在【项目/ui/script/xxxxx】前后端代码的同一功能的api有时候名字是不同的。如果找不到对应的api，记得用6.1方法查找

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

星火编辑器应用

7.9