Skip to content
On this page

Role

描述

玩家


方法列表

方法名简述
api_get_role_id玩家获取玩家ID
api_get_camp_id获取玩家所属阵营ID
get_role_id_num获取玩家ID数值
get_camp_id_num获取玩家所属阵营ID数值
get_role_name获取玩家名字
get_role__unique_name获取玩家唯一名字
get_role_plat_map_level获取玩家平台等级
get_role_type获取玩家控制者类型
is_middle_join玩家是否中途加入
api_get_camp获取玩家所属阵营对象
set_attr_val玩家设置属性
get_all_unit_id获取玩家所有单位对象
set_role_exp_rate设置玩家经验获得率
get_role_exp_rate获得玩家经验倍率
set_role_spawn_point设置玩家出生点
get_role_spawn_point获取玩家出生点
api_set_camp设置玩家队伍ID
set_role_name设置玩家名字
change_role_res修改玩家资源
set_role_res设置玩家资源
get_role_res获得玩家资源
set_group_navigate_mode设置玩家群体寻路严格模式
set_save_data_int_value设置整数型参数到玩家存档栏位
set_save_data_fixed_value设置实数型参数到玩家存档栏位
set_save_data_bool_value设置布尔型参数到玩家存档栏位
set_save_data_str_value设置字符串型参数到玩家存档栏位
set_save_data_table_value设置表型参数到玩家存档栏位
upload_save_data上传玩家存档数据
add_global_map_archive_data增加当前地图的指定key的存档值
get_player_rank_num获取玩家指定的全局存档key值对应排行榜的排名
get_player_archive_rank_num获取玩家指定的个人存档栏位对应排行榜的排名
download_save_data下载玩家存档数据
reset_download_save_data_callback重置下载档案数据回调
get_save_data_int_value读取整数型玩家存档数据
get_save_data_fixed_value读取实数型玩家存档数据
get_save_data_bool_value读取布尔型玩家存档数据
get_save_data_str_value读取字符串型玩家存档数据
get_save_data_table_value读取表型玩家存档数据
api_use_store_item玩家使用收费道具
get_store_item_cnt获取玩家收费道具数量
get_visibility_of_unit玩家是否拥有单位的可见性
api_change_tech_level修改玩家科技等级
api_set_tech_level修改玩家科技等级
api_get_tech_level获取玩家科技等级
is_point_visible_to_player点对于玩家是否可见
is_point_in_fog点是否在迷雾中
is_point_in_shadow点是否在黑色阴影中
get_role_status获取玩家状态
set_role_hostility设置玩家是否是敌对关系
players_is_alliance玩家是否是同盟关系
players_is_enemy玩家是否是敌对关系
share_source_player_vision_to_target原始玩家对目标玩家开放视野
close_source_player_vision_to_target原始玩家对目标玩家关闭视野
share_source_unit_vision_to_target原始单位对目标玩家开放视野
close_source_unit_vision_to_target原始单位对目标玩家关闭视野
role_select_unit选中单位或单位组
set_role_mouse_left_click开/关玩家鼠标的点选
set_role_mouse_move_select开/关玩家的鼠标的框选
set_role_mouse_wheel开/关玩家的鼠标滚轮
set_role_vignetting_enable设置玩家暗角开关
set_role_vignetting_size设置玩家暗角大小
set_role_vignetting_breath_rate设置玩家暗角呼吸周期
set_role_vignetting_change_range设置玩家暗角变化幅度
set_role_vignetting_color设置玩家暗角颜色
api_set_role_editable_game_func设置玩家的基础操作快捷键(过滤掉禁止修改的)
api_set_role_all_game_func_enable设置玩家的基础操作开关(包含所有基础操作)
api_is_conf_of_editable_game_func基础操作响应的快捷键是否已被占用(过滤掉禁止修改的)
api_get_editable_game_func_of_shortcut获取玩家响应键盘按键的基础操作(过滤掉禁止修改的)
set_bool_hit_point_data设置玩家布尔埋点数据
set_int_hit_point_data设置玩家整型埋点数据
api_set_follow_distance设置跟随距离

方法

api_get_role_id

描述

玩家获取玩家ID

参数

返回值

RoleID : 玩家ID

api_get_camp_id

描述

获取玩家所属阵营ID

参数

返回值

Int64 : 玩家所属阵营ID

get_role_id_num

描述

获取玩家ID数值

参数

返回值

UInt32 : 玩家ID数值

get_camp_id_num

描述

获取玩家所属阵营ID数值

参数

返回值

UInt32 : 玩家所属阵营ID数值

get_role_name

描述

获取玩家名字

参数

返回值

Str : 玩家名字

get_role__unique_name

描述

获取玩家唯一名字

参数

返回值

Str : 玩家唯一名字

get_role_plat_map_level

描述

获取玩家平台等级

参数

返回值

Int32 : 玩家等级

get_role_type

描述

获取玩家控制者类型

