API手册

CLASS

AIBasicCommand

AI基础命令类型

Ability

技能

AbilityKey

技能编号

AbilitySlot

技能槽位

Achievement

自定义成就

AnimKey

动画编号

ArchiveType

存档类型

BattleShopKey

商店

BindType

绑定类型

Bool

布尔值

BuffState

状态

CameraBindMode

相机绑定模式

CameraProjectionType

相机投影类型

CameraPropertyType

相机属性预设

CameraShakeType

屏幕震动类型

Camp

阵营

CampID

阵营ID

Character

角色

CharacterKey

角色编号

Color

颜色

Creature

生物

CreatureKey

生物编号

CustomTriggerSpace

触发区域

CustomTriggerSpaceKey

触发区域编号

DamageSchema

伤害方案

DecorationKey

装饰物编号

Dict

字典

DirectionType

方向枚举

E3DLayer

场景UI实例

E3DLayerKey

场景UI预设

EBagSlot

UI物品槽位节点

EButton

UI按钮节点

EEffectNode

UI动效节点

EImage

UI图片节点

EInputField

UI输入节点

ELabel

UI文本节点

ENode

UI节点

EProgressbar

UI进度条节点

ETypeMeta

None

EmojiKey

气泡表情编号

Equipment

物品

EquipmentKey

物品编号

EquipmentSlot

物品槽位

EquipmentSlotType

物品槽位类型

Fixed

定点数

FontKey

字体key

Function

函数

ImageKey

图片编号

Int

整型

InteractBtnID

交互按钮编号

InteractBtnType

交互按钮类型

JointAssistantKey

关节预设编号

LevelKey

关卡编号

LifeEntity

生命体

List

列表

ListAIBasicCommand

AI基础命令类型列表

ListStr

字符串列表

ListUnitID

单位ID列表

ListUnitType

单位类型列表

ListVector3

向量列表

ModelSocket

部位

Modifier

效果

ModifierKey

效果编号

MontageKey

剧情动画编号

MoveMode

AI移动模式

ObstacleKey

组件编号

PaintArea

染色区域

PathID

路径ID

PathPointID

路点ID

PatrolType

AI巡逻类型

Point3

坐标点

Quaternion

四元数

Role

玩家

RoleID

玩家ID

SfxID

特效ID

SfxKey

特效编号

SkyBoxBackground

天空盒背景

SkyBoxGradualType

天空盒渐变类型

SoundID

音效ID

SoundKey

音效编号

Str

字符串

Timer

计时器

Timestamp

时间戳

TriggerSpaceKey

逻辑体编号

UgcCommodity

道具

UgcGoods

商品

Unit

单位

UnitGroupKey

组件组编号

UnitID

单位ID

UnitKey

单位编号

UnitType

单位类型

ValueType

值类型

Vector3

向量

WindFieldShapeType

风场形状

ENUM

RigidBodyType 物理类型

STATIC 0 静态

KINEMATIC 1 运动学

DYNAMIC 2 受外力

EquipmentSlotType 物品槽位类型

EQUIPPED 1 装配槽位

BACKPACK 2 背包槽位

CampRelationType 阵营关系类型

ENEMY 1 敌方

FRIEND 2 友方

NEUTRAL 4 中立

EquipmentType 物品类型

BASIC 0 基础物品

WEAPON 1 武器物品

UnitType 单位类型

CREATURE 4 生物

CUSTOMTRIGGERSPACE 8 触发区域

CHARACTER 128 角色

OBSTACLE 256 组件

TRIGGERSPACE 512 逻辑体

DECORATION 1024 装饰物

EQUIPMENT 32768 物品

TriggerSpaceEventType 触发区域类型

ENTER 1 进入

LEAVE 4 离开

GameResult 游戏结局

LOSE 0 失败

WIN 1 胜利

GAMING 2 游戏中

MoveMode AI移动模式

DIRECT 0 直线运动

PATHFIND 1 避障运动

AIBasicCommand AI基础命令类型

JUMP 1 跳跃

ROLL 2 滚动

RUSH 3 前扑

LIFT 4 举起

ABILITY 5 使用道具/技能

MOVE 6 移动

EQUIPMENT 7 使用物品

PatrolType AI巡逻类型

ONE_WAY 0 一次性

LOOP 1 巡逻

BACK_AND_FORTH 2 往返

BuffState 状态

BUFF_FORBID_JUMP 1 禁止跳跃

BUFF_FORBID_RUSH 2 禁止飞扑

BUFF_FORBID_LIFT 4 禁止抓举

BUFF_FORBID_ROLL 8 禁止滚动

BUFF_FORBID_MOVE 16 禁止移动

BUFF_FORBID_CONTROL 32 无法控制

BUFF_SILENT 64 沉默

CameraPropertyType 相机属性预设

TRACK_MODE_PITCH 0 追踪-俯仰角

TRACK_MODE_YAW 1 追踪-偏航角

BIND_MODE_OFFSET_X 2 固定-X轴偏移

BIND_MODE_OFFSET_Y 3 固定-Y轴偏移

BIND_MODE_OFFSET_Z 4 固定-Z轴偏移

BIND_MODE_PITCH 5 固定-俯仰角

BIND_MODE_YAW 6 固定-偏航角

DIST 7 相机距离

FOV 8 视场角

PITCH_MAX 9 最大俯仰角

PITCH_MIN 10 最小俯仰角

OBSERVER_HEIGHT 11 相机高度

HORIZONTAL_OFFSET 12 水平偏移

PITCH 15 俯仰角

YAW 16 偏航角

OFFSET_X 17 X轴偏移

OFFSET_Y 18 Y轴偏移

OFFSET_Z 19 Z轴偏移

ROLL 20 滚动角

CameraBindMode 相机绑定模式

DEFAULT 0 DEFAULT

BIND 1 BIND

TRACK 2 TRACK

WindFieldShapeType 风场形状

CONICAL 0 锥形

SECTOR 1 扇形

WAVE 2 波浪形

ValueType 值类型

AIBasicCommand AIBasicCommand AI基础命令类型

Ability Ability 技能

AbilityIndex AbilityIndex 技能槽位(内部)

AbilityKey AbilityKey 技能编号

AbilityPointerType AbilityPointerType 技能指示器类型

AbilitySlot AbilitySlot 技能槽位

Achievement Achievement 自定义成就

Actor Actor Actor

AnimKey AnimKey 动画编号

Archive Archive 自定义存档

ArchiveType ArchiveType 存档类型

BattleShopKey BattleShopKey 商店

BindType BindType 绑定类型

Bool Bool 布尔值

BuffState BuffState 状态

CameraBindMode CameraBindMode 相机绑定模式

CameraProjectionType CameraProjectionType 相机投影类型

CameraPropertyType CameraPropertyType 相机属性预设

CameraShakeType CameraShakeType 屏幕震动类型

Camp Camp 阵营

CampID CampID 阵营ID

CampRelationType CampRelationType 阵营关系类型

Character Character 角色

CharacterID CharacterID 角色ID

CharacterKey CharacterKey 角色编号

Color Color 颜色

ConfigTable ConfigTable 多维表

Creature Creature 生物

CreatureID CreatureID 生物ID

CreatureKey CreatureKey 生物编号

CustomTriggerSpace CustomTriggerSpace 触发区域

CustomTriggerSpaceID CustomTriggerSpaceID 触发区域ID

CustomTriggerSpaceKey CustomTriggerSpaceKey 触发区域编号

Damage Damage 伤害

DamageSchema DamageSchema 伤害方案

Decoration Decoration 装饰物

DecorationKey DecorationKey 装饰物编号

DirectionType DirectionType 方向枚举

E3DLayer E3DLayer 场景UI实例

E3DLayerKey E3DLayerKey 场景UI预设

EBagSlot EBagSlot UI物品槽位节点

EButton EButton UI按钮节点

ECanvas ECanvas UI画布节点

EEffectNode EEffectNode UI动效节点

EImage EImage UI图片节点

EInputField EInputField UI输入节点

ELabel ELabel UI文本节点

ENode ENode UI节点

EProgressbar EProgressbar UI进度条节点

EmojiKey EmojiKey 气泡表情编号

Equipment Equipment 物品

EquipmentID EquipmentID 物品ID

EquipmentKey EquipmentKey 物品编号

EquipmentSlot EquipmentSlot 物品槽位

EquipmentSlotType EquipmentSlotType 物品槽位类型

EquipmentType EquipmentType 物品类型

FaceExpressionKey FaceExpressionKey 面部表情编号

FashionKey FashionKey 时装编号

Fixed Fixed 定点数

FontKey FontKey 字体key

GameResult GameResult 游戏结局

ImageKey ImageKey 图片编号

Int Int 整型

InteractBtnID InteractBtnID 交互按钮编号

InteractBtnType InteractBtnType 交互按钮类型

JointAssistant JointAssistant 关节

JointAssistantKey JointAssistantKey 关节预设编号

JointAssistantType JointAssistantType 关节类型

LevelKey LevelKey 关卡编号

LifeEntity LifeEntity 生命体

LifeEntityKey LifeEntityKey 生命体编号

ListAIBasicCommand ListAIBasicCommand AI基础命令类型列表

ListAbility ListAbility 技能列表

ListAbilityIndex ListAbilityIndex 技能槽位(内部)列表

ListAbilityKey ListAbilityKey 技能编号列表

ListAbilityPointerType ListAbilityPointerType 技能指示器类型列表

ListAbilitySlot ListAbilitySlot 技能槽位列表

ListAchievement ListAchievement 自定义成就列表

ListActor ListActor Actor列表

ListAnimKey ListAnimKey 动画编号列表

ListArchive ListArchive 自定义存档列表

ListArchiveType ListArchiveType 存档类型列表

ListBattleShopKey ListBattleShopKey 商店列表

ListBindType ListBindType 绑定类型列表

ListBool ListBool 布尔值列表

ListBuffState ListBuffState 状态列表

ListCameraBindMode ListCameraBindMode 相机绑定模式列表

ListCameraProjectionType ListCameraProjectionType 相机投影类型列表

ListCameraPropertyType ListCameraPropertyType 相机属性预设列表

ListCameraShakeType ListCameraShakeType 屏幕震动类型列表

ListCamp ListCamp 阵营列表

ListCampID ListCampID 阵营ID列表

ListCampRelationType ListCampRelationType 阵营关系类型列表

ListCharacter ListCharacter 角色列表

ListCharacterID ListCharacterID 角色ID列表

ListCharacterKey ListCharacterKey 角色编号列表

ListColor ListColor 颜色列表

ListConfigTable ListConfigTable 多维表列表

ListCreature ListCreature 生物列表

ListCreatureID ListCreatureID 生物ID列表

ListCreatureKey ListCreatureKey 生物编号列表

ListCustomTriggerSpace ListCustomTriggerSpace 触发区域列表

ListCustomTriggerSpaceID ListCustomTriggerSpaceID 触发区域ID列表

ListCustomTriggerSpaceKey ListCustomTriggerSpaceKey 触发区域编号列表

ListDamage ListDamage 伤害列表

ListDamageSchema ListDamageSchema 伤害方案列表

ListDecoration ListDecoration 装饰物列表

ListDecorationKey ListDecorationKey 装饰物编号列表

ListDirectionType ListDirectionType 方向枚举列表

ListE3DLayer ListE3DLayer 场景UI实例列表

ListE3DLayerKey ListE3DLayerKey 场景UI预设列表

ListEBagSlot ListEBagSlot UI物品槽位节点列表

ListEButton ListEButton UI按钮节点列表

ListECanvas ListECanvas UI画布节点列表

ListEEffectNode ListEEffectNode UI动效节点列表

ListEImage ListEImage UI图片节点列表

ListEInputField ListEInputField UI输入节点列表

ListELabel ListELabel UI文本节点列表

ListENode ListENode UI节点列表

ListEProgressbar ListEProgressbar UI进度条节点列表

ListEmojiKey ListEmojiKey 气泡表情编号列表

ListEquipment ListEquipment 物品列表

ListEquipmentID ListEquipmentID 物品ID列表

ListEquipmentKey ListEquipmentKey 物品编号列表

ListEquipmentSlot ListEquipmentSlot 物品槽位列表

ListEquipmentSlotType ListEquipmentSlotType 物品槽位类型列表

ListEquipmentType ListEquipmentType 物品类型列表

ListFaceExpressionKey ListFaceExpressionKey 面部表情编号列表

ListFashionKey ListFashionKey 时装编号列表

ListFixed ListFixed 定点数列表

ListFontKey ListFontKey 字体key列表

ListGameResult ListGameResult 游戏结局列表

ListImageKey ListImageKey 图片编号列表

ListInt ListInt 整型列表

ListInteractBtnID ListInteractBtnID 交互按钮编号列表

ListInteractBtnType ListInteractBtnType 交互按钮类型列表

ListJointAssistant ListJointAssistant 关节列表

ListJointAssistantKey ListJointAssistantKey 关节预设编号列表

ListJointAssistantType ListJointAssistantType 关节类型列表

ListLevelKey ListLevelKey 关卡编号列表

ListLifeEntity ListLifeEntity 生命体列表

ListLifeEntityKey ListLifeEntityKey 生命体编号列表

ListModelSocket ListModelSocket 部位列表

ListModifier ListModifier 效果列表

ListModifierKey ListModifierKey 效果编号列表

ListMontageKey ListMontageKey 剧情动画编号列表

ListMoveMode ListMoveMode AI移动模式列表

ListObstacle ListObstacle 组件列表

ListObstacleID ListObstacleID 组件ID列表

ListObstacleKey ListObstacleKey 组件编号列表

ListPaintArea ListPaintArea 染色区域列表

ListPathID ListPathID 路径ID列表

ListPathPointID ListPathPointID 路点ID列表

ListPatrolType ListPatrolType AI巡逻类型列表

ListQuaternion ListQuaternion 四元数列表

ListRigidBodyType ListRigidBodyType 物理类型列表

ListRole ListRole 玩家列表

ListRoleID ListRoleID 玩家ID列表

ListSfxID ListSfxID 特效ID列表

ListSfxKey ListSfxKey 特效编号列表

ListSkyBoxBackground ListSkyBoxBackground 天空盒背景列表

ListSkyBoxGradualType ListSkyBoxGradualType 天空盒渐变类型列表

ListSoundID ListSoundID 音效ID列表

ListSoundKey ListSoundKey 音效编号列表

ListStr ListStr 字符串列表

ListTimer ListTimer 计时器列表

ListTimestamp ListTimestamp 时间戳列表

ListTrigger ListTrigger 触发器列表

ListTriggerSpace ListTriggerSpace 逻辑体列表

ListTriggerSpaceEventType ListTriggerSpaceEventType 触发区域类型列表

ListTriggerSpaceID ListTriggerSpaceID 逻辑体ID列表

ListTriggerSpaceKey ListTriggerSpaceKey 逻辑体编号列表

ListUgcCommodity ListUgcCommodity 道具列表

ListUgcGoods ListUgcGoods 商品列表

ListUnit ListUnit 单位列表

ListUnitGroup ListUnitGroup 物理组件组列表

ListUnitGroupKey ListUnitGroupKey 组件组编号列表

ListUnitID ListUnitID 单位ID列表

ListUnitKey ListUnitKey 单位编号列表

ListUnitType ListUnitType 单位类型列表

ListValueType ListValueType 值类型列表

ListVector3 ListVector3 向量列表

ListWindFieldShapeType ListWindFieldShapeType 风场形状列表

ModelSocket ModelSocket 部位

Modifier Modifier 效果

ModifierKey ModifierKey 效果编号

MontageKey MontageKey 剧情动画编号

MoveMode MoveMode AI移动模式

Obstacle Obstacle 组件

ObstacleID ObstacleID 组件ID

ObstacleKey ObstacleKey 组件编号

PaintArea PaintArea 染色区域

PathID PathID 路径ID

PathPointID PathPointID 路点ID

PatrolType PatrolType AI巡逻类型

Quaternion Quaternion 四元数

RigidBodyType RigidBodyType 物理类型

Role Role 玩家

RoleID RoleID 玩家ID

SfxID SfxID 特效ID

SfxKey SfxKey 特效编号

SkyBoxBackground SkyBoxBackground 天空盒背景

SkyBoxGradualType SkyBoxGradualType 天空盒渐变类型

SoundID SoundID 音效ID

SoundKey SoundKey 音效编号

Str Str 字符串

Timer Timer 计时器

Timestamp Timestamp 时间戳

Trigger Trigger 触发器

TriggerSpace TriggerSpace 逻辑体

TriggerSpaceEventType TriggerSpaceEventType 触发区域类型

TriggerSpaceID TriggerSpaceID 逻辑体ID

TriggerSpaceKey TriggerSpaceKey 逻辑体编号

UgcCommodity UgcCommodity 道具

UgcGoods UgcGoods 商品

Unit Unit 单位

UnitGroup UnitGroup 物理组件组

UnitGroupKey UnitGroupKey 组件组编号

UnitID UnitID 单位ID

UnitKey UnitKey 单位编号

UnitType UnitType 单位类型

ValueType ValueType 值类型

Vector3 Vector3 向量

WindFieldShapeType WindFieldShapeType 风场形状

ArchiveType 存档类型

Bool Bool 布尔值

ConfigTable ConfigTable 多维表

Fixed Fixed 定点数

Int Int 整型

Str Str 字符串

Timestamp Timestamp 时间戳

JointAssistantKey 关节预设编号

SPRING 3400000 SPRING

ROPE 3400001 ROPE

SLIDER 3400002 SLIDER

HINGE 3400003 HINGE

BALL_SOCKET 3400004 BALL_SOCKET

D6 3400005 D6

FIXED 3400006 FIXED

BindType 绑定类型

BIND_TYPE_DEFAULT 0 BIND_TYPE_DEFAULT

