# 索引


# 通用

接口
描述
CheckCanBindUI 客户端 检查实体是否可以绑定头顶UI,如何将UI与实体绑定详见CreateUI接口
CreateUI 客户端 创建UI,详见界面创建流程及生命周期
GetCustomUIControlProxyCls 客户端 获得原生界面自定义UI代理基类
GetMiniMapScreenNodeCls 客户端 获取小地图ScreenNode基类
GetNativeScreenManagerCls 客户端 获得NativeScreenManager类
GetScreenNodeCls 客户端 获得ScreenNode类
GetTopScreen 客户端 获取UI堆栈栈顶的UI节点
GetTopUI 客户端 获取UI栈顶的UI名称
GetTopUINode 客户端 获取Push进来的最顶层界面,包括原生界面,详见 界面创建流程及生命周期
GetUI 客户端 获取UI节点,详见界面创建流程及生命周期
GetUIScreenProxyCls 客户端 获得原生界面Screen代理基类
GetViewBinderCls 客户端 获得ViewBinder类
GetViewViewRequestCls 客户端 获得ViewRequest类
PopScreen 客户端 使用堆栈管理的方式关闭UI
PopTopUI 客户端 弹出UI栈顶的UI
PushScreen 客户端 使用堆栈管理的方式创建UI
RegisterUI 客户端 注册UI,创建UI前,需要先注册UI。同一UI只需要注册一次即可。详见界面创建流程及生命周期
RegisterUIAnimations 客户端 注册UI动画
UnregisterUIAnimation 客户端 取消UI动画的注册

# 自定义书本

接口
描述
GetBookManager 客户端 获取书本管理对象

# 自定义成就系统

接口
描述
AddNodeProgress 服务端 增加对应玩家的对应成就节点的成就进度
GetAchievementGatePosition 客户端 获取自定义成就系统的入口按钮位置
GetChildrenNode 服务端 获得该成就节点的下一级所有孩子节点的list
GetNodeDetailInfo 服务端 获取对应玩家的对应节点信息
SetAchievementGatePosition 客户端 设置自定义成就系统的入口按钮位置
SetNodeFinish 服务端 设置对应玩家的对应成就节点完成

# UI界面