参数

返回值

RoleType : 玩家控制者类型

is_middle_join

描述

玩家是否中途加入

参数

返回值

Bool : 是否中途加入

api_get_camp

描述

获取玩家所属阵营对象

参数

返回值

Camp : 阵营对象

set_attr_val

描述

玩家设置属性

参数
参数名描述类型默认值
k属性名Str
value属性值Int32
返回值

get_all_unit_id

描述

获取玩家所有单位对象

参数

返回值

UnitGroup : 单位对象列表

set_role_exp_rate

描述

设置玩家经验获得率

参数
参数名描述类型默认值
rate倍率Float
返回值

get_role_exp_rate

描述

获得玩家经验倍率

参数

返回值

Fixed : 返回倍率

set_role_spawn_point

描述

设置玩家出生点

参数
参数名描述类型默认值
pointPoint
返回值

get_role_spawn_point

描述

获取玩家出生点

参数

返回值

FVector3 : 返回出生点位置

api_set_camp

描述

设置玩家队伍ID

参数
参数名描述类型默认值
new_camp队伍IDCamp
返回值

set_role_name

描述

设置玩家名字

参数
参数名描述类型默认值
name名字Str
返回值

change_role_res

描述

修改玩家资源

参数
参数名描述类型默认值
res_key资源名RoleResKey
res_cnt资源值Fixed
返回值

set_role_res

描述

设置玩家资源

参数
参数名描述类型默认值
res_key资源名RoleResKey
res_cnt资源值Fixed
返回值

get_role_res

描述

获得玩家资源

参数
参数名描述类型默认值
res_key资源名RoleResKey
返回值

Fixed : 资源值

set_group_navigate_mode

描述

设置玩家群体寻路严格模式

参数
参数名描述类型默认值
group_navigate_mode开启群体寻路严格模式Bool
返回值

set_save_data_int_value

描述

设置整数型参数到玩家存档栏位

参数
参数名描述类型默认值
index玩家存档栏位Int32
value整型参数Int32
返回值

set_save_data_fixed_value

描述

设置实数型参数到玩家存档栏位

参数
参数名描述类型默认值
index玩家存档栏位Int32
value实数型参数Fixed
返回值

set_save_data_bool_value

描述

设置布尔型参数到玩家存档栏位

参数
参数名描述类型默认值
index玩家存档栏位Int32
value布尔型参数Bool
返回值

set_save_data_str_value

描述

设置字符串型参数到玩家存档栏位

参数
参数名描述类型默认值
index玩家存档栏位Int32
value字符串型参数Str
返回值

set_save_data_table_value

描述

设置表型参数到玩家存档栏位

参数
参数名描述类型默认值
index玩家存档栏位Int32
value表型参数Table
返回值

upload_save_data

描述

上传玩家存档数据

参数

返回值

add_global_map_archive_data

描述

增加当前地图的指定key的存档值

参数
参数名描述类型默认值
key全局存档key值Str
value增加的数值Int32
返回值

get_player_rank_num

描述

获取玩家指定的全局存档key值对应排行榜的排名

参数
参数名描述类型默认值
rank_key全局存档key值Str
返回值

Int32 : 整型

get_player_archive_rank_num

描述

获取玩家指定的个人存档栏位对应排行榜的排名

参数
参数名描述类型默认值
archive_key玩家存档栏位Int32
返回值

Int32 : 整型

download_save_data

描述

下载玩家存档数据

参数

返回值

reset_download_save_data_callback

描述

重置下载档案数据回调

参数

返回值

get_save_data_int_value

描述

读取整数型玩家存档数据

参数
参数名描述类型默认值
index玩家存档栏位Int32
返回值

Int32 : 整型

get_save_data_fixed_value

描述

读取实数型玩家存档数据

参数
参数名描述类型默认值
index玩家存档栏位Int32
返回值

Fixed : 定点数

get_save_data_bool_value

描述

读取布尔型玩家存档数据

参数
参数名描述类型默认值
index玩家存档栏位Int32
返回值

Bool : 布尔值

get_save_data_str_value

描述

读取字符串型玩家存档数据

参数
参数名描述类型默认值
index玩家存档栏位Int32
返回值

Str : 字符串

get_save_data_table_value

描述

读取表型玩家存档数据

参数
参数名描述类型默认值
index玩家存档栏位Int32
返回值

Table : 表

api_use_store_item

描述

玩家使用收费道具

参数
参数名描述类型默认值
cnt数量UInt32
no收费道具KEYStoreKey
返回值

get_store_item_cnt

描述

获取玩家收费道具数量

参数
参数名描述类型默认值
no收费道具keyStoreKey
返回值

UInt32 : 收费道具数量

get_visibility_of_unit

描述

玩家是否拥有单位的可见性

参数
参数名描述类型默认值
unit单位Unit
返回值

Bool : 是否可见

api_change_tech_level

描述

修改玩家科技等级