BIND_TYPE_TRANSLATE 1 BIND_TYPE_TRANSLATE

BIND_TYPE_ROTATE 2 BIND_TYPE_ROTATE

BIND_TYPE_TRANSLATE_ROTATE 3 BIND_TYPE_TRANSLATE_ROTATE

BIND_TYPE_SCALE 4 BIND_TYPE_SCALE

BIND_TYPE_TRANSLATE_SCALE 5 BIND_TYPE_TRANSLATE_SCALE

BIND_TYPE_ROTATE_SCALE 6 BIND_TYPE_ROTATE_SCALE

BIND_TYPE_ALL 7 BIND_TYPE_ALL

ModelSocket 部位

socket_abdomen socket_abdomen 腹部

socket_belly socket_belly 鱼腹

socket_body socket_body 身体

socket_calf_l socket_calf_l 左小腿

socket_calf_r socket_calf_r 右小腿

socket_chest socket_chest 胸部

socket_claw_l socket_claw_l 左钳

socket_claw_r socket_claw_r 右钳

socket_eye_l socket_eye_l 左眼

socket_eye_r socket_eye_r 右眼

socket_fin_back socket_fin_back 背后鳍

socket_fin_dorsal socket_fin_dorsal 背鳍

socket_fin_l socket_fin_l 左鳍

socket_fin_lb socket_fin_lb 左后鳍

socket_fin_r socket_fin_r 右鳍

socket_fin_rb socket_fin_rb 右后鳍

socket_fin_tail socket_fin_tail 尾鳍

socket_fin_ventral socket_fin_ventral 腹鳍

socket_fin_ventral_l socket_fin_ventral_l 左腹鳍

socket_fin_ventral_r socket_fin_ventral_r 右腹鳍

socket_foot_l socket_foot_l 左脚

socket_foot_lb socket_foot_lb 左后脚

socket_foot_lf socket_foot_lf 左前脚

socket_foot_lm socket_foot_lm 左中脚

socket_foot_r socket_foot_r 右脚

socket_foot_rb socket_foot_rb 右后脚

socket_foot_rf socket_foot_rf 右前脚

socket_foot_rm socket_foot_rm 右中脚

socket_forearm_l socket_forearm_l 左臂

socket_forearm_r socket_forearm_r 右臂

socket_hand_l socket_hand_l 左手

socket_hand_r socket_hand_r 右手

socket_head socket_head 头部

socket_lowerarm_l socket_lowerarm_l 左小臂

socket_lowerarm_r socket_lowerarm_r 右小臂

socket_lowerlimb_lb socket_lowerlimb_lb 左后下肢

socket_lowerlimb_lf socket_lowerlimb_lf 左前下肢

socket_lowerlimb_rb socket_lowerlimb_rb 右后下肢

socket_lowerlimb_rf socket_lowerlimb_rf 右前下肢

socket_mouth socket_mouth 鱼嘴

socket_origin socket_origin 底面中心点

socket_tail socket_tail 尾巴

socket_tail_end socket_tail_end 尾巴末端

socket_thigh_l socket_thigh_l 左大腿

socket_thigh_r socket_thigh_r 右大腿

socket_torso_b socket_torso_b 躯干后部

socket_torso_f socket_torso_f 躯干前部

socket_upperarm_l socket_upperarm_l 左大臂

socket_upperarm_r socket_upperarm_r 右大臂

socket_upperlimb_lb socket_upperlimb_lb 左后上肢

socket_upperlimb_lf socket_upperlimb_lf 左前上肢

socket_upperlimb_rb socket_upperlimb_rb 右后上肢

socket_upperlimb_rf socket_upperlimb_rf 右前上肢

socket_weapon_l socket_weapon_l 左手武器

socket_weapon_r socket_weapon_r 右手武器

SkyBoxGradualType 天空盒渐变类型

NORMAL 0 无过渡

GRADUAL_CHANGE 1 渐变

FAULT_STYLE 2 故障风格

BURN_STYLE 3 燃效效果

CameraProjectionType 相机投影类型

PERSPECTIVE 0 透视

ORTHOGRAPHIC 1 正交

ColorPaintAreaType 染色区域

AREA_1 1 染色区域1

AREA_2 2 染色区域2

AREA_3 3 染色区域3

AREA_4 4 染色区域4

DirectionType 方向枚举

FORWARD 3 前

BACK 4 后

UP 5 上

DOWN 6 下

LEFT 7 左

RIGHT 8 右

LuaAPI

LuaAPI.call_delay_frame

描述: 延迟调用函数（按帧数）

LuaAPI.call_delay_frame(_interval, _callback)

参数列表:

参数	类型	说明
_interval	Int	间隔帧数
_callback	Function	回调

LuaAPI.call_delay_time

描述: 延迟调用函数（按时间）

LuaAPI.call_delay_time(_interval, _callback)

参数列表:

参数	类型	说明
_interval	Fixed	间隔时间（秒）
_callback	Function	回调

LuaAPI.enable_developer_mode

描述: 启用开发者模式

LuaAPI.enable_developer_mode()

返回类型 Bool 是否启用成功

LuaAPI.enable_error_interruption_mode

描述: 启用错误中断模式

LuaAPI.enable_error_interruption_mode(_enable)

参数列表:

参数	类型	说明
_enable	Bool	是否启用

LuaAPI.get_component_list

描述: 获取子部件列表（慢）

LuaAPI.get_component_list(_obj)

参数列表:

参数	类型	说明
_obj	Unit	单位

返回类型 ListStr 组件名称列表

LuaAPI.get_current_unit

描述: 获取当前单位

参数	类型	说明
_object	Unit	单位
_name	Str	组件名

返回类型 Bool 是否含有指定子组件

LuaAPI.log

描述: 输出日志

LuaAPI.log(_content)

参数列表:

参数	类型	说明
_content	Str	日志内容

LuaAPI.query_ui_node

描述: 查询UI单位（慢）

LuaAPI.query_ui_node(_name)

参数列表:

参数	类型	说明
_name	Str	名字

返回类型 ENode UI名称

LuaAPI.query_ui_nodes

描述: 批量查询UI单位（慢）

LuaAPI.query_ui_nodes(_name_list)

参数列表:

参数	类型	说明
_name_list	ListStr	名字列表

返回类型 ListENode UI名称列表

LuaAPI.query_unit

描述: 查询组件单位（慢）

LuaAPI.query_unit(_name)

参数列表:

参数	类型	说明
_name	Str	名字

返回类型 Unit 组件

LuaAPI.query_units

描述: 批量查询单位（按名称）

LuaAPI.query_units(_name_list)

参数列表:

参数	类型	说明
_name_list	ListStr	名字列表

返回类型 ListUnit 组件列表

LuaAPI.query_units_by_type

描述: 批量查询单位（按类型、预设）

LuaAPI.query_units_by_type(_unit_type, _unit_eid)

参数列表:

参数	类型	说明
_unit_type	UnitType	单位类型
_unit_eid	Int	预设ID

返回类型 ListUnit 组件

LuaAPI.rand

描述: 生成随机数

LuaAPI.rand()

返回类型 Int 随机数

LuaAPI.set_deadloop_check_enabled

描述: 启用死循环检测

LuaAPI.set_deadloop_check_enabled(_enable, _max_instruction_count)

参数列表:

参数	类型	说明
_enable	Bool	启用
_max_instruction_count	Int	最大指令数限制

参数	类型	说明
_unit	Unit	单位
_event_name	Str	自定义事件名
_callback	Function	回调

返回类型 Int 注册ID

LuaAPI.unit_register_trigger_event

描述: 注册单位触发器

LuaAPI.unit_register_trigger_event(_unit, _event_desc, _callback)

参数列表:

参数	类型	说明
_unit	Unit	单位
_event_desc	List	事件名及注册参数
_callback	Function	回调

参数	类型	说明
_unit	Unit	单位
_id	Int	注册ID

参数	类型	说明
_vec	Vector3	向量
_direction	Vector3	投影方向

返回类型 Vector3 投影后向量

GlobalAPI.str_contains

描述: 是否含有子字符串

GlobalAPI.str_contains(_str1, _str2)

参数列表:

参数	类型	说明
_str1	Str	父字符串
_str2	Str	子字符串

返回类型 Bool 布尔值

GlobalAPI.is_none

描述: 判断对象是否为空

GlobalAPI.is_none(_obj)

参数列表:

参数	类型	说明
_obj	Unit	对象

返回类型 Bool 是否为空

GlobalAPI.is_not_none

描述: 判断对象是否为空

GlobalAPI.is_not_none(_obj)

参数列表:

参数	类型	说明
_obj	Unit	对象

参数	类型	说明
_content	Str	字符串
_duration	Fixed	时长

参数	类型	说明
_u_key	CreatureKey	生物编号
_pos	Point3	位置
_rotation	Quaternion	旋转
_scale	Vector3	缩放
_role	Role	所属玩家

返回类型 Creature 创建的生物

GameAPI.create_customtriggerspace

描述: 创建一个触发区域

GameAPI.create_customtriggerspace(_u_key, _pos, _rotation, _scale, _role)

参数列表:

参数	类型	说明
_u_key	CustomTriggerSpaceKey	触发区域编号
_pos	Vector3	位置
_rotation	Quaternion	旋转
_scale	Vector3	缩放
_role	Role	所属玩家

返回类型 CustomTriggerSpace 创建出的触发区域

GameAPI.create_decoration

描述: 创建一个装饰物

GameAPI.create_decoration(_u_key, _pos, _rotation, _scale, _parent)

参数列表:

参数	类型	说明
_u_key	DecorationKey	单位编号
_pos	Vector3	位置
_rotation	Quaternion	旋转
_scale	Vector3	缩放
_parent	Unit	绑定对象

返回类型 Decoration 创建的装饰物

GameAPI.create_equipment

描述: 创建物品到坐标点

GameAPI.create_equipment(_equipment_eid, _pos)

参数列表:

参数	类型	说明
_equipment_eid	EquipmentKey	物品编号
_pos	Point3	位置

返回类型 Equipment 物品

GameAPI.create_scene_ui_at_point

描述: 创建场景界面到坐标点

GameAPI.create_scene_ui_at_point(_layer_key, _pos, _duration)

参数列表:

参数	类型	说明
_layer_key	E3DLayerKey	场景界面预设编号
_pos	Point3	坐标点
_duration	Fixed	持续事件

返回类型 E3DLayer 场景界面

GameAPI.create_joint_assistant

描述: 创建关节助手

GameAPI.create_joint_assistant(_unit_key, _unit1, _unit2)

参数列表:

参数	类型	说明
_unit_key	JointAssistantKey	关节助手类型
_unit1	Unit	连接主体
_unit2	Unit	连接目标

返回类型 JointAssistant 创建出的关节助手

GameAPI.create_life_entity

描述: 创建一个生命体

GameAPI.create_life_entity(_unit_key, _pos, _rotation, _scale_ratio, _role)

参数列表:

参数	类型	说明
_unit_key	UnitKey	单位编号
_pos	Point3	位置
_rotation	Quaternion	旋转
_scale_ratio	Fixed	缩放大小
_role	Role	所属玩家

返回类型 LifeEntity 创建出的生命体

GameAPI.create_obstacle

描述: 创建一个组件

GameAPI.create_obstacle(_u_key, _pos, _rotation, _scale, _role)

参数列表:

参数	类型	说明
_u_key	UnitKey	组件编号
_pos	Vector3	位置
_rotation	Quaternion	旋转
_scale	Vector3	缩放
_role	Role	所属玩家

返回类型 Obstacle 创建的组件

GameAPI.create_sfx_with_socket

描述: 播放特效并绑定

GameAPI.create_sfx_with_socket(_sfx_key, _unit, _socket_name, _scale, _duration, _bind_type)

参数列表:

参数	类型	说明
_sfx_key	SfxKey	特效编号
_unit	Unit	起点单位
_socket_name	ModelSocket	起点节点
_scale	Fixed	缩放
_duration	Fixed	持续时间
_bind_type	BindType	绑定方式

返回类型 SfxID 特效ID

GameAPI.create_sfx_with_socket_offset

描述: 播放特效并绑定

GameAPI.create_sfx_with_socket_offset(_sfx_key, _unit, _socket_name, _offset, _rot, _scale, _duration, _bind_type)

参数列表:

参数	类型	说明
_sfx_key	SfxKey	特效编号
_unit	Unit	起点单位
_socket_name	ModelSocket	起点节点
_offset	Vector3	偏移
_rot	Quaternion	旋转
_scale	Fixed	缩放
_duration	Fixed	持续时间
_bind_type	BindType	绑定方式

返回类型 SfxID 特效ID

GameAPI.create_triggerspace

描述: 创建一个逻辑体

GameAPI.create_triggerspace(_u_key, _pos, _rotation, _scale, _role)

参数列表:

参数	类型	说明
_u_key	TriggerSpaceKey	逻辑体编号
_pos	Vector3	位置
_rotation	Quaternion	旋转
_scale	Vector3	缩放
_role	Role	所属玩家

返回类型 TriggerSpace 创建的逻辑体

GameAPI.create_unit_group

描述: 创建一个组件组

GameAPI.create_unit_group(_unit_group_id, _pos, _root_quaternion, _role)

参数列表:

参数	类型	说明
_unit_group_id	UnitGroupKey	单位编号
_pos	Point3	位置
_root_quaternion	Quaternion	旋转
_role	Role	所属玩家

返回类型 UnitGroup 创建出的单位

GameAPI.create_unit_with_scale

描述: 创建一个缩放单位

GameAPI.create_unit_with_scale(_u_key, _pos, _rotation, _scale)

参数列表:

参数	类型	说明
_u_key	UnitKey	单位编号
_pos	Point3	位置
_rotation	Quaternion	旋转
_scale	Vector3	缩放

返回类型 Unit 创建出的单位

GameAPI.remove_pathpoint

描述: 删除路点

GameAPI.remove_pathpoint(_path_id, _index)

参数列表:

参数	类型	说明
_path_id	PathID	路径
_index	Int	路点索引

GameAPI.destroy_scene_ui

描述: 销毁场景界面

GameAPI.destroy_scene_ui(_layer)

参数列表:

参数	类型	说明
_layer	E3DLayer	场景界面

GameAPI.destroy_unit

描述: 删除单位

GameAPI.destroy_unit(_unit)

参数列表:

参数	类型	说明
_unit	Unit	单位

GameAPI.game_end

描述: 游戏结束

GameAPI.game_end()

GameAPI.get_achievement_target

描述: 获取成就目标进度

GameAPI.get_achievement_target(_event_id)

参数列表:

参数	类型	说明
_event_id	Achievement	成就

返回类型 Int 成就进度

GameAPI.get_all_equipment_keys_in_shop

描述: 获取物品商店中的所有物品编号

GameAPI.get_all_equipment_keys_in_shop(_battle_shop_key)

参数列表:

参数	类型	说明
_battle_shop_key	BattleShopKey	物品商店编号

返回类型 ListEquipmentKey 物品编号列表

GameAPI.get_characters_in_aabb

描述: 获取矩形区域内的角色

GameAPI.get_characters_in_aabb(_center, _length, _height, _width)

参数列表:

参数	类型	说明
_center	Point3	中心点
_length	Fixed	长
_height	Fixed	高
_width	Fixed	宽

返回类型 ListCharacter 角色列表

GameAPI.get_characters_in_cylinder

描述: 获取圆柱区域内的角色

GameAPI.get_characters_in_cylinder(_bottom_center, _radius, _height)

参数列表:

参数	类型	说明
_bottom_center	Point3	底部中心
_radius	Fixed	半径
_height	Fixed	高度

返回类型 ListCharacter 角色列表

GameAPI.get_characters_in_sphere

描述: 获取圆形区域内的角色

GameAPI.get_characters_in_sphere(_center, _radius)

参数列表:

参数	类型	说明
_center	Point3	中心点
_radius	Fixed	半径

返回类型 ListCharacter 角色列表

GameAPI.get_creatures_by_key

描述: 获取指定编号的逻辑体列表

GameAPI.get_creatures_by_key(_creature_key)

参数列表:

参数	类型	说明
_creature_key	CreatureKey	生物编号

返回类型 ListCreature 生物列表

GameAPI.get_creatures_in_aabb

描述: 获取矩形区域内的生物

GameAPI.get_creatures_in_aabb(_center, _length, _height, _width)

参数列表:

参数	类型	说明
_center	Point3	中心点
_length	Fixed	长
_height	Fixed	高
_width	Fixed	宽

返回类型 ListCreature 角色列表

GameAPI.get_creatures_in_annulus

描述: 获取圆环区域内的生物

GameAPI.get_creatures_in_annulus(_center, _radius1, _radius2, _height)

参数列表:

参数	类型	说明
_center	Point3	中心点
_radius1	Fixed	内径
_radius2	Fixed	外径
_height	Fixed	高度

返回类型 ListCreature 生物列表

GameAPI.get_creatures_in_cylinder

描述: 获取圆柱区域内的生物

GameAPI.get_creatures_in_cylinder(_bottom_center, _radius, _height)

参数列表:

参数	类型	说明
_bottom_center	Point3	底部中心
_radius	Fixed	半径
_height	Fixed	高度

返回类型 ListCreature 生物列表

GameAPI.get_creatures_in_sector

描述: 获取扇形区域内的生物

GameAPI.get_creatures_in_sector(_center, _face_dir, _central_angle, _radius, _height)

参数列表:

参数	类型	说明
_center	Point3	起始点
_face_dir	Fixed	角度朝向
_central_angle	Fixed	广角
_radius	Fixed	半径
_height	Fixed	高度

返回类型 ListCreature 生物列表

GameAPI.get_creatures_in_sphere

描述: 获取圆形区域内的生物

GameAPI.get_creatures_in_sphere(_center, _radius)