接口
描述
AddEntityMarker 客户端 增加实体位置标记
AddEntityTextMarker 客户端 在小地图上增加实体文本标记
AddStaticMarker 客户端 增加地图上静态位置的标记
AddStaticTextMarker 客户端 在小地图上增加静态文本的标记
BindVirtualWorldModel 客户端 绑定虚拟世界中的模型
ChangeBindAutoScale 客户端 设置已绑定实体的UI是否根据绑定实体与本地玩家间的距离动态缩放,只对已绑定实体的UI界面生效,如何将UI与实体绑定详见CreateUI接口
ChangeBindEntityId 客户端 修改绑定的实体id,只对已绑定实体的UI界面生效,如何将UI与实体绑定详见CreateUI接口
ChangeBindOffset 客户端 修改与绑定实体之间的偏移量,只对已绑定实体的UI界面生效,如何将UI与实体绑定详见CreateUI接口
Clone 客户端 克隆一个已有的控件,修改它的名称,并将它挂接到指定的父节点上,目前文本、图片、按钮控件的克隆控件表现正常,其他复杂控件的克隆控件可能存在运行问题,建议在json编写的过程中,手动复制一份对应控件使用。
Create 客户端 UI生命周期函数,当UI创建成功时调用。
CreateChildControl 客户端 在当前画布中创建子控件,如果该子控件已经存在则返回已存在的子控件
Destroy 客户端 UI生命周期函数,当UI销毁时调用。
GetAllChildrenPath 客户端 获取所有子节点的路径list
GetBaseUIControl 客户端 根据路径获取BaseUIControl实例
GetBindAutoScale 客户端 获取该绑定实体的UI是否动态缩放,未绑定的UI将传回默认值1
GetBindEntityId 客户端 获取该UI绑定的实体id,未绑定的UI将传回默认值None
GetBindOffset 客户端 获取该UI绑定实体的偏移量,未绑定的UI将传回默认值(0, 0, 0)
GetBindWorldPosition 客户端 获取该UI绑定的worldPosition,未绑定返回默认值None
GetChildrenName 客户端 获取子节点的名称list
GetIsHud 客户端 获得本界面的输入模式
GetRichTextItem 客户端 返回一个富文本控件实例
GetScreenName 客户端 获得本界面的名称
GetSelf 客户端 获取零件界面自身
OnActive 客户端 UI生命周期函数,当UI重新回到栈顶时调用。
OnDeactive 客户端 UI生命周期函数,当栈顶UI有其他UI入栈时调用。
RemoveChildControl 客户端 移除当前画布中的子控件
RemoveComponent 客户端 动态删除某一控件
RemoveEntityMarker 客户端 删除实体位置标记
RemoveEntityTextMarker 客户端 在小地图上删除实体文本标记
RemoveStaticMarker 客户端 删除静态位置标记
RemoveStaticTextMarker 客户端 在小地图上删除静态文本标记
SetBindWorldPosition 客户端 设置UI绑定的worldPosition
SetHighestY 客户端 设置绘制地图的最大高度
SetIsHud 客户端 设置本界面的输入模式
SetRemove 客户端 删除本界面节点
SetScreenVisible 客户端 设置是否显示本界面
SetSelectControl 客户端 设置当前焦点所在的控件,当设置控件为文本输入框时会弹出系统小键盘
SetStackGridCount 客户端 设置StackGrid控件的大小
SetUiEntity 客户端 设置PaperDoll控件需要显示的生物模型,PaperDoll控件的配置方式详见控件介绍PaperDoll
SetUiModel 客户端 设置PaperDoll控件需要显示的模型,PaperDoll控件的配置方式详见控件介绍PaperDoll
SetUiModelScale 客户端 设置PaperDoll控件模型的缩放比例
Update 客户端 客户端每帧调用,1秒有30帧
UpdateScreen 客户端 刷新界面,重新计算各个控件的相关数据
ZoomIn 客户端 放大地图
ZoomOut 客户端 缩小地图
ZoomReset 客户端 恢复地图放缩大小为默认值

# UI控件

