组件及属性
名称 | 描述 |
---|---|
对象 | \ |
类型 | 描述类型的类型,当使用Typeof时返回该类型 |
实体 | 实体是所有组件的载体,组件必须附加到实体上才能产生实例 |
属性 | \ |
事件ID | 指代某个事件 |
类型枚举 | \ |
布尔 | \ |
整数 | \ |
浮点数 | \ |
64位整数 | 整数类型,64位带符号整型 |
数字 | \ |
字符串 | \ |
颜色 | 描述RGBA颜色的类型,每个通道取值范围0~255 |
UUID | 唯一标识 |
资产配置ID | \ |
资产ID | \ |
剧情对话ID | \ |
藏品资产ID | 藏品ID,用于资源信息收集 |
道具ID | 道具ID(当版本只有武器ID) |
物件ID | 描述物件的类型,需通过SceneEditPrefab配置表解析后再加载 |
人形模型ID | \ |
列表 | \ |
列表模板 | \ |
字典 | 字典数据容器,数据元素是一对Key、Value |
字典模板 | 字典数据模板,可通过T1、T2指定内容的类型 |
列表或字典 | \ |
类型列表 | \ |
类型或类型列表 | \ |
二维向量 | \ |
三维向量 | \ |
四元数 | 四元数是一个特殊的四维向量,仅用于表示旋转 |
条件 | 条件是特殊的Bool类型 |
条件列表 | \ |
方向点[已废弃] | \ |
本地化字符串 | \ |
网格资产ID | 用以描述网格资产的类型 |
预设角色类型 | 自定义角色资源ID |
动画资源ID | 自定义动画资源ID |
材质资产ID | \ |
碰撞形状ID | 碰撞资源ID |
贴图资产ID | \ |
图集精灵ID | 用以描述图集精灵资产的ID |
脚本ID | 用以描述脚本资产的ID |
静态脚本ID | 用以描述静态脚本资产的ID |
自定义界面ID | 用以描述自定义界面资产的ID |
自定义界面控件ID | 用以描述自定义界面资产中的控件的ID,必须和CustomHudID一起才能唯一确定一个控件ID |
预置体ID | 用以描述预置资产体的ID |
音频ID | 用以描述音频资产的ID |
配置表ID | 用以描述配置表资产的ID |
特效ID | 用以描述特效资产的ID |
动画控制器ID | 用以描述动画控制器资产的ID |
粒子资产ID | \ |
布尔列表 | \ |
整数列表 | \ |
整数或整数列表 | \ |
小数列表 | \ |
字符串列表 | \ |
三维向量列表 | \ |
本地化文本列表 | \ |
技能列表[已废弃] | \ |
技能ID列表 | \ |
组件基类 | \ |
实体类 | 实体基础组件,所有组件都会组合该组件 |
地面 | 地面组件,无法修改任何属性,仅用于检测函数 |
变换 | 位置旋转缩放和父子关系记录 |
可见组件 | 表示是否可以设置可见性 |
基础外观 | \ |
碰撞 | \ |
逻辑实体或者PrefabID | 逻辑实体或者PrefabID |
可挂载动画控制器的实体组件 | 管理动画控制器与资源 |
桥接渲染组件 | 桥接渲染组件,用于使用内置模型资源进行呈现 |
合并子物件节点渲染组件 | \ |
自定义渲染组件 | 自定义渲染组件,用于使用自定义模型资源进行呈现 |
可被瞄准的实体组件 | \ |
实体容器 | \ |
游戏实体 | \ |
可排名实体组件 | \ |
可积分实体组件 | \ |
队伍实体组件 | 游戏中的队伍实体,每支队伍一个 |
可战斗实体组件 | 可战斗实体,能够进行攻击、受击、击杀等 |
能够使用FFBuff系统的实体 | 可以添加buff,移除buff,获得已加的buff列表 |
生成器实体组件 | \ |
单位生成器支持的单位实体组件 | \ |
每回合重置组件 | \ |
可公式化属性的实体组件 | 可公式化属性的实体 |
玩家实体组件 | 游戏中的玩家实体,每位用户一个 |
关卡物件 | \ |
关卡物件列表 | \ |
特效类型枚举 | 特效 |
图标类型 | 图标 |
音效类型 | 音效 |
排序方式枚举 | 排序方式:升序忽略零值、降序、升序 |
物品枚举 | 道具类型 |
图标实体[已废弃] | \ |
文本实体[已废弃] | \ |
特效实体[已废弃] | \ |
玩家列表 | \ |
队伍列表 | \ |
实体列表 | \ |
波次类型 | 波次 |
生成器间隔类型 | 每波间隔时间 |
Playable | 可播放实体 |
Loopable | 可循环组件 |
音效实体[已废弃] | \ |
音效实体列表[已废弃] | \ |
音效实体或列表[已废弃] | \ |
自定义路径 | \ |
路径点 | \ |
武器类型 | 武器类型 |
子弹类型 | 子弹类型 |
单位生成器组件 | \ |
道具资产基类 | \ |
自定义物件 | 一个空白物件组件,可以配合渲染器组件、碰撞器组件等使用。 |
NPC物件 | NPC物件 |
Playable列表 | \ |
坐标系 | \ |
比赛结果类型 | 比赛结果 |
字体枚举 | 字体枚举 |
文本实体组件 | 文本实体表示一个显示的文本 |
图标实体组件 | 图标实体表示一个显示的图标 |
特效实体组件 | 特效实体表示一个显示的特效 |
粒子效果 | \ |
时间戳本地化字符串 | 时间戳本地化字符串 |
时间戳格式化显示样式 | 时间戳格式化显示样式 |
三态开关 | \ |
骨架部位 | \ |
载具ID | \ |
音效实体组件 | 音效实体表示一个播放的音效 |
音效实体列表 | \ |
SoundEntity或SoundEntity数组 | \ |
Bot难度枚举 | Bot难度枚举 |
整数Map | \ |
玩家或NPC | \ |
物品列表 | \ |
可以挂载子节点的实体 | 可以挂载子节点的实体 |
中途退出配置 | \ |
字符串或本地化字符串 | \ |
平台类型 | 平台类型 |
基础数据类型别名 | \ |
状态码 | 错误码枚举 |
玩家或Transform实体 | 指代玩家实体、Transform实体类型的别名 |
自定义曲线路径路点 | \ |
自定义曲线路径类型 | \ |
玩家账号列表 | \ |
状态码列表 | \ |
组合 | \ |
自定义曲线路径 | \ |
\ | |
\ | |
语言类型 | \ |
事件
名称 | 描述 |
---|---|
当游戏开始时 | 在游戏开始时触发,服务端会早于客户端一段时间准备好 |
当游戏结束时 | 在游戏结束时触发,游戏在服务器上结束前触发此事件 |
当实体创建时 | 在当前实体创建后触发 |
当实体销毁 | 在当前实体销毁前触发 |
当实体可用 | 在当前实体可用后触发 |
当实体不可用 | 在当前实体不可用后触发 |
当生成器生成实体 | 在生成器生成实体时触发 |
当更新时 | 在逻辑帧更新时触发,根据使用平台和设置,该事件触发频率会有不同 |
当剧情对话开始时 | 在剧情对话开始播放时触发 |
当剧情对话结束时 | 在剧情对话结束时触发 |
当触发剧情对话选项时 | 在剧情对话中选择了选项后触发 |
API
名称 | 描述 |
---|---|
所有玩家 | 获取当前游戏中所有玩家,返回玩家列表。 |
所有队伍 | 获取当前游戏中所有队伍,返回队伍列表。 |
设置玩家是否可以移动 | 设置全体玩家是否可以移动 |
打印提示 | 打印日志到控制台 |
打断 | 打断当前循环过程,退出循环 |
继续下一个 | 跳过剩余的循环体内容,直接进入下一次循环 |
返回 | 结束当前执行过程,直接返回调用位置,可以携带数据一并返回 |
等待直到下一帧 | 等待至下一逻辑帧开始时 |
在服务器上,开启低帧率模式,将会等待更长时间 | |
在客户端上,等待时间受设备性能和当前帧逻辑复杂程度影响 | |
使用该API的函数需要声明为async | |
等待 | 等待一定时间,使用该API的函数需要声明为async。 |
非 | 逻辑取反,输入值:真或假,返回值:假或真 |
构建一个颜色值 | 构建一个颜色值,透明度固定为十进制255,先将通道转换为二进制数,每8位代表一个通道,按照R、G、B、透明度拼接,然后将该二进制数转换为Int32型返回 |
判空 | 判断对象是否为空 |
获取服务器时间戳 | 获取服务器时间戳 |
获取服务器区域 | 获取服务器区域 |
设置属性 | 设置目标实体的属性值,需要该属性已经被定义过 |
获取属性 | 获取一个实体的属性值 |
创建图标[已废弃] | 使用指定的图标类型创建一个图标,有更多需要设置的属性时则通过实体进一步设置它的实体属性(已废弃,请使用CreateLevelObject) |
移除图标[已废弃] | 移除指定的图标(已废弃,请使用DeleteEntity) |
创建文本[已废弃] | 使用指定的文本内容创建一个文本,有更多需要设置的属性时则通过实体进一步设置它的实体属性(已废弃,请使用CreateLevelObject) |
移除文本[已废弃] | 移除指定的文本(已废弃,请使用DeleteEntity) |
创建特效[已废弃] | 使用指定的特效类型创建一个图标,有更多需要设置的属性时则通过实体进一步设置它的实体属性(已废弃,请使用CreateEffect) |
创建特效[已废弃] | 使用指定的特效类型创建一个图标,有更多需要设置的属性时则通过实体进一步设置它的实体属性 |
移除特效[已废弃] | 移除指定的特效(已废弃,请使用DeleteEntity) |
播放音效[已废弃] | 播放指定的音效,有更多需要设置的属性时则通过实体进一步设置它的实体属性(已废弃,请使用CreateSound) |
暂停音效[已废弃] | 中断播放中的音效实体(已废弃,请使用PauseSound) |
播放音效[已废弃] | 继续播放音效,可选择是否从头开始播放(已废弃,请使用ResumeSound) |
通知客户端播放音效 | 通知目标玩家的客户端播放音效 |
通知客户端显示飘字 | 通知目标玩家的客户端显示飘字 |
此实体 | 返回当前脚本绑定的实体 |
获取全局实体 | 获取该局游戏全局实体 |
传送[已废弃] | 把玩家传送到具体坐标(已废弃,请使用Teleport) |
获得附近队友位置[已废弃] | 获得队友附近位置,会规避开无法站立玩家的位置(已废弃,请使用GetTeammateNearPosition) |
获得实体的绑定玩家 | 获得实体的所属玩家 |
克隆 | 在原位置克隆选中的实体及其所有属性 |
刷新下一波 | 生成器立刻刷新下一波单位实体 |
获取变量类型 | 获取调用此API时目标的类型 |
是否类型一致 | 判断目标变量是否为指定类型 |
是否类型一致或继承 | 判断目标变量是否是某一类型的子类,返回值是一个布尔值 |
是否存在组件 | 判断目标实体是否存在组件 |
发送玩家自定义事件 | 使目标实体触发指定自定义事件 |
筛选实体 | 获取游戏中全部符合筛选条件的实体 |
添加脚本 | 为目标实体添加脚本 |
移除脚本 | 为目标实体卸载脚本 |
是否存在脚本 | 检查目标实体是否存在指定脚本 |
销毁 | 销毁指定实体 |
添加标签 | 为实体添加标签 |
删除标签 | 为实体移除标签 |
是否包含标签 | 判断目标实体是否包含指定的标签 |
设置活动状态 | 设置目标实体及其子节点的活动状态,不活动的物体的可用性、可见性、碰撞等均会关闭 |
设置父节点 | 设置父节点,要求父子都具有Transform组件 |
获取所有子节点 | 获取目标父节点实体的所有子节点 |
根据索引获取指定子节点 | 根据索引获取目标父节点实体的指定子节点 |
根据名称获取指定子节点 | 根据名称获取目标父节点实体的指定子节点 |
获取父节点 | 获取目标子节点实体的父节点 |
删除所有子节点 | 删除指定父节点实体下的所有子节点,节点必须具有Transform组件 |
设置实体属性(平滑) | 平滑设置目标实体的属性,属性会立刻改变,但是客户端会播放一个平滑过渡表现 |
创建预制体实例 | 使用预制体为模板创建实体 |
创建预制体实例 | 创建预制体实例,可以选择是否异步处理 |
设置玩家是否可以中途退出 | 设置玩家是否可以自由退出 |
获得色值(RGBA)通道 | 取得目标颜色的各通道值 |
时间戳本地化字符串 | 创建一个时间戳本地化字符串 |
脏字过滤 | 脏字过滤 |
创建音效[已废弃] | 播放指定的音效,有更多需要设置的属性时则通过实体进一步设置它的实体属性 |
暂停音效[已废弃] | 中断播放中的音效实体 |
播放音效[已废弃] | 继续播放音效,可选择是否从头开始播放 |
添加Bot | 添加Bot |
销毁Bot | 销毁指定Bot |
创建伤害跳字 | 创建伤害跳字 |
打印警告 | 将目标数据以警告形式打印到控制台 |
打印报错 | 将目标数据以报错形式打印到控制台 |
上传游戏结算信息 | 上传自定义结算信息 |
设置物件实体的父节点 | 设置物件实体的父节点,支持挂载了Transform,SkeletonPart,Player,MountPoint组件的实体 |
通知客户端播放图标动画效果 | 播放图标动画效果,图标由起始位置以播放速度平移至结束位置 |
添加组件 | 添加组件到实体上,仅支持用户创建的自定义组件 |
移除组件 | 从实体上移除组件,仅支持自定义组件 |
应用中退界面配置 | 自定义玩家中途退出界面 |
当前玩家 | 获取当前客户端对应玩家 |
添加AOI特别关注 | 添加AOI特别关注,无视距离始终同步 |
移除AOI特别关注 | 移除AOI特别关注,取消视距外AOI同步 |
清空AOI特别关注 | 清空指定目标的全部AOI特别关注 |
是否存在AOI特别关注 | 判断是否存在AOI特别关注 |
切换AOI代理观察者 | 切换玩家的代理观察者 |
开始播放剧情 | 使触发玩家开始播放指定剧情对话 |
获取客户端语言 | 获取玩家使用的客户端语言 |