参数列表:

参数	类型	说明
_center	Point3	中心点
_radius	Fixed	半径

返回类型 ListCreature 生物列表

GameAPI.get_env_time

描述: 获取环境时间

GameAPI.get_env_time()

返回类型 Fixed 当前环境时刻

GameAPI.get_customtriggerspaces_by_key

描述: 获取指定预设的触发区域列表

GameAPI.get_customtriggerspaces_by_key(_key)

参数列表:

参数	类型	说明
_key	CustomTriggerSpaceKey	触发区域编号

返回类型 ListCustomTriggerSpace 触发区域列表

GameAPI.get_customtriggerspaces_in_raycast

描述: 获取射线检测到的触发区域列表

GameAPI.get_customtriggerspaces_in_raycast(_start_pos, _end_pos)

参数列表:

参数	类型	说明
_start_pos	Point3	起始点
_end_pos	Point3	终点

返回类型 ListCustomTriggerSpace 触发区域列表

GameAPI.get_first_customtriggerspace_in_raycast

描述: 获取射线检测到的触发区域

GameAPI.get_first_customtriggerspace_in_raycast(_start_pos, _end_pos)

参数列表:

参数	类型	说明
_start_pos	Point3	起始点
_end_pos	Point3	终点

返回类型 CustomTriggerSpace 触发区域

GameAPI.get_day

描述: 获取时间戳转化后的日期数

GameAPI.get_day(_timestamp)

参数列表:

参数	类型	说明
_timestamp	Timestamp	时间戳

返回类型 Int 日

GameAPI.get_timestamp_diff

描述: 获取时间戳秒差

GameAPI.get_timestamp_diff(_timestamp_1, _timestamp_2)

参数列表:

参数	类型	说明
_timestamp_1	Timestamp	时间戳1
_timestamp_2	Timestamp	时间戳2

返回类型 Int 秒差

GameAPI.get_eui_node_at_scene_ui

描述: 获取场景界面中的控件

GameAPI.get_eui_node_at_scene_ui(_layer, _node_id)

参数列表:

参数	类型	说明
_layer	E3DLayer	场景界面
_node_id	ENode	界面节点

返回类型 ENode 场景界面节点

GameAPI.get_eui_children

描述: 获取UI节点的所有子UI节点

GameAPI.get_eui_children(_node)

参数列表:

参数	类型	说明
_node	ENode	UI节点

返回类型 ListENode 子UI节点列表

GameAPI.get_eui_child_by_name

描述: 根据名字获取UI节点的子UI节点

GameAPI.get_eui_child_by_name(_node, _name)

参数列表:

参数	类型	说明
_node	ENode	UI节点
_name	Str	名字

返回类型 ENode 子UI节点

GameAPI.get_hour

描述: 获取时间戳转化后的小时数

GameAPI.get_hour(_timestamp)

参数列表:

参数	类型	说明
_timestamp	Timestamp	时间戳

返回类型 Int 时

GameAPI.get_lifeentities_in_aabb

描述: 获取矩形区域内的生命体

GameAPI.get_lifeentities_in_aabb(_center, _length, _height, _width)

参数列表:

参数	类型	说明
_center	Point3	中心点
_length	Fixed	长
_height	Fixed	高
_width	Fixed	宽

返回类型 ListLifeEntity 生命体列表

GameAPI.get_lifeentities_in_cylinder

描述: 获取圆柱区域内的生命体

GameAPI.get_lifeentities_in_cylinder(_bottom_center, _radius, _height)

参数列表:

参数	类型	说明
_bottom_center	Point3	底部中心
_radius	Fixed	半径
_height	Fixed	高度

返回类型 ListLifeEntity 生命体列表

GameAPI.get_lifeentities_in_sphere

描述: 获取圆形区域内的生命体

GameAPI.get_lifeentities_in_sphere(_center, _radius)

参数列表:

参数	类型	说明
_center	Point3	中心点
_radius	Fixed	半径

返回类型 ListLifeEntity 生命体列表

GameAPI.get_map_rating_score

描述: 获取地图当前评分

GameAPI.get_map_rating_score()

返回类型 Fixed 当前评分

GameAPI.get_map_characters

描述: 获取所有地图角色

GameAPI.get_map_characters()

返回类型 ListCharacter 角色列表

GameAPI.get_env_time_running_enabled

描述: 获取环境时间是否自动流逝

GameAPI.get_env_time_running_enabled()

返回类型 Bool 是否自动流逝

GameAPI.get_env_time_ratio

描述: 获取环境时间流逝速率

参数	类型	说明
_path_id	PathID	路径

返回类型 ListVector3 向量数组

GameAPI.random_color

描述: 获取随机颜色

参数	类型	说明
_timestamp	Timestamp	时间戳

返回类型 Int 秒

GameAPI.get_timestamp

描述: 获取当前时间戳

参数	类型	说明
_level_key	LevelKey	关卡编号

GameAPI.play_sfx_by_key

描述: 播放特效

GameAPI.play_sfx_by_key(_sfx_key, _pos, _rot, _scale, _duration, _rate, _with_sound)

参数列表:

参数	类型	说明
_sfx_key	SfxKey	特效编号
_pos	Point3	位置
_rot	Quaternion	旋转
_scale	Fixed	缩放
_duration	Fixed	持续时间
_rate	Fixed	播放速率
_with_sound	Bool	是否播放音效

返回类型 SfxID 特效ID

GameAPI.get_pathpoint_by_id

描述: 获取路点坐标

GameAPI.get_pathpoint_by_id(_point_id)

参数列表:

参数	类型	说明
_point_id	PathPointID	路点

参数	类型	说明
_unit_id	UnitID	单位ID

返回类型 Unit 单位

GameAPI.ability_prefab_get_desc

描述: 获取技能预设描述

GameAPI.ability_prefab_get_desc(_ability_id)

参数列表:

参数	类型	说明
_ability_id	AbilityKey	技能编号

返回类型 Str 技能描述

GameAPI.ability_prefab_get_name

描述: 获取技能预设名称

GameAPI.ability_prefab_get_name(_ability_id)

参数列表:

参数	类型	说明
_ability_id	AbilityKey	技能编号

返回类型 Str 技能名称

GameAPI.ability_prefab_get_prop_by_type

描述: 获取技能预设的属性

GameAPI.ability_prefab_get_prop_by_type(_value_type, _key, _prop)

参数列表:

参数	类型	说明
_value_type	ValueType	值类型
_key	AbilityKey	技能编号
_prop	Str	名称

返回类型 ETypeMeta 属性值

GameAPI.ability_prefab_has_kv

描述: 技能预设是否存在自定义值

GameAPI.ability_prefab_has_kv(_ability_key, _prop)

参数列表:

参数	类型	说明
_ability_key	AbilityKey	技能编号
_prop	Str	名称

返回类型 Bool 是否存在

GameAPI.create_obstacle_by_geometry

描述: 创建一个组件（自定义几何）

GameAPI.create_obstacle_by_geometry(_u_key, _pos, _rotation, _scale, _role, _geometry_path, _mat_path, _sel_skin)

参数列表:

参数	类型	说明
_u_key	UnitKey	组件编号
_pos	Vector3	位置
_rotation	Quaternion	旋转
_scale	Vector3	缩放
_role	Role	所属玩家
_geometry_path	Str	自定义几何体路径
_mat_path	Str	覆盖材质路径
_sel_skin	Int	材质编号（与材质路径二选一)

返回类型 Obstacle 创建的组件

GameAPI.creature_prefab_get_kv_by_type

描述: 获取生物预设的自定义值

GameAPI.creature_prefab_get_kv_by_type(_value_type, _key, _prop)

参数列表:

参数	类型	说明
_value_type	ValueType	值类型
_key	CreatureKey	生物编号
_prop	Str	名称

返回类型 ETypeMeta 自定义值

GameAPI.creature_prefab_get_prop_by_type

描述: 获取生物预设的属性

GameAPI.creature_prefab_get_prop_by_type(_value_type, _key, _prop)

参数列表:

参数	类型	说明
_value_type	ValueType	值类型
_key	CreatureKey	生物编号
_prop	Str	名称

返回类型 ETypeMeta 属性值

GameAPI.creature_prefab_has_kv

描述: 生物预设是否存在自定义值

GameAPI.creature_prefab_has_kv(_unit_key, _prop)

参数列表:

参数	类型	说明
_unit_key	CreatureKey	生物编号
_prop	Str	名称

返回类型 Bool 是否存在

GameAPI.customtriggerspace_prefab_get_kv_by_type

描述: 获取触发区域预设的自定义值

GameAPI.customtriggerspace_prefab_get_kv_by_type(_value_type, _key, _prop)

参数列表:

参数	类型	说明
_value_type	ValueType	值类型
_key	CustomTriggerSpaceKey	逻辑体编号
_prop	Str	名称

返回类型 ETypeMeta 自定义值

GameAPI.customtriggerspace_prefab_get_prop_by_type

描述: 获取触发区域预设的属性

GameAPI.customtriggerspace_prefab_get_prop_by_type(_value_type, _key, _prop)

参数列表:

参数	类型	说明
_value_type	ValueType	值类型
_key	CustomTriggerSpaceKey	逻辑体编号
_prop	Str	名称

返回类型 ETypeMeta 属性值

GameAPI.customtriggerspace_prefab_has_kv

描述: 触发区域预设是否存在自定义值

GameAPI.customtriggerspace_prefab_has_kv(_key, _prop)

参数列表:

参数	类型	说明
_key	CustomTriggerSpaceKey	触发区域编号
_prop	Str	名称

返回类型 Bool 是否存在

GameAPI.equipment_prefab_has_kv

描述: 物品预设是否存在自定义值

GameAPI.equipment_prefab_has_kv(_equipment_key, _prop)

参数列表:

参数	类型	说明
_equipment_key	EquipmentKey	物品编号
_prop	Str	名称

返回类型 Bool 是否存在

GameAPI.get_all_camps

描述: 获取所有阵营

GameAPI.get_all_camps()

返回类型 ListCamp 阵营列表

GameAPI.get_all_online_roles

描述: 获取所有在线玩家

GameAPI.get_all_online_roles()

返回类型 ListRole 玩家列表

GameAPI.get_all_roles

描述: 获取所有玩家

GameAPI.get_all_roles()

返回类型 ListRole 玩家

GameAPI.get_all_valid_roles

描述: 获取游戏中所有玩家

参数	类型	说明
_node	ENode	UI节点

返回类型 Int 数量

GameAPI.get_goods_list

描述: 获取付费商品信息列表

参数	类型	说明
_value_type	ValueType	值类型
_key	TriggerSpaceKey	逻辑体编号
_prop	Str	名称

返回类型 ETypeMeta 自定义值

GameAPI.triggerspace_prefab_get_prop_by_type

描述: 获取逻辑体预设的属性

GameAPI.triggerspace_prefab_get_prop_by_type(_value_type, _key, _prop)

参数列表:

参数	类型	说明
_value_type	ValueType	值类型
_key	TriggerSpaceKey	逻辑体编号
_prop	Str	名称

返回类型 ETypeMeta 属性值

GameAPI.triggerspace_prefab_has_kv

描述: 逻辑体预设是否存在自定义值

GameAPI.triggerspace_prefab_has_kv(_key, _prop)

参数列表:

参数	类型	说明
_key	TriggerSpaceKey	逻辑体编号
_prop	Str	名称

返回类型 Bool 是否存在

单位API

Ability.enter_cd

描述: 技能激活冷却

参数	类型	说明
_delta_level	Int	降低的技能等级

参数	类型	说明
_dir_info	Vector3	方向
_target_point	Point3	坐标点
_target_unit	Unit	目标单位

Ability.get_cur_release_num

描述: 获取技能当前使用次数

Ability.get_cur_release_num()

返回类型 Int 使用次数

Ability.get_max_release_num

描述: 获取技能最大使用次数

Ability.get_max_release_num()

参数	类型	说明
_ability_id	AbilityKey	技能编号
_kv_args	Dict	自定义参数值
_kv_types	Dict	自定义参数类型

返回类型 Ability 添加上的技能

ModifierComp.add_modifier_by_key

描述: 添加效果

ModifierComp.add_modifier_by_key(_modifier_id, _params_dict)

参数列表:

参数	类型	说明
_modifier_id	ModifierKey	效果编号
_params_dict	Dict	额外参数

参数	类型	说明
_ability_index	AbilitySlot	技能槽位
_ability_id	AbilityKey	技能编号
_kv_args	Dict	自定义参数值
_kv_types	Dict	自定义参数类型

返回类型 Ability 添加上的技能

LifeEntity.ai_command_alert

描述: 控制AI执行警戒命令

LifeEntity.ai_command_alert(_tagert_pos, _target_dir, _dalay_time, _reject_time, _move_mode)

参数列表:

参数	类型	说明
_tagert_pos	Vector3	目标
_target_dir	Vector3	朝向
_dalay_time	Fixed	延迟
_reject_time	Fixed	厌恶时间
_move_mode	MoveMode	移动方式

LifeEntity.ai_command_follow

描述: 控制AI执行跟随命令

LifeEntity.ai_command_follow(_target_unit, _follow_dis, _tolerate_dis, _reject_time, _move_mode)

参数列表:

参数	类型	说明
_target_unit	Character	目标
_follow_dis	Fixed	距离
_tolerate_dis	Fixed	容忍距离
_reject_time	Fixed	厌恶时间
_move_mode	MoveMode	移动方式

LifeEntity.ai_command_imitate

描述: 控制AI执行模仿命令

LifeEntity.ai_command_imitate(_target_unit, _delay, _disable_actions)

参数列表:

参数	类型	说明
_target_unit	Character	目标
_delay	Fixed	延迟
_disable_actions	ListAIBasicCommand	屏蔽操作

LifeEntity.ai_command_jump

描述: 控制AI跳跃

LifeEntity.ai_command_jump()

LifeEntity.ai_command_lift

描述: 控制AI举起/扔下/投掷

LifeEntity.ai_command_lift()

LifeEntity.ai_command_patrol

描述: 控制AI执行巡逻命令

LifeEntity.ai_command_patrol(_waypoint, _reject_time, _round_mode, _move_mode)

参数列表:

参数	类型	说明
_waypoint	ListVector3	路径
_reject_time	Fixed	厌恶时间
_round_mode	PatrolType	往返模式
_move_mode	MoveMode	移动方式

LifeEntity.ai_command_pick_up_equipment

描述: 控制AI拾取物品

LifeEntity.ai_command_pick_up_equipment(_target_equipment, _move_mode, _reject_time)

参数列表:

参数	类型	说明
_target_equipment	Equipment	拾取物品
_move_mode	MoveMode	移动方式
_reject_time	Fixed	厌恶时间

LifeEntity.ai_command_roll

描述: 控制AI滚动

LifeEntity.ai_command_roll()

LifeEntity.ai_command_rush

描述: 控制AI前扑

LifeEntity.ai_command_rush()

LifeEntity.ai_command_start_move

描述: 控制AI单位移动

LifeEntity.ai_command_start_move(_direction, _t)

参数列表:

参数	类型	说明
_direction	Vector3	方向
_t	Fixed	时间

LifeEntity.ai_command_stop_move

描述: 控制AI单位停止移动

LifeEntity.ai_command_stop_move(_duration)

参数列表:

参数	类型	说明
_duration	Fixed	时间

LifeEntity.set_ai_move_threshold

描述: 设置寻路阈值

LifeEntity.set_ai_move_threshold(_threshold)

参数列表:

参数	类型	说明
_threshold	Fixed	距离

Unit.apply_force

描述: 施加力

Unit.apply_force(_force)

参数列表:

参数	类型	说明
_force	Vector3	力

Ability.break_accumulate

描述: 打断蓄力

Ability.break_accumulate()

Ability.break_cast

描述: 打断技能施法

Ability.break_cast()

Camp.set_camp_score

描述: 设置阵营积分

Camp.set_camp_score(_score)

参数列表:

参数	类型	说明
_score	Int	积分

LifeComp.is_infinite_reborn

描述: 是否无限复活

LifeComp.is_infinite_reborn()

返回类型 Bool 是否无限复活

LifeComp.can_reborn

描述: 生物是否可以复活

LifeComp.can_reborn()

返回类型 Bool 是否可以复活

Character.set_character_prefab

描述: 改变角色预设

Character.set_character_prefab(_c_key, _reset_prop, _reset_trigger_system, _reset_model)

参数列表:

参数	类型	说明
_c_key	CharacterKey	角色预设
_reset_prop	Bool	重置属性
_reset_trigger_system	Bool	重置蛋码
_reset_model	Bool	重置外观

Unit.set_paint_area_color

描述: 改变组件颜色

Unit.set_paint_area_color(_paint_area, _color)

参数列表:

参数	类型	说明
_paint_area	PaintArea	染色区域
_color	Color	颜色

LifeComp.set_auto_reborn_enabled

描述: 设置自动复活

LifeComp.set_auto_reborn_enabled(_auto_reborn)

参数列表:

参数	类型	说明
_auto_reborn	Bool	是否自动复活

AbilityComp.break_ability_accumulate

描述: 打断技能蓄力

参数	类型	说明
_ability	Ability	技能对象

返回类型 Bool 是否成功移除

LifeComp.die

描述: 使生物死亡

LifeComp.die(_dmg_unit)

参数列表:

参数	类型	说明
_dmg_unit	Unit	伤害来源

LifeEntity.try_exit_vehicle

描述: 生命体尝试下载具

LifeEntity.try_exit_vehicle()

AttrComp.get_attr_base_extra_fixed

描述: 获取属性的基础加成值(复杂模式)

AttrComp.get_attr_base_extra_fixed(_key)

参数列表:

参数	类型	说明
_key	Str	属性名

返回类型 Fixed 基础加成值