接口
描述
AddHoverEventParams 客户端 开启按钮的悬浮回调功能,不调用该函数则按钮无悬浮回调
AddOption 客户端 添加下拉框项,若添加成功则返回True,否则返回False
AddTouchEventParams 客户端 开启按钮回调功能,不调用该函数则按钮无回调
ClearOptions 客户端 清空下拉框
ClearSelection 客户端 清除当前选中,使下拉框恢复未选中内容状态
DisableTextShadow 客户端 关闭文本控件显示阴影
EnableTextShadow 客户端 使文本控件显示阴影
GetAnchorFrom 客户端 判断控件相对于父节点的哪个锚点来计算位置与大小
GetAnchorTo 客户端 获取控件自身锚点位置信息
GetChildByName 客户端 根据子控件的名称获取BaseUIControl实例
GetChildByPath 客户端 根据相对路径获取BaseUIControl实例
GetClipDirection 客户端 获取图片控件的裁剪方向
GetClipOffset 客户端 获取控件的裁剪偏移信息
GetClipsChildren 客户端 根据控件路径返回某控件是否开启裁剪内容
GetCurrentSliceIndex 客户端 获取轮盘当前选择的切片的index,一般是在SetHoverCallback和SetTouchUpCallback中使用,表示当前鼠标悬浮或者点击的轮盘切片index
GetEditText 客户端 获取edit_box输入框的文本信息,获取失败会返回None
GetFullPosition 客户端 获取控件的锚点坐标,支持比例值以及绝对值
GetFullSize 客户端 获取控件的大小,支持百分比以及绝对值
GetGlobalPosition 客户端 获取控件全局坐标
GetGlobalRotateAngle 客户端 获取图片通过RotateAround函数设置进去的角度值
GetGlobalRotatePoint 客户端 获取图片通过RotateAround函数设置进去的point值
GetGridItem 客户端 根据网格位置获取元素控件
GetIsModal 客户端 判断当前面板是否为模态框
GetIsSwallow 客户端 判断当前面板输入是否会吞噬事件,isSwallow为Ture时,点击时,点击事件不会穿透到世界。如破坏方块、镜头转向不会被响应
GetMaxSize 客户端 获取控件所允许的最大的大小值
GetMinSize 客户端 获取控件所允许的最小的大小值
GetModelId 客户端 获取渲染的骨骼模型Id
GetOffsetDelta 客户端 获得点击面板的拖拽偏移量
GetOptionCount 客户端 获得选项数量
GetOptionIndexByShowName 客户端 根据展示文本查找对应下拉框项的索引位置,若找不到返回-1
GetOptionShowNameByIndex 客户端 根据索引位置查找当前栈式文本,若找不到返回None
GetOrientation 客户端 获取stackPanel的排列方向
GetPath 客户端 返回当前控件的相对路径,路径从画布节点开始算起
GetPosition 客户端 获取控件相对父节点的坐标
GetRotateAngle 客户端 获取图片相对自身的旋转锚点旋转的角度
GetRotatePivot 客户端 获取图片相对自身的旋转锚点
GetRotateRect 客户端 获取图片当前的四个边角点
GetScrollViewContentControl 客户端 返回该scroll_view内容的BaseUIControl实例
GetScrollViewContentPath 客户端 返回该scroll_view内容的路径
GetScrollViewPercentValue 客户端 获取当前scroll_view内容的百分比位置
GetScrollViewPos 客户端 获得当前scroll_view最上方内容的位置
GetSelectOptionIndex 客户端 获得当前选中项的索引,所无选中项则返回-1
GetSelectOptionShowName 客户端 获得当前选中项的展示文本,所无选中项则返回None
GetSize 客户端 获取控件的大小
GetSliceCount 客户端 获取轮盘可以选择的总切片数量
GetSliderValue 客户端 获取滑动条的值,失败返回0
GetText 客户端 获取Label的文本信息,获取失败会返回None
GetTextAlignment 客户端 获取文本控件的文本对齐方式
GetTextColor 客户端 获取Label文本颜色
GetTextLinePadding 客户端 获取文本控件的行间距
GetToggleState 客户端 获取Toggle开关控件的状态
GetUiItem 客户端 获取ItemRenderer控件显示的物品,ItemRenderer控件的配置方式详见控件介绍ItemRenderer
GetVisible 客户端 根据控件路径返回某控件是否已显示
IsAnimEndCallbackRegistered 客户端 控件是否对名称为animName的动画进行了注册回调
IsTextShadowEnabled 客户端 判断文本控件是否显示阴影
PauseAnimation 客户端 暂停动画,暂停后的动画会停在当前的状态
PlayAnimation 客户端 继续播放动画,从动画当前状态开始播放
RegisterCloseComboBoxCallback 客户端 注册关闭下拉框事件回调
RegisterOpenComboBoxCallback 客户端 注册展开下拉框事件回调
RegisterSelectItemCallback 客户端 注册选中下拉框内容事件回调
RemoveAnimEndCallback 客户端 移除动画播放结束后的回调
RemoveAnimation 客户端 删除单一属性的动画,删除后的值与当前状态有关,建议删除后重新设置该属性值
RemoveOptionByIndex 客户端 根据提供的索引移除对应下拉框项,移除成功则返回True,否则返回False
RemoveOptionByShowName 客户端 根据提供的展示文本移除对应下拉框项,移除成功则返回True,否则返回False
RenderBlockGeometryModel 客户端 渲染网格体模型
RenderEntity 客户端 渲染实体
RenderSkeletonModel 客户端 渲染骨骼模型(不依赖实体)
Rotate 客户端 图片相对自身的旋转锚点进行旋转
RotateAround 客户端 图片相对全局坐标系中某个固定的点进行旋转
SetAlpha 客户端 设置节点的透明度,仅对image和label控件生效
SetAnchorFrom 客户端 设置控件相对于父节点的锚点
SetAnchorTo 客户端 设置控件自身锚点位置
SetAnimEndCallback 客户端 设置动画播放结束后的回调,每次设置都会覆盖上一次的设置
SetAnimation 客户端 给单一属性设置动画,已有重复的会设置失败,需要先remove
SetButtonHoverInCallback 客户端 设置鼠标进入按钮时触发的悬浮回调函数
SetButtonHoverOutCallback 客户端 设置鼠标退出按钮时触发的悬浮回调函数
SetButtonScreenExitCallback 客户端 设置按钮所在画布退出时若鼠标仍未抬起时触发回调函数
SetButtonTouchCancelCallback 客户端 设置触控在按钮范围外弹起时触发的回调函数
SetButtonTouchDownCallback 客户端 设置按钮按下时触发的回调函数
SetButtonTouchMoveCallback 客户端 设置按下后触控移动时触发的回调函数
SetButtonTouchMoveInCallback 客户端 设置按下按钮后进入控件时触发的回调函数
SetButtonTouchMoveOutCallback 客户端 设置按下按钮后退出控件时触发的回调函数
SetButtonTouchUpCallback 客户端 设置触控在按钮范围内弹起时的回调函数
SetClipDirection 客户端 设置图片控件的裁剪方向
SetClipOffset 客户端 设置控件的裁剪偏移信息
SetClipsChildren 客户端 设置控件是否开启裁剪内容
SetCurrentSliceIndex 客户端 设置轮盘选择的切片
SetEditText 客户端 设置edit_box输入框的文本信息
SetEditTextMaxLength 客户端 设置输入框的最大输入长度
SetFullPosition 客户端 设置控件的锚点坐标(全局坐标),支持比例值以及绝对值
SetFullSize 客户端 设置控件的大小,支持比例形式以及绝对值
SetGridDimension 客户端 设置Grid控件的大小
SetHighestY 客户端 设置绘制地图的最大高度
SetHoverCallback 客户端 设置轮盘选择切片触发回调函数
SetImageAdaptionType 客户端 设置图片控件的图片适配方式以及信息
SetIsModal 客户端 设置当前面板是否为模态框
SetIsSwallow 客户端 设置当前面板输入是否会吞噬事件,isSwallow为Ture时,点击时,点击事件不会穿透到世界。如破坏方块、镜头转向不会被响应
SetLayer 客户端 设置控件节点的层级,可以通过传入空字符串("")的方式来调整整个JSON的基础层级
SetMaxSize 客户端 设置控件所允许的最大的大小值
SetMinSize 客户端 设置控件所允许的最小的大小值
SetOffsetDelta 客户端 设置点击面板的拖拽偏移量
SetOrientation 客户端 设置stackPanel的排列方向
SetPosition 客户端 设置控件相对父节点的坐标
SetRotatePivot 客户端 设置图片自身旋转锚点,该点并不是固定的点,而是相对于自身位置的点
SetScrollViewPercentValue 客户端 设置当前scroll_view内容的百分比位置
SetScrollViewPos 客户端 设置当前scroll_view内容的位置
SetSelectOptionByIndex 客户端 根据提供的索引选中对应下拉框项
SetSelectOptionByShowName 客户端 根据提供的展示文本选中对应下拉框项
SetSize 客户端 设置控件的大小
SetSliderValue 客户端 设置滑动条的值
SetSprite 客户端 给图片控件换指定贴图
SetSpriteClipRatio 客户端 设置图片的裁剪区域比例(不改变控件尺寸)。可以配合image控件的clip_ratio属性控制方向。
SetSpriteColor 客户端 设置图片颜色
SetSpriteGray 客户端 给图片控件置灰,比直接SetSprite一张灰图片效率要高
SetSpritePlatformFrame 客户端 设置图片为我的世界移动端启动器当前帐号的头像框
SetSpritePlatformHead 客户端 设置图片为我的世界移动端启动器当前帐号的头像
SetSpriteUV 客户端 设置图片的起始uv,与json中的"uv"属性作用一致
SetSpriteUVSize 客户端 设置图片的uv大小,与json中的"uv_size"属性作用一致
SetText 客户端 设置Label的文本信息
SetTextAlignment 客户端 设置文本控件的文本对齐方式
SetTextColor 客户端 设置Label文本的颜色
SetTextFontSize 客户端 设置Label中文本字体的大小
SetTextLinePadding 客户端 设置文本控件的行间距
SetToggleState 客户端 设置Toggle开关控件的值
SetTouchEnable 客户端 设置控件是否可点击交互
SetTouchUpCallback 客户端 设置轮盘选择切片并且鼠标按下抬起后触发回调函数
SetUiItem 客户端 设置ItemRenderer控件显示的物品,ItemRenderer控件的配置方式详见控件介绍ItemRenderer
SetValue 客户端 设置进度条的进度
SetVisible 客户端 根据控件路径选择是否显示某控件,可以通过传入空字符串("")的方式来调整整个JSON的显示/隐藏
StopAnimation 客户端 停止动画,动画将恢复到第一段动画片段的from状态
ZoomIn 客户端 放大地图
ZoomOut 客户端 缩小地图
ZoomReset 客户端 恢复地图放缩大小为默认值
asButton 客户端 将当前BaseUIControl转换为ButtonUIControl实例,如当前控件非button类型则返回None
asGrid 客户端 将当前BaseUIControl转换为GridUIControl实例,如当前控件非grid类型则返回None
asImage 客户端 将当前BaseUIControl转换为ImageUIControl实例,如当前控件非image类型则返回None
asInputPanel 客户端 将当前BaseUIControl转换为InputPanelUIControl实例,如当前控件非inputPanel类型则返回None
asItemRenderer 客户端 将当前BaseUIControl转换为ItemRenderer实例,如当前控件非custom类型则返回None
asLabel 客户端 将当前BaseUIControl转换为LabelUIControl实例,如当前控件非Label类型则返回None
asMiniMap 客户端 将当前BaseUIControl转换为MiniMapUIControl实例,如当前控件非小地图类型则返回None
asNeteaseComboBox 客户端 将当前BaseUIControl转换为NeteaseComboBoxUIControl实例,如当前控件非panel类型则返回None
asNeteasePaperDoll 客户端 将当前BaseUIControl转换为NeteasePaperDollUIControl实例,如当前控件非custom类型则返回None
asProgressBar 客户端 将当前BaseUIControl转换为ProgressBarUIControl实例,如当前控件非panel类型则返回None
asScrollView 客户端 将当前BaseUIControl转换为ScrollViewUIControl实例,如当前控件非scrollview类型则返回None
asSelectionWheel 客户端 将当前BaseUIControl转换为SelectionWheelUIControl实例,如当前控件非selectionWheel类型则返回None
asSlider 客户端 将当前BaseUIControl转换为SliderUIControl实例,如当前控件非滑动条类型则返回None
asStackPanel 客户端 将当前BaseUIControl转换为StackPanelUIControl实例,如当前控件非stackPanel类型则返回None
asSwitchToggle 客户端 将当前BaseUIControl转换为SwitchToggleUIControl实例,如当前控件非panel类型或非toggle则返回None
asTextEditBox 客户端 将当前BaseUIControl转换为TextEditBoxUIControl实例,如当前控件非editbox类型则返回None
resetAnimation 客户端 重置该控件的动画