参数
参数名描述类型默认值
tech_no科技编号TechKey
delta_lv变化等级Int32
返回值

api_set_tech_level

描述

修改玩家科技等级

参数
参数名描述类型默认值
tech_no科技编号TechKey
lv等级Int32
返回值

api_get_tech_level

描述

获取玩家科技等级

参数
参数名描述类型默认值
tech_no科技编号TechKey
返回值

UInt32 : 科技等级

is_point_visible_to_player

描述

点对于玩家是否可见

参数
参数名描述类型默认值
pointFPoint
返回值

Bool : 布尔值

is_point_in_fog

描述

点是否在迷雾中

参数
参数名描述类型默认值
pointFPoint
返回值

Bool : 布尔值

is_point_in_shadow

描述

点是否在黑色阴影中

参数
参数名描述类型默认值
pointFPoint
返回值

Bool : 布尔值

get_role_status

描述

获取玩家状态

参数

返回值

RoleStatus : 玩家状态

set_role_hostility

描述

设置玩家是否是敌对关系

参数
参数名描述类型默认值
role玩家Role
is_enemy玩家Role
返回值

players_is_alliance

描述

玩家是否是同盟关系

参数
参数名描述类型默认值
role玩家Role
返回值

Bool : 返回值

players_is_enemy

描述

玩家是否是敌对关系

参数
参数名描述类型默认值
role玩家Role
返回值

Bool : 返回值

share_source_player_vision_to_target

描述

原始玩家对目标玩家开放视野

参数
参数名描述类型默认值
role_2玩家Role
返回值

Bool : 返回值

close_source_player_vision_to_target

描述

原始玩家对目标玩家关闭视野

参数
参数名描述类型默认值
role_2玩家Role
返回值

Bool : 返回值

share_source_unit_vision_to_target

描述

原始单位对目标玩家开放视野

参数
参数名描述类型默认值
unit单位Unit
返回值

Bool : 返回值

close_source_unit_vision_to_target

描述

原始单位对目标玩家关闭视野

参数
参数名描述类型默认值
unit单位Unit
返回值

Bool : 返回值

role_select_unit

描述

选中单位或单位组

参数
参数名描述类型默认值
unit_or_unit_groupd单位或单位组DynamicTypeMeta
返回值

set_role_mouse_left_click

描述

开/关玩家鼠标的点选

参数
参数名描述类型默认值
value开/关Bool
返回值

set_role_mouse_move_select

描述

开/关玩家的鼠标的框选

参数
参数名描述类型默认值
value开/关Bool
返回值

set_role_mouse_wheel

描述

开/关玩家的鼠标滚轮

参数
参数名描述类型默认值
value开/关Bool
返回值

set_role_vignetting_enable

描述

设置玩家暗角开关

参数
参数名描述类型默认值
value暗角开关Bool
返回值

set_role_vignetting_size

描述

设置玩家暗角大小

参数
参数名描述类型默认值
value暗角大小Float
返回值

set_role_vignetting_breath_rate

描述

设置玩家暗角呼吸周期

参数
参数名描述类型默认值
value呼吸周期Float
返回值

set_role_vignetting_change_range

描述

设置玩家暗角变化幅度

参数
参数名描述类型默认值
value变化幅度Float
返回值

set_role_vignetting_color

描述

设置玩家暗角颜色

参数
参数名描述类型默认值
rRFloat
gGFloat
bBFloat
intervalIntervalFloat0
返回值

api_set_role_editable_game_func

描述

设置玩家的基础操作快捷键(过滤掉禁止修改的)

参数
参数名描述类型默认值
game_func_id可编辑操作EditableGameFunc
normal_key功能键NormalKey
record_key辅助键RecordKey
返回值

api_set_role_all_game_func_enable

描述

设置玩家的基础操作开关(包含所有基础操作)

参数
参数名描述类型默认值
game_func_id所有操作AllGameFunc
is_enable开/关Bool
返回值

api_is_conf_of_editable_game_func

描述

基础操作响应的快捷键是否已被占用(过滤掉禁止修改的)

参数
参数名描述类型默认值
normal_key功能键NormalKey
record_key辅助键RecordKey
返回值

Bool : 是否

api_get_editable_game_func_of_shortcut

描述

获取玩家响应键盘按键的基础操作(过滤掉禁止修改的)

参数
参数名描述类型默认值
normal_key功能键NormalKey
record_key辅助RecordKey
返回值

EditableGameFunc : 可修改基础操作

set_bool_hit_point_data

描述

设置玩家布尔埋点数据

参数
参数名描述类型默认值
key布尔keyInt64
value布尔值Bool
返回值

set_int_hit_point_data

描述

设置玩家整型埋点数据

参数
参数名描述类型默认值
key整型keyInt64
value整数Int64
返回值

api_set_follow_distance

描述

设置跟随距离

参数
参数名描述类型默认值
follow_distance跟随距离Fixed
返回值