AttrComp.get_attr_bonus_fixed

描述: 获取属性的额外固定值(复杂模式)

AttrComp.get_attr_bonus_fixed(_key)

参数列表:

参数	类型	说明
_key	Str	属性名

返回类型 Fixed 额外固定值

AttrComp.get_attr_ratio_fixed

描述: 获取属性的倍率值(复杂模式)

AttrComp.get_attr_ratio_fixed(_key)

参数列表:

参数	类型	说明
_key	Str	属性名

返回类型 Fixed 倍率值

AttrComp.get_attr_raw_fixed

描述: 获取属性的基础值(复杂模式)

AttrComp.get_attr_raw_fixed(_key)

参数列表:

参数	类型	说明
_key	Str	属性名

返回类型 Fixed 基础值

LifeComp.set_infinite_reborn_enabled

描述: 设置无限复活

LifeComp.set_infinite_reborn_enabled(_enable_reborn)

参数列表:

参数	类型	说明
_enable_reborn	Bool	是否无限复活

LifeEntity.is_ghost_mode

描述: 生命体是否进入魂蛋模式

LifeEntity.is_ghost_mode()

返回类型 Bool 是否处于魂蛋模式

Unit.get_local_offset_position

描述: 获取单位局部偏移位置

Unit.get_local_offset_position(_offset)

参数列表:

参数	类型	说明
_offset	Vector3	偏移向量

返回类型 Point3 偏移位置

LifeComp.reborn

描述: 使生物复活

LifeComp.reborn(_immediate)

参数列表:

参数	类型	说明
_immediate	Bool	立即复活

LifeComp.set_reborn_time

描述: 设置复活时间

LifeComp.set_reborn_time(_reborn_time)

参数列表:

参数	类型	说明
_reborn_time	Fixed	复活时间

LifeEntity.reset_model

描述: 还原模型变化

LifeEntity.reset_model()

Character.reset_target_socket_model

描述: 还原角色指定外观部位变化

Character.reset_target_socket_model(_model_socket)

参数列表:

参数	类型	说明
_model_socket	ModelSocket	外观部位

ModifierComp.destroy_modifier

描述: 销毁效果

ModifierComp.destroy_modifier(_modifier)

参数列表:

参数	类型	说明
_modifier	Modifier	效果对象

AbilityComp.set_ability_to_slot

描述: 替换技能槽位(UGC槽位)

AbilityComp.set_ability_to_slot(_ability, _ability_index)

参数列表:

参数	类型	说明
_ability	Ability	技能对象
_ability_index	AbilitySlot	技能槽位

返回类型 Ability 被替换的旧技能

LifeEntity.set_direction

描述: 设置朝向

LifeEntity.set_direction(_face_dir)

参数列表:

参数	类型	说明
_face_dir	Vector3	方向

MoveStatusComp.start_face_lock_target

描述: 开始锁定面向目标

MoveStatusComp.start_face_lock_target(_target_unit, _time)

参数列表:

参数	类型	说明
_target_unit	Unit	锁定对象
_time	Fixed	持续时间

MoveStatusComp.stop_face_lock_target

描述: 结束锁定面向目标

MoveStatusComp.stop_face_lock_target()

CharacterComp.start_forced_move

描述: 开始强制位移

CharacterComp.start_forced_move(_vel, _duration, _enable_phy)

参数列表:

参数	类型	说明
_vel	Vector3	移动速度
_duration	Fixed	持续时间
_enable_phy	Bool	是否保留物理

AttrComp.change_attr_bonus_fixed

描述: 改变属性的额外固定值(复杂模式)

AttrComp.change_attr_bonus_fixed(_key, _value)

参数列表:

参数	类型	说明
_key	Str	属性名
_value	Fixed	额外固定值

AttrComp.change_attr_ratio_fixed

描述: 改变属性的倍率值(复杂模式)

AttrComp.change_attr_ratio_fixed(_key, _value)

参数列表:

参数	类型	说明
_key	Str	属性名
_value	Fixed	倍率值

AttrComp.change_attr_raw_fixed

描述: 改变属性的基础值(复杂模式)

AttrComp.change_attr_raw_fixed(_key, _value)

参数列表:

参数	类型	说明
_key	Str	属性名
_value	Fixed	基础值

CharacterComp.stop_forced_move

描述: 退出当前强制位移

CharacterComp.stop_forced_move()

LiftComp.lift_unit

描述: 举起单位

LiftComp.lift_unit(_unit)

参数列表:

参数	类型	说明
_unit	Unit	被抓举单位

BuffStateComp.clear_state

描述: 清除状态

BuffStateComp.clear_state(_state_id)

参数列表:

参数	类型	说明
_state_id	BuffState	状态

KVBase.clear_kv

描述: 清空自定义值

KVBase.clear_kv()

EquipmentComp.clear_selected_equipment_slot

描述: 清除单位物品格选中状态

EquipmentComp.clear_selected_equipment_slot()

KVBase.clear_tag

描述: 清空标签

KVBase.clear_tag()

Role.consume_commodity

描述: 消耗玩家指定数量道具

Role.consume_commodity(_commodity_id, _num)

参数列表:

参数	类型	说明
_commodity_id	UgcCommodity	道具
_num	Int	数量

EquipmentComp.create_equipment_to_slot

描述: 创建物品到指定类型槽位

EquipmentComp.create_equipment_to_slot(_key, _slot_type)

参数列表:

参数	类型	说明
_key	EquipmentKey	物品编号
_slot_type	EquipmentSlotType	槽位类型

参数	类型	说明
_role	Role	所属玩家

Unit.get_name

描述: 获取单位名称

Unit.get_name()

返回类型 Str 名称

CharacterComp.get_scale_ratio

描述: 获取缩放倍率

CharacterComp.get_scale_ratio()

返回类型 Fixed 缩放倍率

Unit.hide_bubble_msg

描述: 关闭气泡信息

Unit.hide_bubble_msg()

DisplayComp.play_body_anim_by_id

描述: 播放全身动画

DisplayComp.play_body_anim_by_id(_anim_id, _start_time, _play_time, _is_loop)

参数列表:

参数	类型	说明
_anim_id	AnimKey	动画编号
_start_time	Fixed	开始时间
_play_time	Fixed	持续时间
_is_loop	Bool	是否循环

Unit.play_emoji

描述: 单位发送表情

Unit.play_emoji(_emoji_key)

参数列表:

参数	类型	说明
_emoji_key	EmojiKey	表情编号

DisplayComp.play_upper_anim_by_id

描述: 播放上半身动画

DisplayComp.play_upper_anim_by_id(_anim_id, _start_time, _play_time, _is_loop)

参数列表:

参数	类型	说明
_anim_id	AnimKey	动画编号
_start_time	Fixed	开始时间
_play_time	Fixed	持续时间
_is_loop	Bool	是否循环

DisplayComp.set_anim_rate

描述: 设置播放速率

DisplayComp.set_anim_rate(_anim_rate)

参数列表:

参数	类型	说明
_anim_rate	Fixed	播放速率

Creature.set_draggable

描述: 设置生物是否可拖动

Creature.set_draggable(_enable)

参数列表:

参数	类型	说明
_enable	Bool	是否可拖动

Creature.set_name

描述: 设置生物的显示名称

Creature.set_name(_name)

参数列表:

参数	类型	说明
_name	Str	显示名称

Creature.set_name_visible

描述: 设置生物是否显示名称

Creature.set_name_visible(_visible)

参数列表:

参数	类型	说明
_visible	Bool	是否显示名称

Creature.set_touchable

描述: 设置生物是否可点击

Creature.set_touchable(_enable)

参数列表:

参数	类型	说明
_enable	Bool	是否可点击

Unit.show_bubble_msg

描述: 发送气泡信息

Unit.show_bubble_msg(_show_msg, _show_time, _max_dis, _offset)

参数列表:

参数	类型	说明
_show_msg	Str	气泡信息
_show_time	Fixed	持续时间
_max_dis	Fixed	隐藏距离
_offset	Vector3	偏移

DisplayComp.stop_anim

描述: 停止播放动画

参数	类型	说明
_index	Int	索引

ExprDeviceComp.enable_expr_device_by_name

描述: 通过名称激活表现器

ExprDeviceComp.enable_expr_device_by_name(_name)

参数列表:

参数	类型	说明
_name	Str	名称

Unit.enable_interact

描述: 激活单位互动

Unit.enable_interact()

Unit.enable_motor

描述: 激活运动器

Unit.enable_motor(_index)

参数列表:

参数	类型	说明
_index	Int	索引

AbilityComp.get_abilities

描述: 获取单位所有技能

AbilityComp.get_abilities()

返回类型 ListAbility 技能对象

Ability.get_accumulate_ratio

描述: 获取技能蓄力百分比

参数	类型	说明
_height	Fixed	高度差
_use_fixed_release_point	Bool	施法点是否固定

返回类型 ListObstacle 可以影响的组件列表

Ability.get_cd_time

描述: 获取技能冷却时间

Ability.get_cd_time()

返回类型 Fixed 技能冷却时间

Ability.get_left_charge_time

描述: 获取技能剩余充能时间

Ability.get_left_charge_time()

返回类型 Fixed 剩余充能时间

Ability.get_desc

描述: 获取技能描述

Ability.get_desc()

返回类型 Str 技能描述

Ability.get_pointer_type

描述: 获取技能指示器类型

Ability.get_pointer_type()

返回类型 AbilityPointerType 指示器类型

Ability.get_key

描述: 获取技能编号

Ability.get_key()

返回类型 AbilityKey 技能编号

Ability.get_left_cd_time

描述: 获取技能剩余冷却时间

Ability.get_left_cd_time()

返回类型 Fixed 剩余冷却时间

Ability.get_lock_target_char

描述: 获取技能锁定角色

Ability.get_lock_target_char()

返回类型 Character 角色

Ability.get_lock_target_creature

描述: 获取技能锁定生物

Ability.get_lock_target_creature()

返回类型 Creature 生物

Ability.get_lock_target

描述: 获取技能锁定目标

Ability.get_lock_target()

返回类型 LifeEntity 获取技能锁定目标

Ability.get_name

描述: 获取技能名称

Ability.get_name()

返回类型 Str 技能名称

Ability.get_owner

描述: 获取技能拥有者

Ability.get_owner()

返回类型 LifeEntity 技能拥有者

Ability.get_owner_character

描述: 获取技能拥有角色

Ability.get_owner_character()

返回类型 Unit 角色

Ability.get_owner_creature

描述: 获取技能拥有生物

Ability.get_owner_creature()

返回类型 Unit 生物

Ability.get_owner_equipment

描述: 获取拥有技能的物品

Ability.get_owner_equipment()

返回类型 Equipment 技能拥有者

Ability.get_release_direction

描述: 获取技能释放方向

Ability.get_release_direction()

返回类型 Vector3 方向

Ability.get_release_direction_list

描述: 获取技能复数释放方向

Ability.get_release_direction_list()

返回类型 ListVector3 方向

Ability.get_release_point

描述: 获取技能释放坐标点

Ability.get_release_point()

返回类型 Point3 坐标点

Ability.get_release_point_list

描述: 获取技能复数释放坐标点

Ability.get_release_point_list()

返回类型 ListPoint3 坐标点

Ability.get_ability_slot

描述: 获取技能所在槽位

Ability.get_ability_slot()

返回类型 AbilitySlot 技能槽位

Role.get_achievement_progress

描述: 获取成就进度

Role.get_achievement_progress(_event_id)

参数列表:

参数	类型	说明
_event_id	Achievement	成就

返回类型 Int 成就进度

Obstacle.get_billboard_text

描述: 获取公告板文本内容

Obstacle.get_billboard_text()

返回类型 Str 公告板内容

Obstacle.get_billboard_font_size

描述: 获取公告板文本字体大小

Obstacle.get_billboard_font_size()

返回类型 Int 公告板字体大小

BuffStateComp.get_state_count

描述: 获取限制状态计数

BuffStateComp.get_state_count(_state_id)

参数列表:

参数	类型	说明
_state_id	BuffState	状态

返回类型 Int 状态计数

BuffStateComp.get_state_list

描述: 获取所有限制状态

BuffStateComp.get_state_list()

返回类型 ListBuffState 状态列表

Role.get_camera_direction

描述: 获取玩家相机的朝向(需要开启玩家相机旋转同步)

Role.get_camera_direction()

返回类型 Vector3 相机朝向

Camp.get_name

描述: 获取阵营名称

Camp.get_name()

返回类型 Str 名称

Unit.get_parent

描述: 获取父单位

Unit.get_parent()

返回类型 Unit 单位

Character.get_ability_point

描述: 获取技能点

Character.get_ability_point()

返回类型 Int 技能点

Obstacle.get_chess_rank

描述: 获取牌数(对象只能为麻将/扑克)

Obstacle.get_chess_rank()

返回类型 Int 牌数

Unit.get_child_customtriggerspaces

描述: 获得所有子触发区域单位

Unit.get_child_customtriggerspaces()

返回类型 ListCustomTriggerSpace 触发区域列表

Unit.get_child_obstacles

描述: 获得所有子物理组件单位

Unit.get_child_obstacles()

返回类型 ListObstacle 组件列表

Unit.get_children

描述: 获得所有子单位

Unit.get_children()

返回类型 ListUnit 单位列表

Character.get_ctrl_role

描述: 获取控制角色的玩家

Character.get_ctrl_role()

返回类型 Role 玩家

Role.get_ctrl_unit

描述: 获取控制单位

Role.get_ctrl_unit()

返回类型 Character 单位

CustomTriggerSpace.random_point

描述: 获取触发区域内的随机坐标

CustomTriggerSpace.random_point()

返回类型 Vector3 坐标

Equipment.is_auto_picking

描述: 获取物品是否自动拾取

Equipment.is_auto_picking()

返回类型 Bool 是否自动拾取

Equipment.is_auto_using

描述: 获取物品是否自动使用

Equipment.is_auto_using()

返回类型 Bool 是否自动使用

Equipment.can_drop

描述: 获取物品能否丢弃

Equipment.can_drop()

返回类型 Bool 能否丢弃

Equipment.get_current_stack_num

描述: 获取物品当前堆叠层数

Equipment.get_current_stack_num()

返回类型 Int 当前堆叠层数

Equipment.get_desc

描述: 获取物品描述

Equipment.get_desc()

返回类型 Str 物品描述

Equipment.get_price

描述: 获取物品的抵押价格

Equipment.get_price(_res_type)

参数列表:

参数	类型	说明
_res_type	Str	货币类型

返回类型 Int 卖价

Equipment.has_owner

描述: 物品是否被持有

Equipment.has_owner()

返回类型 Bool 是否被持有

Equipment.get_key

描述: 获取物品的物品编号

Equipment.get_key()

返回类型 EquipmentKey 物品编号

EquipmentComp.get_equipment_list_by_slot_type

描述: 获取持有的物品列表

EquipmentComp.get_equipment_list_by_slot_type(_slot_type)

参数列表:

参数	类型	说明
_slot_type	EquipmentSlotType	槽位类型

返回类型 ListEquipment 物品

EquipmentComp.get_equipment_max_count

描述: 获取最大可持有的物品数量

EquipmentComp.get_equipment_max_count(_slot_type)

参数列表:

参数	类型	说明
_slot_type	EquipmentSlotType	槽位类型

返回类型 Int 数量

Equipment.get_max_stack_num

描述: 获取物品最大堆叠层数

Equipment.get_max_stack_num()

返回类型 Int 最大堆叠层数

Equipment.get_name

描述: 获取物品名称

Equipment.get_name()

返回类型 Str 物品名称

Equipment.get_owner_character

描述: 获取持有物品的角色

Equipment.get_owner_character()

返回类型 Character 角色

Equipment.get_owner_creature

描述: 获取持有物品的生物

Equipment.get_owner_creature()

返回类型 Creature 生物

Equipment.get_position

描述: 获取物品位置

Equipment.get_position()

返回类型 Point3 物品位置

Equipment.get_equipment_slot

描述: 获取物品所在槽位

Equipment.get_equipment_slot()

返回类型 EquipmentSlot 槽位

Equipment.get_slot_type

描述: 获取物品所在槽位类型

Equipment.get_slot_type()

返回类型 EquipmentSlotType 槽位类型

Equipment.get_equipment_type

描述: 获取物品的物品类型

Equipment.get_equipment_type()

返回类型 EquipmentType 物品类型

LifeEntity.get_direction

描述: 获取朝向

LifeEntity.get_direction()

返回类型 Vector3 方向

UnitInteractVolumeComp.get_interact_id

描述: 获取单位互动按钮ID

UnitInteractVolumeComp.get_interact_id(_interact_index, _interact_btn_type)

参数列表:

参数	类型	说明
_interact_index	Int	互动索引
_interact_btn_type	InteractBtnType	互动按钮类型

返回类型 InteractBtnID 互动按钮ID

Ability.is_in_cd

描述: 技能是否在冷却中

Ability.is_in_cd()

返回类型 Bool 剩余冷却时间

Ability.is_in_charge

描述: 技能是否在充能中

Ability.is_in_charge()

返回类型 Bool 剩余冷却时间

JointAssistantComp.get_joint_assistant_primary_obstacle

描述: 获取关节组件主体

JointAssistantComp.get_joint_assistant_primary_obstacle()

返回类型 Character 关节组件主体

JointAssistantComp.get_joint_assistant_target_obstacle

描述: 获取关节组件目标

JointAssistantComp.get_joint_assistant_target_obstacle()

返回类型 Character 关节组件目标

JointAssistantComp.get_joint_assistant_type

描述: 获取关节组件类型

JointAssistantComp.get_joint_assistant_type()

返回类型 JointAssistantType 关节类型

LifeEntity.get_hpbar_scale_x

描述: 获取生命体血条宽度缩放

LifeEntity.get_hpbar_scale_x()

返回类型 Fixed 宽度缩放

LifeEntity.get_hpbar_scale_y

描述: 获取生命体血条高度缩放

LifeEntity.get_hpbar_scale_y()

返回类型 Fixed 高度缩放

LifeEntity.get_lifted_lifeentity

描述: 获取指定生命体当前抓举的生命体

LifeEntity.get_lifted_lifeentity()

返回类型 LifeEntity 被抓举的生命体

LifeEntity.get_lifted_obstacle

描述: 获取指定生命体当前抓举的组件

LifeEntity.get_lifted_obstacle()

返回类型 Obstacle 被抓举的组件

LiftComp.get_lift_cooldown

描述: 获取举起冷却时间

LiftComp.get_lift_cooldown()

返回类型 Fixed 实数

LiftComp.get_lift_remaining_cooldown

描述: 获取举起剩余冷却时间

LiftComp.get_lift_remaining_cooldown()

返回类型 Fixed 实数

Unit.get_linear_velocity

描述: 获取单位线速度

Unit.get_linear_velocity()

返回类型 Vector3 线速度

Unit.get_local_direction

描述: 获取单位本地坐标系下的方向

Unit.get_local_direction(_direction_type)

参数列表:

参数	类型	说明
_direction_type	DirectionType	方向

返回类型 Vector3 向量

Unit.get_local_quaternion

描述: 获取单位本地坐标系下的旋转角

Unit.get_local_quaternion(_direction_type)

参数列表:

参数	类型	说明
_direction_type	DirectionType	方向

返回类型 Quaternion Quaternion

Modifier.get_max_stack_count

描述: 获取效果的最大层数

Modifier.get_max_stack_count()

返回类型 Str 层数

ModifierComp.get_modifier_by_modifier_key

描述: 获取单位效果

ModifierComp.get_modifier_by_modifier_key(_modifier_id)

参数列表:

参数	类型	说明
_modifier_id	ModifierKey	效果ID

返回类型 Modifier 效果对象

ModifierComp.get_modifiers

描述: 获取单位所有效果

ModifierComp.get_modifiers()

返回类型 ListModifier 效果

Modifier.get_desc

描述: 获取效果描述

Modifier.get_desc()

返回类型 Str 效果描述

Modifier.get_key

描述: 获得效果编号

Modifier.get_key()

返回类型 ModifierKey 效果编号

Modifier.get_name

描述: 获取效果名称

Modifier.get_name()

返回类型 Str 效果名称

Modifier.get_owner_unit

描述: 获取效果携带者

Modifier.get_owner_unit()

返回类型 Unit 效果携带者

Modifier.get_owner_ability

描述: 获取所属技能

Modifier.get_owner_ability()

返回类型 Ability 所属技能

Modifier.get_owner_character

描述: 获取效果携带角色

Modifier.get_owner_character()

返回类型 Character 角色

Modifier.get_owner_creature

描述: 获取效果携带生物

Modifier.get_owner_creature()

返回类型 Creature 生物

Modifier.get_owner_life_entity

描述: 获取携带效果的生命体

Modifier.get_owner_life_entity()

返回类型 LifeEntity 生命体

Modifier.get_remain_duration

描述: 获取效果剩余持续时间

Modifier.get_remain_duration()

返回类型 Fixed 剩余持续时间

OwnerComp.get_owner_role

描述: 获取所属玩家

OwnerComp.get_owner_role()

返回类型 Role 所属玩家

Role.get_camera_rotation

描述: 获取玩家相机的旋转(需要开启玩家相机旋转同步)

Role.get_camera_rotation()

返回类型 Quaternion 相机旋转

Camp.get_roles

描述: 获取阵营内玩家列表

Camp.get_roles()

返回类型 ListRole 玩家列表

Role.get_name

描述: 获取玩家昵称

Role.get_name()

返回类型 Str 名字

Role.get_voice_volume

描述: 获取语音音量

Role.get_voice_volume()

返回类型 Fixed 相机旋转

RollComp.get_roll_remaining_cooldown

描述: 获取滚动剩余冷却时间

RollComp.get_roll_remaining_cooldown()

返回类型 Fixed 剩余冷却时间

RushComp.get_rush_remaining_cooldown

描述: 获取飞扑剩余冷却时间

RushComp.get_rush_remaining_cooldown()

返回类型 Fixed 剩余冷却时间

EquipmentComp.get_selected_equipment

描述: 获取当前选中的物品

EquipmentComp.get_selected_equipment()

返回类型 Equipment 物品

EquipmentComp.get_equipment_by_slot

描述: 获取身上的物品

EquipmentComp.get_equipment_by_slot(_slot_type, _slot_index)

参数列表:

参数	类型	说明
_slot_type	EquipmentSlotType	槽位类型
_slot_index	Int	槽位索引

返回类型 Equipment 物品

Modifier.get_stack_count

描述: 获取效果当前层数

Modifier.get_stack_count()

返回类型 Str 层数

AbilityComp.get_ability_by_slot

描述: 获取对应槽位技能

AbilityComp.get_ability_by_slot(_ability_slot)

参数列表:

参数	类型	说明
_ability_slot	AbilitySlot	技能槽位

返回类型 Ability 技能对象

EquipmentComp.get_equipment_list

描述: 获取角色/生物持有的物品预设列表

EquipmentComp.get_equipment_list(_equipment_key, _exclude_equipped, _exclude_bag)

参数列表:

参数	类型	说明
_equipment_key	EquipmentKey	物品类型
_exclude_equipped	Bool	不搜索物品栏
_exclude_bag	Bool	不搜索背包栏

返回类型 ListEquipment 物品列表

Actor.get_id

描述: 获取单位ID

Actor.get_id()

返回类型 UnitID 单位ID

Unit.get_key

描述: 获取单位编号

Unit.get_key()

返回类型 UnitKey 单位编号

Unit.get_orientation

描述: 获得单位旋转

Unit.get_orientation()

返回类型 Quaternion 旋转

Unit.get_position

描述: 获取单位坐标

Unit.get_position()

返回类型 Vector3 坐标

Unit.get_rigid_body_type

描述: 获取受力类型

Unit.get_rigid_body_type()

返回类型 RigidBodyType 受力类型

Unit.get_scale

描述: 获得单位缩放

Unit.get_scale()

返回类型 Vector3 缩放

Unit.get_unit_type

描述: 获取单位类型

Unit.get_unit_type()

返回类型 UnitType 单位类型

TriggerSpace.get_virtual_light_brightness

描述: 获取光源亮度

参数	类型	说明
_increase	Int	技能点

Camp.get_camp_score

描述: 获取阵营积分

Camp.get_camp_score()

返回类型 Int 积分

Role.get_score

描述: 获取玩家积分

Role.get_score()

返回类型 Int 积分

LifeComp.is_die_status

描述: 是否处于死亡状态

LifeComp.is_die_status()

返回类型 Bool 处于死亡

Unit.is_model_visible

描述: 单位模型是否可见

Unit.is_model_visible()

返回类型 Bool 是否隐藏

Unit.is_physics_active

描述: 单位物理是否生效

Unit.is_physics_active()

返回类型 Bool 是否物理生效

LifeEntity.is_draggable

描述: 获取生命体是否可拖动

LifeEntity.is_draggable()

返回类型 Bool 可拖动

LifeEntity.is_touchable

描述: 获取生命体是否可点击

LifeEntity.is_touchable()

返回类型 Bool 可点击

MoveStatusComp.is_fling_status

描述: 是否滚动

MoveStatusComp.is_fling_status()

返回类型 Bool 布尔

CharacterComp.is_forced_moving

描述: 是否正在强制位移

CharacterComp.is_forced_moving()

返回类型 Bool 布尔

ModifierComp.has_modifier_by_key

描述: 是否拥有指定编号的效果

ModifierComp.has_modifier_by_key(_modifier_key)

参数列表:

参数	类型	说明
_modifier_key	ModifierKey	效果编号

返回类型 Bool 是否拥有

LiftComp.is_lift_status

描述: 是否处于抓举状态

LiftComp.is_lift_status()

返回类型 Bool 抓举

LiftedComp.is_lifted_status

描述: 是否处于被抓举

LiftedComp.is_lifted_status()

返回类型 Bool 被抓举

MoveStatusComp.is_lost_control_status

描述: 是否失控

MoveStatusComp.is_lost_control_status()

返回类型 Bool 布尔

Obstacle.is_draggable

描述: 获取组件是否可拖动

Obstacle.is_draggable()

返回类型 Bool 是否可拖动

Obstacle.is_touchable

描述: 获取组件是否可点击

Obstacle.is_touchable()

返回类型 Bool 是否可点击

JumpComp.is_on_ground

描述: 是否位于地面

JumpComp.is_on_ground()

返回类型 Bool 是否位于地面

Role.is_gallery_vip

描述: 是否是乐园会员

Role.is_gallery_vip()

返回类型 Bool 是否是乐园会员

Role.has_commodity

描述: 玩家是否拥有道具

Role.has_commodity(_commodity_id)

参数列表:

参数	类型	说明
_commodity_id	UgcCommodity	道具

返回类型 Bool 是否拥有道具

Role.has_saved_archive

描述: 玩家是否记录过存档

Role.has_saved_archive()

返回类型 Bool 是否记录过存档

Role.is_map_liked

描述: 是否点赞本地图

Role.is_map_liked()

返回类型 Bool 是否点赞

Role.is_lost

描述: 玩家是否失败

Role.is_lost()

返回类型 Bool 玩家是否失败

Role.is_online

描述: 玩家是否在线

Role.is_online()

返回类型 Bool 是否在线

Role.is_map_favorited

描述: 是否收藏本地图

Role.is_map_favorited()

返回类型 Bool 是否收藏

Role.is_pass_premium_vip

描述: 是否是派对手册进阶会员

Role.is_pass_premium_vip()

返回类型 Bool 是否是派对手册进阶会员

Role.is_won

描述: 玩家是否胜利

Role.is_won()

返回类型 Bool 玩家是否胜利

Unit.is_in_customtriggerspace

描述: 单位是否在触发区域内

Unit.is_in_customtriggerspace(_custom_trigger_space, _consider_mask)

参数列表:

参数	类型	说明
_custom_trigger_space	CustomTriggerSpace	触发区域
_consider_mask	Bool	考虑掩码

返回类型 Bool 布尔

Unit.is_valid_ability_target

描述: 判断单位是否满足作为技能释放目标的条件

Unit.is_valid_ability_target(_ability)

参数列表:

参数	类型	说明
_ability	Ability	对应技能

返回类型 Bool 目标是否满足条件

Role.get_last_archive_timestamp

描述: 获取玩家上次存档时间

Role.get_last_archive_timestamp()

返回类型 Timestamp 时间戳

LevelComp.gain_exp

描述: 获得经验

LevelComp.gain_exp(_killed_exp)

参数列表:

参数	类型	说明
_killed_exp	Fixed	经验值

LevelComp.get_exp

描述: 获取当前经验值

LevelComp.get_exp()

返回类型 Fixed 经验值

LevelComp.get_killed_exp

描述: 获取击杀经验点

LevelComp.get_killed_exp()

返回类型 Fixed 击杀经验值

LevelComp.get_level

描述: 获得当前等级

LevelComp.get_level()

返回类型 Int 当前等级

LevelComp.level_up

描述: 升级

LevelComp.level_up()

LevelComp.set_killed_exp

描述: 设置击杀经验点

LevelComp.set_killed_exp(_killed_exp)

参数列表:

参数	类型	说明
_killed_exp	Fixed	击杀经验值

LifeEntity.start_move_by_direction

描述: 命令生命体移动

LifeEntity.start_move_by_direction(_direction, _duration)

参数列表:

参数	类型	说明
_direction	Vector3	移动方向
_duration	Fixed	持续时间

LifeEntity.start_move_to_pos_with_threshold

描述: 命令生命体移动到坐标点

LifeEntity.start_move_to_pos_with_threshold(_target_pos, _duration, _threshold)

参数列表:

参数	类型	说明
_target_pos	Point3	目标点
_duration	Fixed	持续时间
_threshold	Fixed	容错距离

EquipmentComp.consume_equipment

描述: 消耗物品

EquipmentComp.consume_equipment(_equipment_key, _consume_num)

参数列表:

参数	类型	说明
_equipment_key	EquipmentKey	物品编号
_consume_num	Int	消耗数量

LifeEntity.get_hard_punch_threshold

描述: 获取生命体大力击倒阈值

LifeEntity.get_hard_punch_threshold()

LifeEntity.get_owner

描述: 获取生命体控制玩家

LifeEntity.get_owner()

返回类型 Role 控制玩家

LifeEntity.get_punch_threshold

描述: 获取生命体击倒阈值

LifeEntity.get_punch_threshold()

Unit.is_character

描述: 是否为角色

Unit.is_character()

返回类型 Bool 单位

LifeEntity.swap_equipment_slot

描述: 交换物品槽位

LifeEntity.swap_equipment_slot(_equipment, _slot_type, _slot)

参数列表:

参数	类型	说明
_equipment	Equipment	物品
_slot_type	EquipmentSlotType	槽位类型
_slot	EquipmentSlot	槽位

Unit.play_emoji_with_offset

描述: 发送气泡表情

Unit.play_emoji_with_offset(_emoji_key, _show_time, _offset)

参数列表:

参数	类型	说明
_emoji_key	EmojiKey	表情
_show_time	Fixed	持续时间
_offset	Vector3	偏移

LifeEntity.play_face_expression

描述: 播放面部表情

LifeEntity.play_face_expression(_emoji_key, _show_time)

参数列表:

参数	类型	说明
_emoji_key	EmojiKey	表情
_show_time	Fixed	持续时间

LifeEntity.set_hard_punch_threshold

描述: 设置生命体大力击倒阈值

LifeEntity.set_hard_punch_threshold(_punch_threshold)

参数列表:

参数	类型	说明
_punch_threshold	Fixed	击倒阈值

LifeEntity.set_punch_threshold

描述: 设置生命体击倒阈值

LifeEntity.set_punch_threshold(_punch_threshold)

参数列表:

参数	类型	说明
_punch_threshold	Fixed	击倒阈值

Equipment.move_to_slot

描述: 移动物品到指定槽位

Equipment.move_to_slot(_slot_type, _slot)

参数列表:

参数	类型	说明
_slot_type	EquipmentSlotType	槽位类型
_slot	Int	槽位

Unit.add_circle_motor

描述: 添加圆周运动

Unit.add_circle_motor(_vel, _time, _is_local)

参数列表:

参数	类型	说明
_vel	Vector3	角速度
_time	Fixed	时间
_is_local	Bool	是否局部空间

Unit.add_linear_motor

描述: 添加直线运动

Unit.add_linear_motor(_vel, _time, _is_local)

参数列表:

参数	类型	说明
_vel	Vector3	线速度
_time	Fixed	时间
_is_local	Bool	是否局部空间

Unit.add_surround_motor

描述: 添加环绕运动

Unit.add_surround_motor(_follow_target, _ang_vel, _time, _follow_rotate)

参数列表:

参数	类型	说明
_follow_target	Unit	环绕目标
_ang_vel	Vector3	角速度
_time	Fixed	时间
_follow_rotate	Bool	是否跟随旋转

Unit.remove_surround_motor

描述: 停止环绕运动

Unit.remove_surround_motor()

Unit.get_angular_velocity

描述: 获取单位角速度

Unit.get_angular_velocity()

返回类型 Vector3 角速度

Unit.is_dynamic

描述: 组件是否为受力物体

Unit.is_dynamic()

参数	类型	说明
_sfx_key	SfxKey	特效编号
_duration	Fixed	持续时间
_rate	Fixed	播放速率

返回类型 SfxID 特效ID

Unit.play_sound_with_dis_and_attenuation

描述: 单位开始播放声音

Unit.play_sound_with_dis_and_attenuation(_event_id, _vis_dis, _sound_attenuation_curve)

参数列表:

参数	类型	说明
_event_id	SoundKey	声音编号
_vis_dis	Fixed	音效传播距离
_sound_attenuation_curve	Str	衰减曲线

返回类型 SoundID 音效ID

AbilityComp.remove_ability_by_key

描述: 根据技能编号移除技能

AbilityComp.remove_ability_by_key(_ability_key)

参数列表:

参数	类型	说明
_ability_key	AbilityKey	技能编号

返回类型 Bool 是否成功移除

ItemBox.remove_ability

描述: 移除道具箱刷新技能

ItemBox.remove_ability(_ability_key)

参数列表:

参数	类型	说明
_ability_key	AbilityKey	技能编号

DisplayComp.unbind_model

描述: 移除绑定模型

DisplayComp.unbind_model(_bind_id)

参数列表:

参数	类型	说明
_bind_id	Str	绑定ID

BuffStateComp.remove_state

描述: 移除状态

BuffStateComp.remove_state(_state_id)

参数列表:

参数	类型	说明
_state_id	BuffState	状态

Unit.remove_from_parent

描述: 从父节点移除

Unit.remove_from_parent()

KVBase.remove_kv

描述: 移除自定义值

KVBase.remove_kv(_key)

参数列表:

参数	类型	说明
_key	Str	名称

ModifierComp.remove_modifier_by_key

描述: 移除效果

ModifierComp.remove_modifier_by_key(_modifier_id)

参数列表:

参数	类型	说明
_modifier_id	ModifierKey	效果编号

KVBase.remove_tag

描述: 移除标签

KVBase.remove_tag(_tag)

参数列表:

参数	类型	说明
_tag	Str	标签

AbilityComp.remove_ability

描述: 移除槽位上的技能

AbilityComp.remove_ability(_ability_slot)

参数列表:

参数	类型	说明
_ability_slot	AbilitySlot	技能槽位

返回类型 Bool 是否成功移除

Role.reset_camera

描述: 重置玩家相机

Role.reset_camera(_reset_angle, _reset_bind, _reset_point, _reset_prop_pitch)

参数列表:

参数	类型	说明
_reset_angle	Bool	重置相机角度
_reset_bind	Bool	重置相机模式
_reset_point	Bool	重置相机相对于焦点的位置
_reset_prop_pitch	Bool	重置俯仰角范围

Role.add_score

描述: 增加玩家积分

Role.add_score(_add_score)

参数列表:

参数	类型	说明
_add_score	Int	积分

Role.get_camp

描述: 获取玩家阵营

Role.get_camp()

返回类型 Camp 阵营

Role.enter_watch_mode

描述: 玩家进入观战

Role.enter_watch_mode(_camp_limit, _exit_visible)

参数列表:

参数	类型	说明
_camp_limit	Bool	是否限制阵营观战
_exit_visible	Bool	是否支持手动退出

Role.exit_watch_mode

描述: 玩家退出观战

Role.exit_watch_mode()

Role.get_commodity_count

描述: 玩家拥有道具数量

Role.get_commodity_count(_commodity_id)

参数列表:

参数	类型	说明
_commodity_id	UgcCommodity	道具

返回类型 Int 拥有道具数量

Role.is_achievement_completed

描述: 成就是否完成

Role.is_achievement_completed(_event_id)

参数列表:

参数	类型	说明
_event_id	Achievement	成就

返回类型 Bool 是否完成

Role.is_watch_mode

描述: 玩家进入观战

Role.is_watch_mode()

返回类型 Bool 是否处于观战模式

Role.play_2d_sound_with_params

描述: 玩家播放2D音效

Role.play_2d_sound_with_params(_event_id, _duration, _volume, _speed)

参数列表:

参数	类型	说明
_event_id	SoundID	音效ID
_duration	Fixed	持续时间
_volume	Fixed	音量
_speed	Fixed	播放速度

返回类型 SoundID 音效ID

Role.pause_camera_motor

描述: 暂停玩家相机运动

Role.pause_camera_motor()

Role.play_advertisement_with_event

描述: 播放广告

Role.play_advertisement_with_event(_success_event, _fail_event, _ad_tag, _success_data, _fail_data)

参数列表:

参数	类型	说明
_success_event	Str	成功事件
_fail_event	Str	失败事件
_ad_tag	Str	广告标签
_success_data	Dict	成功附带参数
_fail_data	Dict	失败附带参数

Role.play_ui_effect

描述: 播放界面动效

Role.play_ui_effect(_effect_node)

参数列表:

参数	类型	说明
_effect_node	EEffectNode	UI动效

Role.play_montage

描述: 播放指定剧情动画

Role.play_montage(_montage_key, _start_time, _play_to_end, _play_time)

参数列表:

参数	类型	说明
_montage_key	MontageKey	剧情动画编号
_start_time	Fixed	起始时间
_play_to_end	Bool	是否播完
_play_time	Fixed	播放时长

Role.resume_camera_motor

描述: 恢复玩家相机运动

Role.resume_camera_motor()

Role.send_track_data_change

描述: 发送埋点数据变化

Role.send_track_data_change(_track_data_key, _change_num)

参数列表:

参数	类型	说明
_track_data_key	Str	埋点key
_change_num	Int	数据变化

描述: 设置物品格关联生命体

Role.set_bagslot_related_lifeentity(_bag_slot, _life_entity)

参数列表:

参数	类型	说明
_bag_slot	EBagSlot	UI物品格
_life_entity	LifeEntity	生命体

Role.set_battle_shop_visible

描述: 设置玩家商店显示

Role.set_battle_shop_visible(_battle_shop_id, _visible)

参数列表:

参数	类型	说明
_battle_shop_id	BattleShopKey	商店
_visible	Bool	显示/隐藏

描述: 玩家设置暗角

Role.set_blind_corner(_enable, _strength, _color)

参数列表:

参数	类型	说明
_enable	Bool	启用
_strength	Fixed	强度
_color	Color	颜色

Role.set_button_enabled

描述: 设置按钮控件的状态

Role.set_button_enabled(_button, _enabled)

参数列表:

参数	类型	说明
_button	EButton	UI按钮
_enabled	Bool	状态

Role.set_button_font_size

描述: 设置UI按钮节点文字字号

Role.set_button_font_size(_key, _font_size)

参数列表:

参数	类型	说明
_key	EButton	UI按钮节点
_font_size	Fixed	字号

Role.set_button_normal_image

描述: 设置UI按钮节点常态图片

Role.set_button_normal_image(_button, _image_key)

参数列表:

参数	类型	说明
_button	EButton	UI按钮节点
_image_key	ImageKey	图片

Role.set_button_pressed_image

描述: 设置UI按钮节点按下图片

Role.set_button_pressed_image(_button, _image_key)

参数列表:

参数	类型	说明
_button	EButton	UI按钮节点
_image_key	ImageKey	图片

Role.set_button_text

描述: 设置UI按钮节点文本

Role.set_button_text(_button, _text)

参数列表:

参数	类型	说明
_button	EButton	UI按钮节点
_text	Str	文本

Role.set_button_text_color

描述: 设置UI按钮节点文字颜色

Role.set_button_text_color(_button, _text_color)

参数列表:

参数	类型	说明
_button	EButton	UI按钮节点
_text_color	Color	颜色

Role.set_gyroscope_control_unit

描述: 设置玩家陀螺仪控制组件

Role.set_gyroscope_control_unit(_is_control, _unit)

参数列表:

参数	类型	说明
_is_control	Bool	是否由陀螺仪控制
_unit	Unit	单位

Role.set_image_color

描述: 设置UI图片颜色

Role.set_image_color(_image, _image_color, _transition_time)

参数列表:

参数	类型	说明
_image	EImage	UI图片节点
_image_color	Color	颜色
_transition_time	Fixed	变化时间

Role.set_image_texture_by_key_with_auto_resize

描述: 设置UI图片节点图片

Role.set_image_texture_by_key_with_auto_resize(_image, _image_key, _reset_size)

参数列表:

参数	类型	说明
_image	EImage	UI图片节点
_image_key	ImageKey	图片
_reset_size	Bool	是否重置大小

Role.set_input_field_text

描述: 设置UI输入节点文本

Role.set_input_field_text(_input_field, _text)

参数列表:

参数	类型	说明
_input_field	EInputField	UI输入节点
_text	Str	文本

Role.set_label_background_color

描述: 设置UI文本节点背景颜色

Role.set_label_background_color(_label, _color, _transition_time)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_color	Color	颜色
_transition_time	Fixed	变化时间

Role.set_label_background_opacity

描述: 设置UI文本节点背景不透明度

Role.set_label_background_opacity(_label, _opacity, _transition_time)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_opacity	Fixed	不透明度
_transition_time	Fixed	变化时间

Role.set_label_color

描述: 设置UI文本节点的字体颜色

Role.set_label_color(_label, _color, _transition_time)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_color	Color	颜色
_transition_time	Fixed	变化时间

Role.set_label_font

描述: 设置UI文本节点字体

Role.set_label_font(_label, _font_key)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_font_key	FontKey	字体key

Role.set_label_font_size

描述: 设置UI文本节点的字体大小

Role.set_label_font_size(_label, _font_size, _transition_time)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_font_size	Int	字号
_transition_time	Fixed	变化时间

Role.set_label_outline_color

描述: 设置UI文本节点的描边颜色

Role.set_label_outline_color(_label, _color)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_color	Color	描边颜色

Role.set_label_outline_enabled

描述: 设置UI文本节点的描边是否开启

Role.set_label_outline_enabled(_label, _enable)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_enable	Bool	是否开启描边

Role.set_label_outline_opacity

描述: 设置UI文本节点的描边不透明度

Role.set_label_outline_opacity(_label, _opacity)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_opacity	Fixed	描边不透明度

Role.set_label_outline_width

描述: 设置UI文本节点的描边大小

Role.set_label_outline_width(_label, _width)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_width	Fixed	描边大小

Role.set_label_shadow_color

描述: 设置UI文本节点的阴影颜色

Role.set_label_shadow_color(_label, _color)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_color	Color	阴影颜色

Role.set_label_shadow_enabled

描述: 设置UI文本节点的阴影是否开启

Role.set_label_shadow_enabled(_label, _enable)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_enable	Bool	是否开启阴影

Role.set_label_shadow_x_offset

描述: 设置UI文本节点的阴影x偏移

Role.set_label_shadow_x_offset(_label, _offset)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_offset	Fixed	x方向偏移

Role.set_label_shadow_y_offset

描述: 设置UI文本节点的阴影y偏移

Role.set_label_shadow_y_offset(_label, _offset)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_offset	Fixed	y方向偏移

Role.set_label_text

描述: 设置UI文本节点的文本

Role.set_label_text(_label, _text)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点
_text	Str	文本

Role.set_camera_rotation_sync_enabled

描述: 设置是否开启玩家相机旋转同步

Role.set_camera_rotation_sync_enabled(_enabled)

参数列表:

参数	类型	说明
_enabled	Bool	是否同步

Role.set_gyroscope_sync_enabled

描述: 设置监听陀螺仪信息

Role.set_gyroscope_sync_enabled(_enabled)

参数列表:

参数	类型	说明
_enabled	Bool	是否监听

Role.set_name_visible

描述: 设置玩家昵称可见性

Role.set_name_visible(_visible)

参数列表:

参数	类型	说明
_visible	Bool	是否可见

Role.set_node_touch_enabled

描述: 设置UI节点交互开关

Role.set_node_touch_enabled(_node, _touch_enabled)

参数列表:

参数	类型	说明
_node	ENode	UI节点
_touch_enabled	Bool	交互开关

Role.set_node_visible

描述: 设置UI节点可见性

Role.set_node_visible(_node, _visible)

参数列表:

参数	类型	说明
_node	ENode	UI节点
_visible	Bool	可见性

Role.set_progressbar_current

描述: 设置UI进度条节点进度

Role.set_progressbar_current(_progress_bar, _current)

参数列表:

参数	类型	说明
_progress_bar	EProgressbar	UI进度条节点
_current	Int	进度

Role.set_progressbar_max

描述: 设置UI进度条节点最大进度

Role.set_progressbar_max(_progress_bar, _max)

参数列表:

参数	类型	说明
_progress_bar	EProgressbar	UI进度条节点
_max	Int	最大进度

Role.set_progressbar_min

描述: 设置UI进度条节点最小进度

Role.set_progressbar_min(_progress_bar, _min)

参数列表:

参数	类型	说明
_progress_bar	EProgressbar	UI进度条节点
_min	Int	最小进度

Role.set_progressbar_transition

描述: 设置UI进度条节点过渡

Role.set_progressbar_transition(_progress_bar, _current, _transition_time)

参数列表:

参数	类型	说明
_progress_bar	EProgressbar	UI进度条节点
_current	Int	进度
_transition_time	Fixed	过渡时间

Role.set_score

描述: 设置玩家积分

Role.set_score(_score)

参数列表:

参数	类型	说明
_score	Int	积分

Role.set_goods_panel_visible

描述: 设置付费道具商店可见性

Role.set_goods_panel_visible(_visible)

参数列表:

参数	类型	说明
_visible	Bool	可见性

Role.set_ui_opacity

描述: 设置UI节点不透明度

Role.set_ui_opacity(_node, _opacity)

参数列表:

参数	类型	说明
_node	ENode	UI节点
_opacity	Fixed	不透明度

Role.disable_unit_fresnel

描述: 关闭单位菲尼尔效果

Role.disable_unit_fresnel(_unit)

参数列表:

参数	类型	说明
_unit	Unit	单位

Role.disable_unit_mask

描述: 关闭单位蒙版

Role.disable_unit_mask(_unit)

参数列表:

参数	类型	说明
_unit	Unit	单位

Role.disable_unit_outline

描述: 关闭单位描边

Role.disable_unit_outline(_unit)

参数列表:

参数	类型	说明
_unit	Unit	单位

Role.set_unit_fresnel_gradual

描述: 设置单位菲尼尔效果

Role.set_unit_fresnel_gradual(_unit, _fresnel_scale, _color, _intensity, _duration)

参数列表:

参数	类型	说明
_unit	Unit	单位
_fresnel_scale	Fixed	菲尼尔系数
_color	Color	颜色
_intensity	Int	强度
_duration	Fixed	用时

Role.set_unit_visible

描述: 设置单位对玩家可见性

Role.set_unit_visible(_unit, _is_visible)

参数列表:

参数	类型	说明
_unit	Unit	单位
_is_visible	Bool	是否显示

Role.set_voice_volume_sync_enabled

描述: 设置是否开启语音音量同步

Role.set_voice_volume_sync_enabled(_enabled)

参数列表:

参数	类型	说明
_enabled	Bool	是否同步

Role.shake_camera

描述: 设置玩家屏幕震动

Role.shake_camera(_shake_type, _shake_max_amplitude, _shake_time, _shake_source, _shake_frequency, _shake_time_decay, _shake_effect_scope, _shake_undamped_scope, _shake_distance_decay)

参数列表:

参数	类型	说明
_shake_type	CameraShakeType	震动方向
_shake_max_amplitude	Fixed	震幅
_shake_time	Fixed	震动时间
_shake_source	Unit	震源
_shake_frequency	Fixed	频率
_shake_time_decay	Fixed	时间衰减
_shake_effect_scope	Fixed	生效范围
_shake_undamped_scope	Fixed	不衰减范围
_shake_distance_decay	Fixed	距离衰减

Role.show_bag_panel

描述: 设置玩家的背包界面显隐

Role.show_bag_panel(_visible)

参数列表:

参数	类型	说明
_visible	Bool	是否显示

Role.show_like_panel

描述: 显示点赞界面

Role.show_like_panel()

Role.show_ultimate_ability_panel

描述: 显示玩家决战技选择界面

Role.show_ultimate_ability_panel(_keep_time)

参数列表:

参数	类型	说明
_keep_time	Int	时间

Role.skip_current_montage

描述: 跳过剧情动画

Role.skip_current_montage(_has_black_screen)

参数列表:

参数	类型	说明
_has_black_screen	Bool	是否有跳过黑幕

Role.start_vibration

描述: 开始手机震动

Role.start_vibration(_vibrate_type, _vibrate_count, _vibrate_interval)

参数列表:

参数	类型	说明
_vibrate_type	Int	震动模式
_vibrate_count	Int	震动次数
_vibrate_interval	Fixed	震动间隔

Role.stop_2d_sound

描述: 对指定单位停止2D声音

Role.stop_2d_sound(_sound_instance_id)

参数列表:

参数	类型	说明
_sound_instance_id	SoundID	音效ID

Role.stop_ui_effect

描述: 停止界面动效

Role.stop_ui_effect(_effect_node)

参数列表:

参数	类型	说明
_effect_node	EEffectNode	UI动效

Role.stop_camera_motor

描述: 停止玩家相机运动

Role.stop_camera_motor()

Role.unbind_label_text

描述: UI文本节点解除属性

Role.unbind_label_text(_label)

参数列表:

参数	类型	说明
_label	ELabel	UI文本节点

Role.unbind_progressbar_current

描述: 为UI进度条节点当前进度解绑属性

Role.unbind_progressbar_current(_progress_bar)

参数列表:

参数	类型	说明
_progress_bar	EProgressbar	UI进度条节点

Role.unbind_progressbar_max

描述: UI进度条节点最大进度解绑属性

Role.unbind_progressbar_max(_progress_bar)

参数列表:

参数	类型	说明
_progress_bar	EProgressbar	UI进度条节点

Ability.set_left_charge_time

描述: 设置技能剩余充能

Ability.set_left_charge_time(_cd_time)

参数列表:

参数	类型	说明
_cd_time	Fixed	充能时间

Ability.set_left_cd_time

描述: 设置技能剩余冷却

Ability.set_left_cd_time(_cd_time)

参数列表:

参数	类型	说明
_cd_time	Fixed	冷却时间

Ability.set_max_release_num

描述: 设置技能最大使用次数

Ability.set_max_release_num(_release_num_max)

参数列表:

参数	类型	说明
_release_num_max	Int	最大使用次数

Ability.set_cur_release_num

描述: 设置技能当前使用次数

Ability.set_cur_release_num(_release_num)

参数列表:

参数	类型	说明
_release_num	Int	使用次数

Role.set_achievement_progress

描述: 设置成就进度

Role.set_achievement_progress(_event_id, _count)

参数列表:

参数	类型	说明
_event_id	Achievement	成就
_count	Int	成就进度

Character.set_aim_move_enabled

描述: 开关角色靶向移动

Character.set_aim_move_enabled(_enable)

参数列表:

参数	类型	说明
_enable	Bool	开关

Obstacle.set_billboard_text

描述: 设置公告板文本内容

Obstacle.set_billboard_text(_content)

参数列表:

参数	类型	说明
_content	Str	文本内容

Obstacle.set_billboard_text_color

描述: 设置公告板文本颜色

Obstacle.set_billboard_text_color(_color, _gradient_color_1, _gradient_color_2, _gradient_color_3, _gradient_color_4)

参数列表:

参数	类型	说明
_color	Color	文本颜色
_gradient_color_1	Color	渐变色1
_gradient_color_2	Color	渐变色2
_gradient_color_3	Color	渐变色3
_gradient_color_4	Color	渐变色4

Obstacle.set_billboard_font_size

描述: 设置公告板文本字体大小

Obstacle.set_billboard_font_size(_font_size)

参数列表:

参数	类型	说明
_font_size	Int	字体大小

Character.set_voice_enabled

描述: 设置角色配音是否生效

Character.set_voice_enabled(_enabled)

参数列表:

参数	类型	说明
_enabled	Bool	是否启用

LifeEntity.set_mass_bar_visible

描述: 设置质量条是否显示

LifeEntity.set_mass_bar_visible(_visible)

参数列表:

参数	类型	说明
_visible	Bool	是否显示

Equipment.set_auto_aim_enabled

描述: 设置枪械自动瞄准

Equipment.set_auto_aim_enabled(_is_auto_aim)

参数列表:

参数	类型	说明
_is_auto_aim	Bool	是否自动瞄准

Equipment.set_auto_fire_enabled

描述: 设置枪械自动开火

Equipment.set_auto_fire_enabled(_is_auto_fire)

参数列表:

参数	类型	说明
_is_auto_fire	Bool	是否自动开火

Equipment.set_current_stack_num

描述: 设置物品当前堆叠数

Equipment.set_current_stack_num(_num)

参数列表:

参数	类型	说明
_num	Int	堆叠数

Equipment.set_desc

描述: 设置物品的描述

Equipment.set_desc(_desc)

参数列表:

参数	类型	说明
_desc	Str	描述

Equipment.set_droppable

描述: 设置物品能否丢弃

Equipment.set_droppable(_droppable)

参数列表:

参数	类型	说明
_droppable	Bool	能否丢弃

Equipment.set_price

描述: 设置物品的抵押价格

Equipment.set_price(_res_type, _price)

参数列表:

参数	类型	说明
_res_type	Str	货币类型
_price	Int	卖价

Equipment.set_charge_cost_free

描述: 设置物品充能无消耗

Equipment.set_charge_cost_free(_is_free)

参数列表:

参数	类型	说明
_is_free	Bool	是否无消耗

Equipment.set_icon

描述: 设置物品的图标

Equipment.set_icon(_icon_key)

参数列表:

参数	类型	说明
_icon_key	ImageKey	图标

Equipment.set_max_stack_num

描述: 设置物品最大堆叠数

Equipment.set_max_stack_num(_num)

参数列表:

参数	类型	说明
_num	Int	堆叠数

Equipment.set_name

描述: 设置物品的名称

Equipment.set_name(_name)

参数列表:

参数	类型	说明
_name	Str	名称

Equipment.set_saleable

描述: 设置物品能否出售

Equipment.set_saleable(_saleable)

参数列表:

参数	类型	说明
_saleable	Bool	能否出售

Equipment.start_charge

描述: 使物品开始充能

Equipment.start_charge()

Equipment.set_usable

描述: 设置物品能否使用

Equipment.set_usable(_usable)

参数列表:

参数	类型	说明
_usable	Bool	能否使用

UnitInteractVolumeComp.set_interact_button_icon

描述: 设置单位互动按钮图标

UnitInteractVolumeComp.set_interact_button_icon(_interact_id, _icon)

参数列表:

参数	类型	说明
_interact_id	InteractBtnID	互动按钮ID
_icon	ImageKey	互动按钮图标

UnitInteractVolumeComp.set_interact_button_text

描述: 设置单位互动按钮文本

UnitInteractVolumeComp.set_interact_button_text(_interact_id, _text)

参数列表:

参数	类型	说明
_interact_id	InteractBtnID	互动按钮ID
_text	Str	互动按钮文本

UnitInteractVolumeComp.set_interact_enabled

描述: 设置单位互动是否启用

UnitInteractVolumeComp.set_interact_enabled(_enable)

参数列表:

参数	类型	说明
_enable	Bool	是否启用

UnitInteractVolumeComp.set_interact_enabled_by_index

描述: 设置单位互动是否启用(索引)

UnitInteractVolumeComp.set_interact_enabled_by_index(_interact_index, _enable)

参数列表:

参数	类型	说明
_interact_index	Int	互动索引
_enable	Bool	是否启用

JointAssistantComp.set_joint_assistant_enabled

描述: 设置关节组件的启用状态

JointAssistantComp.set_joint_assistant_enabled(_enable)

参数列表:

参数	类型	说明
_enable	Bool	开关

JointAssistantComp.set_joint_assistant_visible

描述: 设置关节组件可见性

JointAssistantComp.set_joint_assistant_visible(_visible)

参数列表:

参数	类型	说明
_visible	Bool	可见性

LifeEntity.set_hpbar_scale

描述: 设置生命体血条缩放

LifeEntity.set_hpbar_scale(_hpbar_scale_x, _hpbar_scale_y)

参数列表:

参数	类型	说明
_hpbar_scale_x	Fixed	宽度缩放
_hpbar_scale_y	Fixed	高度缩放

LiftComp.set_lift_cooldown

描述: 设置举起冷却时间

LiftComp.set_lift_cooldown(_cd_time)

参数列表:

参数	类型	说明
_cd_time	Fixed	时间

LiftComp.set_lift_remaining_cooldown

描述: 设置举起剩余冷却时间

LiftComp.set_lift_remaining_cooldown(_time)

参数列表:

参数	类型	说明
_time	Fixed	时间

Obstacle.set_ranklist_score

描述: 设置场景排行榜分数

Obstacle.set_ranklist_score(_role, _score)

参数列表:

参数	类型	说明
_role	Role	玩家
_score	Int	分数

Unit.set_model_visible

描述: 设置单位模型是否可见

Unit.set_model_visible(_v)

参数列表:

参数	类型	说明
_v	Bool	是否可见

Unit.set_physics_active

描述: 设置单位物理是否生效

Unit.set_physics_active(_is_active)

参数列表:

参数	类型	说明
_is_active	Bool	是否生效

Modifier.set_remain_duration

描述: 设置效果剩余时间

Modifier.set_remain_duration(_remain_duration)

参数列表:

参数	类型	说明
_remain_duration	Fixed	剩余持续时间

Role.set_role_ctrl_enabled

描述: 设置玩家控制开启/关闭

Role.set_role_ctrl_enabled(_enable)

参数列表:

参数	类型	说明
_enable	Bool	开启/关闭

RollComp.set_roll_remaining_cooldown

描述: 设置滚动剩余冷却时间

RollComp.set_roll_remaining_cooldown(_remaining_time)

参数列表:

参数	类型	说明
_remaining_time	Fixed	剩余冷却时间

RushComp.set_rush_remaining_cooldown

描述: 设置飞扑剩余冷却时间

RushComp.set_rush_remaining_cooldown(_time)

参数列表:

参数	类型	说明
_time	Fixed	时间

LifeEntity.set_search_enemy_focus_target

描述: 设置搜敌集火目标

LifeEntity.set_search_enemy_focus_target(_target)

参数列表:

参数	类型	说明
_target	LifeEntity	目标

EquipmentComp.select_equipment_slot

描述: 设置单位选中物品格

EquipmentComp.select_equipment_slot(_slot_type, _slot_index)

参数列表:

参数	类型	说明
_slot_type	EquipmentSlotType	槽位类型
_slot_index	Int	槽位索引

Modifier.set_stack_count

描述: 设置效果层数

Modifier.set_stack_count(_stack_count_add)

参数列表:

参数	类型	说明
_stack_count_add	Int	层数

KVBase.add_tag

描述: 添加标签

KVBase.add_tag(_tag)

参数列表:

参数	类型	说明
_tag	Str	标签

Role.set_unit_fresnel

描述: 设置单位菲尼尔效果

Role.set_unit_fresnel(_unit, _fresnel_scale, _color, _intensity)

参数列表:

参数	类型	说明
_unit	Unit	单位
_fresnel_scale	Fixed	菲尼尔系数
_color	Color	颜色
_intensity	Int	强度

Role.set_unit_mask

描述: 设置单位蒙版

Role.set_unit_mask(_unit, _color)

参数列表:

参数	类型	说明
_unit	Unit	单位
_color	Color	颜色

Unit.set_mirror_reflect_enabled

描述: 开关镜面反射

Unit.set_mirror_reflect_enabled(_enable)

参数列表:

参数	类型	说明
_enable	Bool	是否启用

Unit.set_orientation

描述: 设置单位旋转

Unit.set_orientation(_rot)

参数列表:

参数	类型	说明
_rot	Quaternion	旋转

Role.set_unit_outline

描述: 设置单位描边

Role.set_unit_outline(_unit, _width, _color)

参数列表:

参数	类型	说明
_unit	Unit	单位
_width	Int	粗细
_color	Color	颜色

Unit.set_position

描述: 重置单位坐标

Unit.set_position(_pos)

参数列表:

参数	类型	说明
_pos	Vector3	坐标

Role.set_unit_see_through_enabled

描述: 设置单位穿透显示

Role.set_unit_see_through_enabled(_unit, _enabled)

参数列表:

参数	类型	说明
_unit	Unit	单位
_enabled	Bool	是否穿透显示

TriggerSpace.set_virtual_light_brightness

描述: 设置光源亮度

TriggerSpace.set_virtual_light_brightness(_brightness)

参数列表:

参数	类型	说明
_brightness	Fixed	亮度

Role.show_goods_purchase_panel

描述: 玩家显示指定商品购买界面

Role.show_goods_purchase_panel(_raw_goods_id, _show_time)

参数列表:

参数	类型	说明
_raw_goods_id	UgcGoods	商品
_show_time	Fixed	显示时间

LifeEntity.start_ai

描述: 激活AI

LifeEntity.start_ai()

LifeEntity.stop_ai

描述: 暂停AI

LifeEntity.stop_ai()

Unit.stop_sound

描述: 单位停止播放声音

Unit.stop_sound(_lres_id)

参数列表:

参数	类型	说明
_lres_id	SoundID	音效ID

DisplayComp.bind_model

描述: 添加绑定模型

DisplayComp.bind_model(_model_id, _socket, _offset, _rot, _scale)

参数列表:

参数	类型	说明
_model_id	UnitKey	单位编号
_socket	ModelSocket	挂点
_offset	Point3	偏移
_rot	Quaternion	旋转
_scale	Vector3	缩放

返回类型 Str 绑定ID

Unit.disable_gravity

描述: 关闭重力影响

Unit.disable_gravity()

Unit.enable_gravity

描述: 开启重力影响

Unit.enable_gravity()

LiftedComp.is_lifted_enabled

描述: 获取是否可抓举

LiftedComp.is_lifted_enabled()

返回类型 Bool 是否可抓举

LiftedComp.set_custom_thrown_force

描述: 设置自定义投掷力量

LiftedComp.set_custom_thrown_force(_force)

参数列表:

参数	类型	说明
_force	Fixed	力量

LiftedComp.set_custom_thrown_force_enabled

描述: 设置是否自定义投掷力量

LiftedComp.set_custom_thrown_force_enabled(_enable)

参数列表:

参数	类型	说明
_enable	Bool	是否自定义

LiftedComp.set_lifted_enabled

描述: 设置是否可抓举

LiftedComp.set_lifted_enabled(_enable)

参数列表:

参数	类型	说明
_enable	Bool	是否可被抓举

Unit.set_linear_velocity

描述: 改变单位线速度

Unit.set_linear_velocity(_vel)

参数列表:

参数	类型	说明
_vel	Vector3	线速度

VehicleComp.reset

描述: 载具复位

VehicleComp.reset()

VehicleComp.start_move_by_direction

描述: 使载具往某个方向移动一段时间

VehicleComp.start_move_by_direction(_direction, _duration)

参数列表:

参数	类型	说明
_direction	Vector3	方向
_duration	Fixed	持续时间

VehicleComp.stop_move

描述: 使载具停止移动

参数	类型	说明
_ability_key	AbilityKey	技能编号
_duration	Fixed	时间
_target	LifeEntity	目标
_ability_slot	AbilitySlot	技能槽位

AbilityComp.get_prop_ability

描述: 获取道具技能

AbilityComp.get_prop_ability()

返回类型 Ability 技能对象

AbilityComp.remove_prop_ability

描述: 移除道具技能

AbilityComp.remove_prop_ability()

返回类型 Bool 是否成功移除

AbilityComp.set_ability_enabled_on_vehicle

描述: 设置是否能在载具上使用用技能

AbilityComp.set_ability_enabled_on_vehicle(_enable)

参数列表:

参数	类型	说明
_enable	Bool	是否能用技能

AttrComp.get_attr_by_type

描述: 获取属性

AttrComp.get_attr_by_type(_value_type, _key)

参数列表:

参数	类型	说明
_value_type	ValueType	值类型
_key	Str	属性名

返回类型 ETypeMeta 属性值

AttrComp.set_attr_bonus_fixed

描述: 设置属性的额外固定值(复杂模式)

AttrComp.set_attr_bonus_fixed(_key, _value)

参数列表:

参数	类型	说明
_key	Str	属性名
_value	Fixed	额外固定值

AttrComp.set_attr_by_type

描述: 设置属性

AttrComp.set_attr_by_type(_value_type, _key, _val)

参数列表:

参数	类型	说明
_value_type	ValueType	值类型
_key	Str	属性名
_val	ETypeMeta	属性值

AttrComp.set_attr_ratio_fixed

描述: 设置属性的倍率值(复杂模式)

AttrComp.set_attr_ratio_fixed(_key, _value)

参数列表:

参数	类型	说明
_key	Str	属性名
_value	Fixed	倍率值

AttrComp.set_attr_raw_fixed

描述: 设置属性的基础值(复杂模式)

AttrComp.set_attr_raw_fixed(_key, _value)

参数列表:

参数	类型	说明
_key	Str	属性名
_value	Fixed	基础值

Camp.change_camp_score

描述: 改变阵营积分

Camp.change_camp_score(_add_score)

参数列表:

参数	类型	说明
_add_score	Int	变化积分

Creature.force_start_move

描述: 命令生物移动

Creature.force_start_move(_direction, _t)

参数列表:

参数	类型	说明
_direction	Vector3	方向
_t	Fixed	时间

Creature.force_stop_move

描述: 命令生物停止移动

Creature.force_stop_move()

Creature.reset_target_socket_model

描述: 还原生物指定外观部位变化

Creature.reset_target_socket_model(_model_socket)

参数列表:

参数	类型	说明
_model_socket	ModelSocket	外观部位

EditorAPI.delete_unit_prefab

描述: 删除组件预设

EditorAPI.delete_unit_prefab(_unit_eid)

参数列表:

参数	类型	说明
_unit_eid	UnitKey	单位编号

EditorAPI.get_unit_key_by_unit_id

描述: 获取单位编号

EditorAPI.get_unit_key_by_unit_id(_unit_id)

参数列表:

参数	类型	说明
_unit_id	UnitID	单位ID

返回类型 UnitKey 单位编号

EditorAPI.get_units_by_unit_key

描述: 获取指定单位编号对应的所有单位

EditorAPI.get_units_by_unit_key(_unit_eid)

参数列表:

参数	类型	说明
_unit_eid	UnitKey	单位编号

返回类型 List 单位列表

EditorAPI.set_unit_attr

描述: 设置单位属性

EditorAPI.set_unit_attr(_unit_id, _attr_key, _attr_value)

参数列表:

参数	类型	说明
_unit_id	UnitID	单位ID
_attr_key	Str	属性名
_attr_value	ETypeMeta	属性值

EditorAPI.set_unit_prefab_property

描述: 设置预设属性

EditorAPI.set_unit_prefab_property(_unit_eid, _attr_key, _attr_value)

参数列表:

参数	类型	说明
_unit_eid	UnitKey	单位编号
_attr_key	Str	属性名
_attr_value	ETypeMeta	属性值

EditorAPI.set_units_attr

描述: 批量设置单位属性

EditorAPI.set_units_attr(_unit_ids, _attr_key, _attr_values)

参数列表:

参数	类型	说明
_unit_ids	ListUnitID	单位ID列表
_attr_key	Str	属性名
_attr_values	List	属性值列表

Equipment.drop

描述: 物品被丢弃

Equipment.drop()

Equipment.get_unit

描述: 获取物品单位

Equipment.get_unit()

参数	类型	说明
_key	EquipmentKey	物品编号

JumpComp.get_multi_jump_remaining_cooldown

描述: 获取多段跳剩余冷却

JumpComp.get_multi_jump_remaining_cooldown()

返回类型 Fixed 冷却时间

JumpComp.set_multi_jump_remaining_cooldown

描述: 设置多段跳剩余冷却

JumpComp.set_multi_jump_remaining_cooldown(_cd)

参数列表:

参数	类型	说明
_cd	Fixed	冷却时间

KVBase.get_kv_by_type

描述: 获取自定义值

KVBase.get_kv_by_type(_value_type, _key)

参数列表:

参数	类型	说明
_value_type	ValueType	值类型
_key	Str	名称

返回类型 ETypeMeta 自定义值

KVBase.set_kv_by_type

描述: 设置自定义值

KVBase.set_kv_by_type(_value_type, _key, _val)

参数列表:

参数	类型	说明
_value_type	ValueType	值类型
_key	Str	名称
_val	ETypeMeta	自定义值

LifeComp.change_hp

描述: 改变健康值

LifeComp.change_hp(_value)

参数列表:

参数	类型	说明
_value	Fixed	改变健康值

LifeComp.get_hp

描述: 获取健康值

LifeComp.get_hp()

返回类型 Fixed 健康值

LifeComp.get_hp_max

描述: 获取最大健康值

LifeComp.get_hp_max()

返回类型 Fixed 最大健康值

LifeComp.get_life

描述: 获取当前命数

LifeComp.get_life()

返回类型 Int 当前命数

LifeComp.get_life_max

描述: 获取最大命数

LifeComp.get_life_max()

返回类型 Int 当前命数

LifeComp.set_hp_max

描述: 设置最大健康值

LifeComp.set_hp_max(_value)

参数列表:

参数	类型	说明
_value	Fixed	最大健康值

LifeComp.set_life_count

描述: 改变当前命数

LifeComp.set_life_count(_value)

参数列表:

参数	类型	说明
_value	Int	当前命数

LifeComp.set_life_max

描述: 改变最大命数

LifeComp.set_life_max(_value)

参数列表:

参数	类型	说明
_value	Int	最大命数

LifeComp.set_reborn_in_place

描述: 设置是否原地复活

LifeComp.set_reborn_in_place(_reborn_in_place, _reset_camera)

参数列表:

参数	类型	说明
_reborn_in_place	Bool	是否原地复活
_reset_camera	Bool	是否重置相机

LifeEntity.ai_command_chase_with_ability

描述: 控制AI执行追击行为(技能)

LifeEntity.ai_command_chase_with_ability(_target, _chase_range, _reject_time, _action_distance, _ability_key, _move_mode, _action_count)

参数列表:

参数	类型	说明
_target	LifeEntity	目标
_chase_range	Fixed	追击范围
_reject_time	Fixed	厌恶时间
_action_distance	Fixed	反应距离
_ability_key	AbilityKey	反应行为
_move_mode	MoveMode	移动方式
_action_count	Int	追击次数

LifeEntity.ai_command_chase_with_action

描述: 控制AI执行追击行为(命令)

LifeEntity.ai_command_chase_with_action(_target, _chase_range, _reject_time, _action_distance, _action_mode, _move_mode, _action_count)

参数列表:

参数	类型	说明
_target	LifeEntity	目标
_chase_range	Fixed	追击范围
_reject_time	Fixed	厌恶时间
_action_distance	Fixed	反应距离
_action_mode	AIBasicCommand	反应行为
_move_mode	MoveMode	移动方式
_action_count	Int	追击次数

LifeEntity.ai_command_chase_with_equipment

描述: 控制AI执行追击行为(物品)

LifeEntity.ai_command_chase_with_equipment(_target, _chase_range, _reject_time, _action_distance, _equipment_key, _move_mode, _action_count)

参数列表:

参数	类型	说明
_target	LifeEntity	目标
_chase_range	Fixed	追击范围
_reject_time	Fixed	厌恶时间
_action_distance	Fixed	反应距离
_equipment_key	EquipmentKey	反应行为
_move_mode	MoveMode	移动方式
_action_count	Int	追击次数

LifeEntity.ai_command_start_move_high_priority

描述: 控制AI执行高优先级寻路命令

LifeEntity.ai_command_start_move_high_priority(_target_position, _duration, _threshold)

参数列表:

参数	类型	说明
_target_position	ListVector3	坐标
_duration	Fixed	持续时间
_threshold	Fixed	距离阈值

LifeEntity.jump

描述: 命令角色跳跃

LifeEntity.jump()

LifeEntity.set_model_by_creature_key

描述: 根据生物预设设置模型

LifeEntity.set_model_by_creature_key(_creature_key, _include_custom_model, _inherit_scale, _inherit_capsule_size)

参数列表:

参数	类型	说明
_creature_key	CreatureKey	生物编号
_include_custom_model	Bool	是否包含自定义形象
_inherit_scale	Bool	是否继承缩放
_inherit_capsule_size	Bool	是否继承胶囊体

LifeEntity.set_search_enemy_priority_value_by_tag

描述: 设置搜敌优先级值by标签

LifeEntity.set_search_enemy_priority_value_by_tag(_tag, _priority)

参数列表:

参数	类型	说明
_tag	Str	标签
_priority	Int	优先级

LifeEntity.set_search_enemy_priority_value_by_unit

描述: 设置搜敌优先级值by单位实体

LifeEntity.set_search_enemy_priority_value_by_unit(_unit, _priority)

参数列表:

参数	类型	说明
_unit	LifeEntity	单位实体
_priority	Int	优先级

LifeEntity.set_search_enemy_priority_value_by_unit_key

描述: 设置搜敌优先级值by预设编号

LifeEntity.set_search_enemy_priority_value_by_unit_key(_unit_key, _priority)

参数列表:

参数	类型	说明
_unit_key	CreatureKey	预设编号
_priority	Int	优先级

LifeEntity.set_search_enemy_priority_value_by_unit_type

描述: 设置搜敌优先级值by单位类型

LifeEntity.set_search_enemy_priority_value_by_unit_type(_unit_prefab_type, _priority)

参数列表:

参数	类型	说明
_unit_prefab_type	UnitType	单位类型
_priority	Int	优先级

Modifier.get_releaser_unit

描述: 获取效果释放者

Modifier.get_releaser_unit()

返回类型 Unit 效果释放者

ModifierComp.add_modifier

描述: 添加效果

ModifierComp.add_modifier(_modifier_id)

参数列表:

参数	类型	说明
_modifier_id	ModifierKey	效果编号

返回类型 Modifier 是否添加成功

Obstacle.get_bound_equipment

描述: 返回绑定的物品

Obstacle.get_bound_equipment()

返回类型 Equipment 物品

Role.game_lose_and_show_result_panel

描述: 玩家游戏失败并显示失败界面

Role.game_lose_and_show_result_panel()

Role.game_win_and_show_result_panel

描述: 玩家游戏胜利并显示胜利界面

Role.game_win_and_show_result_panel()

Role.get_archive_by_type

描述: 获取存档值

Role.get_archive_by_type(_archive_type, _key)

参数列表:

参数	类型	说明
_archive_type	ArchiveType	存档类型
_key	Archive	存档

返回类型 ETypeMeta 存档值

Role.get_game_result

描述: 获取玩家游戏结果

Role.get_game_result()

返回类型 GameResult 游戏结局

Role.get_roleid

描述: 获取玩家ID

Role.get_roleid()

返回类型 RoleID 玩家ID

Role.lose

描述: 玩家游戏失败

Role.lose()

Role.send_ui_custom_event

描述: 发送UI自定义消息

Role.send_ui_custom_event(_event_name, _data)

参数列表:

参数	类型	说明
_event_name	Str	自定义事件名
_data	Dict	附带参数

Role.set_archive_by_type

描述: 设置存档值

Role.set_archive_by_type(_archive_type, _key, _val)

参数列表:

参数	类型	说明
_archive_type	ArchiveType	存档类型
_key	Archive	存档
_val	ETypeMeta	存档值

Role.set_camera_bind_mode

描述: 设置玩家相机的模式

Role.set_camera_bind_mode(_mode)

参数列表:

参数	类型	说明
_mode	CameraBindMode	模式

Role.set_camera_draggable

描述: 设置玩家相机是否可拖动

Role.set_camera_draggable(_draggable)

参数列表:

参数	类型	说明
_draggable	Bool	可拖动

Role.set_camera_gyroscope_control_enabled

描述: 设置玩家陀螺仪控制镜头

Role.set_camera_gyroscope_control_enabled(_is_control)

参数列表:

参数	类型	说明
_is_control	Bool	陀螺仪控制

Role.set_camera_lock_position

描述: 设置玩家相机的绑定坐标

Role.set_camera_lock_position(_pos)

参数列表:

参数	类型	说明
_pos	Point3	点

Role.set_camera_projection_type

描述: 设置玩家相机的投影类型

Role.set_camera_projection_type(_projection_type)

参数列表:

参数	类型	说明
_projection_type	CameraProjectionType	投影类型

Role.set_camera_property

描述: 设置玩家相机的属性

Role.set_camera_property(_property, _value)

参数列表:

参数	类型	说明
_property	CameraPropertyType	属性
_value	Fixed	值

Role.set_camera_rotation_by_direction

描述: 设置玩家相机面向指定朝向

Role.set_camera_rotation_by_direction(_target_dir, _duration)

参数列表:

参数	类型	说明
_target_dir	Vector3	目标方向
_duration	Fixed	用时

Role.set_image_texture_with_auto_resize

描述: 设置UI图片节点图片

Role.set_image_texture_with_auto_resize(_image, _image_path, _reset_size)

参数列表:

参数	类型	说明
_image	EImage	UI图片节点
_image_path	Str	图片
_reset_size	Bool	是否重置大小

Role.show_tips

描述: 玩家显示飘字信息

Role.show_tips(_content, _duration)

参数列表:

参数	类型	说明
_content	Str	字符串
_duration	Fixed	时长

Role.win

描述: 玩家胜利

Role.win()

RollComp.get_roll_cooldown

描述: 获取滚动冷却时间

RollComp.get_roll_cooldown()

返回类型 Fixed 冷却时间

RollComp.set_roll_cooldown

描述: 设置滚动冷却时间

RollComp.set_roll_cooldown(_time)

参数列表:

参数	类型	说明
_time	Fixed	时间

RushComp.get_rush_cooldown

描述: 获取飞扑冷却时间

RushComp.get_rush_cooldown()

返回类型 Fixed 冷却时间

RushComp.set_rush_cooldown

描述: 设置飞扑冷却时间

RushComp.set_rush_cooldown(_time)

参数列表:

参数	类型	说明
_time	Fixed	时间

TriggerSystem.has_timer

描述: 判断计时器是否存在

TriggerSystem.has_timer(_timer)

参数列表:

参数	类型	说明
_timer	Timer	计时器

返回类型 Bool 是否存在

Unit.get_camp

描述: 获取单位所属阵营

Unit.get_camp()

返回类型 Camp 阵营

Unit.get_camp_id

描述: 获取单位所属阵营id

Unit.get_camp_id()

返回类型 CampID 阵营ID

Unit.get_child_by_name

描述: 根据单位编号获取子组件

Unit.get_child_by_name(_name)

参数列表:

参数	类型	说明
_name	Str	子单位名称

返回类型 Unit 单位

Unit.get_role

描述: 获取单位所属玩家

Unit.get_role()

返回类型 Role 所属玩家

Unit.get_role_id

描述: 获取单位所属玩家ID

Unit.get_role_id()

返回类型 RoleID 玩家ID

Unit.is_creature

描述: 是否为生物

Unit.is_creature()

返回类型 Bool 单位

Unit.is_dynamic_body

描述: 是受力物体

Unit.is_dynamic_body()

返回类型 Bool 受力物体

Unit.is_kinematic_body

描述: 是动力学物体

Unit.is_kinematic_body()

返回类型 Bool 动力学物体

Unit.is_static_body

描述: 是静态物体

Unit.is_static_body()

返回类型 Bool 静态物体

Unit.play_3d_sound

描述: 单位开始播放3d音效

Unit.play_3d_sound(_sound_key, _duration, _volume)

参数列表:

参数	类型	说明
_sound_key	SoundKey	声音编号
_duration	Fixed	持续时间
_volume	Fixed	音量

参数	类型	说明
_interact_index	Int	互动索引
_text	Str	互动按钮文本

任意组件创建

事件主体 Global 全局触发器

事件携带参数 unit Obstacle 被创建的组件

ANY_OBSTACLE_DESTROY

任意组件销毁

事件主体 Global 全局触发器

事件携带参数 unit Obstacle 被销毁的组件

ANY_OBSTACLE_LIFTED_BEGAN

任意组件被举起

事件主体 Global 全局触发器

事件携带参数 lift_unit Unit 抓举者事件携带参数 lifted_unit Obstacle 被抓举者

ANY_OBSTACLE_LIFTED_ENDED

任意组件被放下

事件主体 Global 全局触发器

事件携带参数 lift_unit Unit 抓举者事件携带参数 lifted_unit Obstacle 被抓举者

ANY_OBSTACLE_TRIGGER_SPACE

任意组件进出触发区域

游戏结束

事件主体 Global 全局触发器

天空环境变化

事件主体 Global 全局触发器

SPEC_CHARACTER_SELECT_EQUIPMENT_SLOT

指定角色选中物品格

事件主体 Character 角色

注册参数 event_unit Character 触发角色注册参数 slot_type EquipmentSlotType 物品格类型注册参数 slot_index Int EQUIPMENT_SLOT_INDEX

事件携带参数 event_unit Character 触发角色

SPEC_COMMODITY_BRING_INTO_GAME

指定UGC物品被带入游戏

事件主体 Default 多类型

注册参数 commodity_id UgcCommodity SPEC_UGC_COMMODITY

事件携带参数 camp_role_owner Role 携带道具的玩家

SPEC_COMMODITY_PURCHASE

指定UGC物品购买事件

事件主体 Default 多类型

注册参数 commodity_id UgcCommodity SPEC_UGC_COMMODITY

事件携带参数 commodity_id UgcCommodity SPEC_UGC_COMMODITY 事件携带参数 purchase_role Role 购买道具的玩家

SPEC_LIFEENTITY_INTERACTED

指定生物互动按钮被按下

事件主体 Creature 生物

事件携带参数 interact_lifeentity LifeEntity 互动触发者事件携带参数 interact_unit Creature 互动目标事件携带参数 interact_id InteractBtnID 互动按钮

SPEC_CUSTOMTRIGGERSPACE_DESTROY

指定触发区域销毁

事件主体 CustomTriggerSpace 触发区域

SPEC_EQUIPMENT_CHANGE_SLOT

指定物品位置发生变化

事件主体 Equipment 物品

事件携带参数 equipment Equipment 当前物品事件携带参数 owner LifeEntity 持有者事件携带参数 old_slot_type EquipmentSlotType 旧槽位类型事件携带参数 old_index Int 旧槽位索引事件携带参数 new_slot_type EquipmentSlotType 新槽位类型事件携带参数 new_index Int 新槽位索引

SPEC_EQUIPMENT_DESTROY

指定物品销毁事件

事件主体 Equipment 物品

事件携带参数 equipment Equipment 当前物品

SPEC_EQUIPMENT_ENTER_CHAR_SLOT

指定物品进入角色栏位

事件主体 Equipment 物品

注册参数 equipment Equipment 当前物品注册参数 slot_type EquipmentSlotType 物品格类型

事件携带参数 equipment Equipment 当前物品事件携带参数 slot_type EquipmentSlotType 物品格类型事件携带参数 owner Character 触发事件的角色

SPEC_EQUIPMENT_LEAVE_CHAR_SLOT

指定生命体击败其他生命体

事件主体 LifeEntity 生命体

事件携带参数 dmg_unit LifeEntity 伤害来源事件携带参数 die_unit LifeEntity 被击败者

指定组件发生碰撞结束

事件主体 Obstacle 组件

事件携带参数 unit1 Obstacle 碰撞者事件携带参数 unit2 Unit 被碰撞者

事件主体 Default 多类型

注册参数 role Role 目标玩家

事件携带参数 voice_volume Fixed ECA_PARA_VOICE_VOLUME

SPEC_TRIGGERSPACE_DESTROY

指定逻辑体销毁

事件主体 TriggerSpace 逻辑体

SPEC_COMMODITY_CONSUME

指定UGC物品消费事件

事件主体 Default 多类型

注册参数 commodity_id UgcCommodity SPEC_UGC_COMMODITY

事件携带参数 commodity_id UgcCommodity SPEC_UGC_COMMODITY 事件携带参数 consume_num Int 使用道具的数量事件携带参数 consume_role Role 使用道具的玩家

追踪弹道到达目标点

事件主体 Default 多类型

注册参数 tag Str TAG

事件携带参数 target_point Vector3 到达目标事件携带参数 from_unit Unit 子弹来源

API手册 ​

CLASS ​

AIBasicCommand ​

Ability ​

AbilityKey ​

AbilitySlot ​

Achievement ​

AnimKey ​

Archive ​

ArchiveType ​

BattleShopKey ​

BindType ​

Bool ​

BuffState ​

CameraBindMode ​

CameraProjectionType ​

CameraPropertyType ​

CameraShakeType ​

Camp ​

CampID ​

Character ​

CharacterKey ​

Color ​

Creature ​

CreatureKey ​

CustomTriggerSpace ​

CustomTriggerSpaceKey ​

DamageSchema ​

DecorationKey ​

Dict ​

DirectionType ​

E3DLayer ​

E3DLayerKey ​

EBagSlot ​

EButton ​

EEffectNode ​

EImage ​

EInputField ​

ELabel ​

ENode ​

EProgressbar ​

ETypeMeta ​

EmojiKey ​

Equipment ​

EquipmentKey ​

EquipmentSlot ​

EquipmentSlotType ​

Fixed ​

FontKey ​

Function ​

ImageKey ​

Int ​

InteractBtnID ​

InteractBtnType ​

JointAssistantKey ​

LevelKey ​

LifeEntity ​

List ​

ListAIBasicCommand ​

ListStr ​

ListUnitID ​

ListUnitType ​

ListVector3 ​

ModelSocket ​

Modifier ​

ModifierKey ​

MontageKey ​

MoveMode ​

ObstacleKey ​

PaintArea ​

PathID ​

PathPointID ​

PatrolType ​

Point3 ​

Quaternion ​

Role ​

RoleID ​

SfxID ​

SfxKey ​

SkyBoxBackground ​

API手册

CLASS

AIBasicCommand

Ability

AbilityKey

AbilitySlot

Achievement

AnimKey

Archive

ArchiveType

BattleShopKey

BindType

Bool

BuffState

CameraBindMode

CameraProjectionType

CameraPropertyType

CameraShakeType

Camp

CampID

Character

CharacterKey

Color

Creature

CreatureKey

CustomTriggerSpace

CustomTriggerSpaceKey

DamageSchema

DecorationKey

Dict

DirectionType

E3DLayer

E3DLayerKey

EBagSlot

EButton

EEffectNode

EImage

EInputField

ELabel

ENode

EProgressbar

ETypeMeta

EmojiKey

Equipment

EquipmentKey

EquipmentSlot

EquipmentSlotType

Fixed

FontKey

Function

ImageKey

Int

InteractBtnID

InteractBtnType

JointAssistantKey

LevelKey

LifeEntity

List

ListAIBasicCommand

ListStr

ListUnitID

ListUnitType

ListVector3

ModelSocket

Modifier

ModifierKey

MontageKey

MoveMode

ObstacleKey

PaintArea

PathID

PathPointID

PatrolType

Point3

Quaternion

Role

RoleID

SfxID

SfxKey

SkyBoxBackground