xiaokun/netease-modsdk-wiki
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
12738a142cc270be97015c581bdb4962926fce25
netease-modsdk-wiki/docs/mcdocs/1-ModAPI/接口/自定义UI/索引.md
boybook 12738a142c 更新3.4API
2025-06-27 23:59:47 +08:00

263 lines
39 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

---
sidebarDepth: 1
---
# 索引
---
- [通用](#通用)
- [自定义书本](#自定义书本)
- [自定义成就系统](#自定义成就系统)
- [UI界面](#ui界面)
- [UI控件](#ui控件)
### 通用
| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [CheckCanBindUI](通用.md#checkcanbindui) | <span style="display:inline;color:#7575f9">客户端</span> | 检查实体是否可以绑定头顶UI，如何将UI与实体绑定详见[CreateUI](通用.md#createui)接口 |
| [CreateUI](通用.md#createui) | <span style="display:inline;color:#7575f9">客户端</span> | 创建UI，详见<a href="../../../../mcguide/18-界面与交互/30-UI说明文档.html#界面创建流程及生命周期">界面创建流程及生命周期</a> |
| [EnableFontBatchRender](通用.md#enablefontbatchrender) | <span style="display:inline;color:#7575f9">客户端</span> | 是否开启字体合批 |
| [GetCustomUIControlProxyCls](通用.md#getcustomuicontrolproxycls) | <span style="display:inline;color:#7575f9">客户端</span> | 获得原生界面自定义UI代理基类 |
| [GetMiniMapScreenNodeCls](通用.md#getminimapscreennodecls) | <span style="display:inline;color:#7575f9">客户端</span> | 获取小地图ScreenNode基类 |
| [GetNativeScreenManagerCls](通用.md#getnativescreenmanagercls) | <span style="display:inline;color:#7575f9">客户端</span> | 获得NativeScreenManager类 |
| [GetScreenNodeCls](通用.md#getscreennodecls) | <span style="display:inline;color:#7575f9">客户端</span> | 获得ScreenNode类 |
| [GetTopScreen](通用.md#gettopscreen) | <span style="display:inline;color:#7575f9">客户端</span> | 获取UI堆栈栈顶的UI节点 |
| [GetTopUI](通用.md#gettopui) | <span style="display:inline;color:#7575f9">客户端</span> | 获取UI栈顶的UI名称 |
| [GetTopUINode](通用.md#gettopuinode) | <span style="display:inline;color:#7575f9">客户端</span> | 获取Push进来的最顶层界面，包括原生界面，详见<a href="../../../../mcguide/18-界面与交互/30-UI说明文档.html#界面创建流程及生命周期" rel="noopenner"> 界面创建流程及生命周期 </a> |
| [GetUI](通用.md#getui) | <span style="display:inline;color:#7575f9">客户端</span> | 获取UI节点，详见<a href="../../../../mcguide/18-界面与交互/30-UI说明文档.html#界面创建流程及生命周期">界面创建流程及生命周期</a> |
| [GetUIScreenProxyCls](通用.md#getuiscreenproxycls) | <span style="display:inline;color:#7575f9">客户端</span> | 获得原生界面Screen代理基类 |
| [GetViewBinderCls](通用.md#getviewbindercls) | <span style="display:inline;color:#7575f9">客户端</span> | 获得ViewBinder类 |
| [GetViewViewRequestCls](通用.md#getviewviewrequestcls) | <span style="display:inline;color:#7575f9">客户端</span> | 获得ViewRequest类 |
| [OpenDeveloperHomeWindow](通用.md#opendeveloperhomewindow) | <span style="display:inline;color:#7575f9">客户端</span> | 打开网易资源中心开发者主页。该接口只能在横屏版本手机端使用 |
| [OpenResourceCenterDetailWindow](通用.md#openresourcecenterdetailwindow) | <span style="display:inline;color:#7575f9">客户端</span> | 打开网易资源中心组件详情界面。该接口只能在横屏版本手机端使用 |
| [PopScreen](通用.md#popscreen) | <span style="display:inline;color:#7575f9">客户端</span> | 使用堆栈管理的方式关闭UI |
| [PopTopUI](通用.md#poptopui) | <span style="display:inline;color:#7575f9">客户端</span> | 弹出UI栈顶的UI |
| [PushScreen](通用.md#pushscreen) | <span style="display:inline;color:#7575f9">客户端</span> | 使用堆栈管理的方式创建UI |
| [RegisterUI](通用.md#registerui) | <span style="display:inline;color:#7575f9">客户端</span> | 注册UI，创建UI前，需要先注册UI。同一UI只需要注册一次即可。详见<a href="../../../../mcguide/18-界面与交互/30-UI说明文档.html#界面创建流程及生命周期">界面创建流程及生命周期</a> |
| [RegisterUIAnimations](通用.md#registeruianimations) | <span style="display:inline;color:#7575f9">客户端</span> | 注册UI动画 |
| [UnregisterUIAnimation](通用.md#unregisteruianimation) | <span style="display:inline;color:#7575f9">客户端</span> | 取消UI动画的注册 |
### 自定义书本
| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [GetBookManager](自定义书本.md#getbookmanager) | <span style="display:inline;color:#7575f9">客户端</span> | 获取书本管理对象 |
### 自定义成就系统
| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [AddNodeProgress](自定义成就系统.md#addnodeprogress) | <span style="display:inline;color:#ff5555">服务端</span> | 增加对应玩家的对应成就节点的成就进度 |
| [GetAchievementGatePosition](自定义成就系统.md#getachievementgateposition) | <span style="display:inline;color:#7575f9">客户端</span> | 获取自定义成就系统的入口按钮位置 |
| [GetChildrenNode](自定义成就系统.md#getchildrennode) | <span style="display:inline;color:#ff5555">服务端</span> | 获得该成就节点的下一级所有孩子节点的list |
| [GetNodeDetailInfo](自定义成就系统.md#getnodedetailinfo) | <span style="display:inline;color:#ff5555">服务端</span> | 获取对应玩家的对应节点信息 |
| [SetAchievementGatePosition](自定义成就系统.md#setachievementgateposition) | <span style="display:inline;color:#7575f9">客户端</span> | 设置自定义成就系统的入口按钮位置 |
| [SetNodeFinish](自定义成就系统.md#setnodefinish) | <span style="display:inline;color:#ff5555">服务端</span> | 设置对应玩家的对应成就节点完成 |
### UI界面
| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [BindVirtualWorldModel](UI界面.md#bindvirtualworldmodel) | <span style="display:inline;color:#7575f9">客户端</span> | 绑定虚拟世界中的模型 |
| [ChangeBindAutoScale](UI界面.md#changebindautoscale) | <span style="display:inline;color:#7575f9">客户端</span> | 设置已绑定实体的UI是否根据绑定实体与本地玩家间的距离动态缩放，**只对已绑定实体的UI界面生效，如何将UI与实体绑定详见[CreateUI](通用.md#CreateUI)接口** |
| [ChangeBindEntityId](UI界面.md#changebindentityid) | <span style="display:inline;color:#7575f9">客户端</span> | 修改绑定的实体id，**只对已绑定实体的UI界面生效，如何将UI与实体绑定详见[CreateUI](通用.md#CreateUI)接口** |
| [ChangeBindOffset](UI界面.md#changebindoffset) | <span style="display:inline;color:#7575f9">客户端</span> | 修改与绑定实体之间的偏移量，**只对已绑定实体的UI界面生效，如何将UI与实体绑定详见[CreateUI](通用.md#CreateUI)接口** |
| [Clone](UI界面.md#clone) | <span style="display:inline;color:#7575f9">客户端</span> | 克隆一个已有的控件，修改它的名称，并将它挂接到指定的父节点上，目前文本、图片、按钮控件的克隆控件表现正常，其他复杂控件的克隆控件可能存在运行问题，建议在json编写的过程中，手动复制一份对应控件使用。 |
| [Create](UI界面.md#create) | <span style="display:inline;color:#7575f9">客户端</span> | UI生命周期函数，当UI创建成功时调用。 |
| [CreateChildControl](UI界面.md#createchildcontrol) | <span style="display:inline;color:#7575f9">客户端</span> | 在当前画布中创建子控件，如果该子控件已经存在则返回已存在的子控件 |
| [Destroy](UI界面.md#destroy) | <span style="display:inline;color:#7575f9">客户端</span> | UI生命周期函数，当UI销毁时调用。 |
| [GetAllChildrenPath](UI界面.md#getallchildrenpath) | <span style="display:inline;color:#7575f9">客户端</span> | 获取所有子节点的路径list |
| [GetBaseUIControl](UI界面.md#getbaseuicontrol) | <span style="display:inline;color:#7575f9">客户端</span> | 根据路径获取BaseUIControl实例 |
| [GetBindAutoScale](UI界面.md#getbindautoscale) | <span style="display:inline;color:#7575f9">客户端</span> | 获取该绑定实体的UI是否动态缩放，未绑定的UI将传回默认值1 |
| [GetBindEntityId](UI界面.md#getbindentityid) | <span style="display:inline;color:#7575f9">客户端</span> | 获取该UI绑定的实体id，未绑定的UI将传回默认值None |
| [GetBindOffset](UI界面.md#getbindoffset) | <span style="display:inline;color:#7575f9">客户端</span> | 获取该UI绑定实体的偏移量，未绑定的UI将传回默认值(0, 0, 0) |
| [GetBindWorldPosition](UI界面.md#getbindworldposition) | <span style="display:inline;color:#7575f9">客户端</span> | 获取该UI绑定的worldPosition，未绑定返回默认值None |
| [GetChildrenName](UI界面.md#getchildrenname) | <span style="display:inline;color:#7575f9">客户端</span> | 获取子节点的名称list |
| [GetIsHud](UI界面.md#getishud) | <span style="display:inline;color:#7575f9">客户端</span> | 获得本界面的输入模式 |
| [GetRichTextItem](UI界面.md#getrichtextitem) | <span style="display:inline;color:#7575f9">客户端</span> | 返回一个富文本控件实例 |
| [GetScreenName](UI界面.md#getscreenname) | <span style="display:inline;color:#7575f9">客户端</span> | 获得本界面的名称 |
| [GetSelf](UI界面.md#getself) | <span style="display:inline;color:#7575f9">客户端</span> | 获取零件界面自身 |
| [OnActive](UI界面.md#onactive) | <span style="display:inline;color:#7575f9">客户端</span> | UI生命周期函数，当UI重新回到栈顶时调用。 |
| [OnDeactive](UI界面.md#ondeactive) | <span style="display:inline;color:#7575f9">客户端</span> | UI生命周期函数，当栈顶UI有其他UI入栈时调用。 |
| [RemoveChildControl](UI界面.md#removechildcontrol) | <span style="display:inline;color:#7575f9">客户端</span> | 移除当前画布中的子控件 |
| [RemoveComponent](UI界面.md#removecomponent) | <span style="display:inline;color:#7575f9">客户端</span> | 动态删除某一控件 |
| [SetBindWorldPosition](UI界面.md#setbindworldposition) | <span style="display:inline;color:#7575f9">客户端</span> | 设置UI绑定的worldPosition |
| [SetIsHud](UI界面.md#setishud) | <span style="display:inline;color:#7575f9">客户端</span> | 设置本界面的输入模式 |
| [SetRemove](UI界面.md#setremove) | <span style="display:inline;color:#7575f9">客户端</span> | 删除本界面节点 |
| [SetScreenVisible](UI界面.md#setscreenvisible) | <span style="display:inline;color:#7575f9">客户端</span> | 设置是否显示本界面 |
| [SetSelectControl](UI界面.md#setselectcontrol) | <span style="display:inline;color:#7575f9">客户端</span> | 设置当前焦点所在的控件,当设置控件为文本输入框时会弹出系统小键盘 |
| [SetStackGridCount](UI界面.md#setstackgridcount) | <span style="display:inline;color:#7575f9">客户端</span> | 设置StackGrid控件的大小 |
| [SetUiEntity](UI界面.md#setuientity) | <span style="display:inline;color:#7575f9">客户端</span> | 设置PaperDoll控件需要显示的生物模型,PaperDoll控件的配置方式详见<a href="../../../../mcguide/18-界面与交互/30-UI说明文档.html#paperdoll">控件介绍PaperDoll</a> |
| [SetUiModel](UI界面.md#setuimodel) | <span style="display:inline;color:#7575f9">客户端</span> | 设置PaperDoll控件需要显示的模型,PaperDoll控件的配置方式详见<a href="../../../../mcguide/18-界面与交互/30-UI说明文档.html#paperdoll">控件介绍PaperDoll</a> |
| [SetUiModelScale](UI界面.md#setuimodelscale) | <span style="display:inline;color:#7575f9">客户端</span> | 设置PaperDoll控件模型的缩放比例 |
| [Update](UI界面.md#update) | <span style="display:inline;color:#7575f9">客户端</span> | 客户端每帧调用，1秒有30帧 |
| [UpdateScreen](UI界面.md#updatescreen) | <span style="display:inline;color:#7575f9">客户端</span> | 刷新界面，重新计算各个控件的相关数据 |
### UI控件
| 接口 | <div style="width: 3em"></div> | 描述 |
| --- | --- | --- |
| [AddEntityMarker](UI控件.md#addentitymarker) | <span style="display:inline;color:#7575f9">客户端</span> | 增加实体位置标记 |
| [AddEntityTextMarker](UI控件.md#addentitytextmarker) | <span style="display:inline;color:#7575f9">客户端</span> | 在小地图上增加实体文本标记 |
| [AddHoverEventParams](UI控件.md#addhovereventparams) | <span style="display:inline;color:#7575f9">客户端</span> | 开启按钮的悬浮回调功能，不调用该函数则按钮无悬浮回调 |
| [AddOption](UI控件.md#addoption) | <span style="display:inline;color:#7575f9">客户端</span> | 添加下拉框项，若添加成功则返回True，否则返回False |
| [AddStaticMarker](UI控件.md#addstaticmarker) | <span style="display:inline;color:#7575f9">客户端</span> | 增加地图上静态位置的标记 |
| [AddStaticTextMarker](UI控件.md#addstatictextmarker) | <span style="display:inline;color:#7575f9">客户端</span> | 在小地图上增加静态文本的标记 |
| [AddTouchEventParams](UI控件.md#addtoucheventparams) | <span style="display:inline;color:#7575f9">客户端</span> | 开启按钮回调功能，不调用该函数则按钮无回调 |
| [ClearOptions](UI控件.md#clearoptions) | <span style="display:inline;color:#7575f9">客户端</span> | 清空下拉框 |
| [ClearSelection](UI控件.md#clearselection) | <span style="display:inline;color:#7575f9">客户端</span> | 清除当前选中，使下拉框恢复未选中内容状态 |
| [DisableTextShadow](UI控件.md#disabletextshadow) | <span style="display:inline;color:#7575f9">客户端</span> | 关闭文本控件显示阴影 |
| [EnableTextShadow](UI控件.md#enabletextshadow) | <span style="display:inline;color:#7575f9">客户端</span> | 使文本控件显示阴影 |
| [GetAnchorFrom](UI控件.md#getanchorfrom) | <span style="display:inline;color:#7575f9">客户端</span> | 判断控件相对于父节点的哪个锚点来计算位置与大小 |
| [GetAnchorTo](UI控件.md#getanchorto) | <span style="display:inline;color:#7575f9">客户端</span> | 获取控件自身锚点位置信息 |
| [GetChildByName](UI控件.md#getchildbyname) | <span style="display:inline;color:#7575f9">客户端</span> | 根据子控件的名称获取BaseUIControl实例 |
| [GetChildByPath](UI控件.md#getchildbypath) | <span style="display:inline;color:#7575f9">客户端</span> | 根据相对路径获取BaseUIControl实例 |
| [GetClipDirection](UI控件.md#getclipdirection) | <span style="display:inline;color:#7575f9">客户端</span> | 获取图片控件的裁剪方向 |
| [GetClipOffset](UI控件.md#getclipoffset) | <span style="display:inline;color:#7575f9">客户端</span> | 获取控件的裁剪偏移信息 |
| [GetClipsChildren](UI控件.md#getclipschildren) | <span style="display:inline;color:#7575f9">客户端</span> | 根据控件路径返回某控件是否开启裁剪内容 |
| [GetCurrentSliceIndex](UI控件.md#getcurrentsliceindex) | <span style="display:inline;color:#7575f9">客户端</span> | 获取轮盘当前选择的切片的index，一般是在SetHoverCallback和SetTouchUpCallback中使用，表示当前鼠标悬浮或者点击的轮盘切片index |
| [GetEditText](UI控件.md#getedittext) | <span style="display:inline;color:#7575f9">客户端</span> | 获取edit_box输入框的文本信息，获取失败会返回None |
| [GetFullPosition](UI控件.md#getfullposition) | <span style="display:inline;color:#7575f9">客户端</span> | 获取控件的锚点坐标，支持比例值以及绝对值 |
| [GetFullSize](UI控件.md#getfullsize) | <span style="display:inline;color:#7575f9">客户端</span> | 获取控件的大小，支持百分比以及绝对值 |
| [GetGlobalPosition](UI控件.md#getglobalposition) | <span style="display:inline;color:#7575f9">客户端</span> | 获取控件全局坐标 |
| [GetGlobalRotateAngle](UI控件.md#getglobalrotateangle) | <span style="display:inline;color:#7575f9">客户端</span> | 获取图片通过RotateAround函数设置进去的角度值 |
| [GetGlobalRotatePoint](UI控件.md#getglobalrotatepoint) | <span style="display:inline;color:#7575f9">客户端</span> | 获取图片通过RotateAround函数设置进去的point值 |
| [GetGridItem](UI控件.md#getgriditem) | <span style="display:inline;color:#7575f9">客户端</span> | 根据网格位置获取元素控件 |
| [GetIsModal](UI控件.md#getismodal) | <span style="display:inline;color:#7575f9">客户端</span> | 判断当前面板是否为模态框 |
| [GetIsSwallow](UI控件.md#getisswallow) | <span style="display:inline;color:#7575f9">客户端</span> | 判断当前面板输入是否会吞噬事件，isSwallow为Ture时，点击时，点击事件不会穿透到世界。如破坏方块、镜头转向不会被响应 |
| [GetMaxSize](UI控件.md#getmaxsize) | <span style="display:inline;color:#7575f9">客户端</span> | 获取控件所允许的最大的大小值 |
| [GetMinSize](UI控件.md#getminsize) | <span style="display:inline;color:#7575f9">客户端</span> | 获取控件所允许的最小的大小值 |
| [GetModelId](UI控件.md#getmodelid) | <span style="display:inline;color:#7575f9">客户端</span> | 获取渲染的骨骼模型Id |
| [GetOffsetDelta](UI控件.md#getoffsetdelta) | <span style="display:inline;color:#7575f9">客户端</span> | 获得点击面板的拖拽偏移量 |
| [GetOptionCount](UI控件.md#getoptioncount) | <span style="display:inline;color:#7575f9">客户端</span> | 获得选项数量 |
| [GetOptionIndexByShowName](UI控件.md#getoptionindexbyshowname) | <span style="display:inline;color:#7575f9">客户端</span> | 根据展示文本查找对应下拉框项的索引位置，若找不到返回-1 |
| [GetOptionShowNameByIndex](UI控件.md#getoptionshownamebyindex) | <span style="display:inline;color:#7575f9">客户端</span> | 根据索引位置查找当前栈式文本，若找不到返回None |
| [GetOrientation](UI控件.md#getorientation) | <span style="display:inline;color:#7575f9">客户端</span> | 获取stackPanel的排列方向 |
| [GetPath](UI控件.md#getpath) | <span style="display:inline;color:#7575f9">客户端</span> | 返回当前控件的相对路径，路径从画布节点开始算起 |
| [GetPosition](UI控件.md#getposition) | <span style="display:inline;color:#7575f9">客户端</span> | 获取控件相对父节点的坐标 |
| [GetPropertyBag](UI控件.md#getpropertybag) | <span style="display:inline;color:#7575f9">客户端</span> | 获取PropertyBag |
| [GetRotateAngle](UI控件.md#getrotateangle) | <span style="display:inline;color:#7575f9">客户端</span> | 获取图片相对自身的旋转锚点旋转的角度 |
| [GetRotatePivot](UI控件.md#getrotatepivot) | <span style="display:inline;color:#7575f9">客户端</span> | 获取图片相对自身的旋转锚点 |
| [GetRotateRect](UI控件.md#getrotaterect) | <span style="display:inline;color:#7575f9">客户端</span> | 获取图片当前的四个边角点 |
| [GetScrollViewContentControl](UI控件.md#getscrollviewcontentcontrol) | <span style="display:inline;color:#7575f9">客户端</span> | 返回该scroll_view内容的BaseUIControl实例 |
| [GetScrollViewContentPath](UI控件.md#getscrollviewcontentpath) | <span style="display:inline;color:#7575f9">客户端</span> | 返回该scroll_view内容的路径 |
| [GetScrollViewPercentValue](UI控件.md#getscrollviewpercentvalue) | <span style="display:inline;color:#7575f9">客户端</span> | 获取当前scroll_view内容的百分比位置 |
| [GetScrollViewPos](UI控件.md#getscrollviewpos) | <span style="display:inline;color:#7575f9">客户端</span> | 获得当前scroll_view最上方内容的位置 |
| [GetSelectOptionIndex](UI控件.md#getselectoptionindex) | <span style="display:inline;color:#7575f9">客户端</span> | 获得当前选中项的索引，所无选中项则返回-1 |
| [GetSelectOptionShowName](UI控件.md#getselectoptionshowname) | <span style="display:inline;color:#7575f9">客户端</span> | 获得当前选中项的展示文本，所无选中项则返回None |
| [GetSize](UI控件.md#getsize) | <span style="display:inline;color:#7575f9">客户端</span> | 获取控件的大小 |
| [GetSliceCount](UI控件.md#getslicecount) | <span style="display:inline;color:#7575f9">客户端</span> | 获取轮盘可以选择的总切片数量 |
| [GetSliderValue](UI控件.md#getslidervalue) | <span style="display:inline;color:#7575f9">客户端</span> | 获取滑动条的值，失败返回0 |
| [GetText](UI控件.md#gettext) | <span style="display:inline;color:#7575f9">客户端</span> | 获取Label的文本信息，获取失败会返回None |
| [GetTextAlignment](UI控件.md#gettextalignment) | <span style="display:inline;color:#7575f9">客户端</span> | 获取文本控件的文本对齐方式 |
| [GetTextColor](UI控件.md#gettextcolor) | <span style="display:inline;color:#7575f9">客户端</span> | 获取Label文本颜色 |
| [GetTextLinePadding](UI控件.md#gettextlinepadding) | <span style="display:inline;color:#7575f9">客户端</span> | 获取文本控件的行间距 |
| [GetToggleState](UI控件.md#gettogglestate) | <span style="display:inline;color:#7575f9">客户端</span> | 获取Toggle开关控件的状态 |
| [GetUiItem](UI控件.md#getuiitem) | <span style="display:inline;color:#7575f9">客户端</span> | 获取ItemRenderer控件显示的物品，ItemRenderer控件的配置方式详见<a href="../../../../mcguide/18-界面与交互/30-UI说明文档.html#itemrenderer">控件介绍ItemRenderer</a> |
| [GetVisible](UI控件.md#getvisible) | <span style="display:inline;color:#7575f9">客户端</span> | 根据控件路径返回某控件是否已显示 |
| [IsAnimEndCallbackRegistered](UI控件.md#isanimendcallbackregistered) | <span style="display:inline;color:#7575f9">客户端</span> | 控件是否对名称为animName的动画进行了注册回调 |
| [IsTextShadowEnabled](UI控件.md#istextshadowenabled) | <span style="display:inline;color:#7575f9">客户端</span> | 判断文本控件是否显示阴影 |
| [PauseAnimation](UI控件.md#pauseanimation) | <span style="display:inline;color:#7575f9">客户端</span> | 暂停动画，暂停后的动画会停在当前的状态 |
| [PlayAnimation](UI控件.md#playanimation) | <span style="display:inline;color:#7575f9">客户端</span> | 继续播放动画，从动画当前状态开始播放 |
| [RegisterCloseComboBoxCallback](UI控件.md#registerclosecomboboxcallback) | <span style="display:inline;color:#7575f9">客户端</span> | 注册关闭下拉框事件回调 |
| [RegisterOpenComboBoxCallback](UI控件.md#registeropencomboboxcallback) | <span style="display:inline;color:#7575f9">客户端</span> | 注册展开下拉框事件回调 |
| [RegisterSelectItemCallback](UI控件.md#registerselectitemcallback) | <span style="display:inline;color:#7575f9">客户端</span> | 注册选中下拉框内容事件回调 |
| [RemoveAnimEndCallback](UI控件.md#removeanimendcallback) | <span style="display:inline;color:#7575f9">客户端</span> | 移除动画播放结束后的回调 |
| [RemoveAnimation](UI控件.md#removeanimation) | <span style="display:inline;color:#7575f9">客户端</span> | 删除单一属性的动画，删除后的值与当前状态有关，建议删除后重新设置该属性值 |
| [RemoveEntityMarker](UI控件.md#removeentitymarker) | <span style="display:inline;color:#7575f9">客户端</span> | 删除实体位置标记 |
| [RemoveEntityTextMarker](UI控件.md#removeentitytextmarker) | <span style="display:inline;color:#7575f9">客户端</span> | 在小地图上删除实体文本标记 |
| [RemoveOptionByIndex](UI控件.md#removeoptionbyindex) | <span style="display:inline;color:#7575f9">客户端</span> | 根据提供的索引移除对应下拉框项，移除成功则返回True，否则返回False |
| [RemoveOptionByShowName](UI控件.md#removeoptionbyshowname) | <span style="display:inline;color:#7575f9">客户端</span> | 根据提供的展示文本移除对应下拉框项，移除成功则返回True，否则返回False |
| [RemoveStaticMarker](UI控件.md#removestaticmarker) | <span style="display:inline;color:#7575f9">客户端</span> | 删除静态位置标记 |
| [RemoveStaticTextMarker](UI控件.md#removestatictextmarker) | <span style="display:inline;color:#7575f9">客户端</span> | 在小地图上删除静态文本标记 |
| [RenderBlockGeometryModel](UI控件.md#renderblockgeometrymodel) | <span style="display:inline;color:#7575f9">客户端</span> | 渲染网格体模型 |
| [RenderEntity](UI控件.md#renderentity) | <span style="display:inline;color:#7575f9">客户端</span> | 渲染实体 |
| [RenderSkeletonModel](UI控件.md#renderskeletonmodel) | <span style="display:inline;color:#7575f9">客户端</span> | 渲染骨骼模型（不依赖实体） |
| [RepaintMiniMap](UI控件.md#repaintminimap) | <span style="display:inline;color:#7575f9">客户端</span> | 重新绘制小地图 |
| [Rotate](UI控件.md#rotate) | <span style="display:inline;color:#7575f9">客户端</span> | 图片相对自身的旋转锚点进行旋转 |
| [RotateAround](UI控件.md#rotatearound) | <span style="display:inline;color:#7575f9">客户端</span> | 图片相对全局坐标系中某个固定的点进行旋转 |
| [SetAlpha](UI控件.md#setalpha) | <span style="display:inline;color:#7575f9">客户端</span> | 设置节点的透明度，仅对image和label控件生效 |
| [SetAnchorFrom](UI控件.md#setanchorfrom) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件相对于父节点的锚点 |
| [SetAnchorTo](UI控件.md#setanchorto) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件自身锚点位置 |
| [SetAnimEndCallback](UI控件.md#setanimendcallback) | <span style="display:inline;color:#7575f9">客户端</span> | 设置动画播放结束后的回调，每次设置都会覆盖上一次的设置 |
| [SetAnimation](UI控件.md#setanimation) | <span style="display:inline;color:#7575f9">客户端</span> | 给单一属性设置动画，已有重复的会设置失败，需要先remove |
| [SetButtonHoverInCallback](UI控件.md#setbuttonhoverincallback) | <span style="display:inline;color:#7575f9">客户端</span> | 设置鼠标进入按钮时触发的悬浮回调函数 |
| [SetButtonHoverOutCallback](UI控件.md#setbuttonhoveroutcallback) | <span style="display:inline;color:#7575f9">客户端</span> | 设置鼠标退出按钮时触发的悬浮回调函数 |
| [SetButtonScreenExitCallback](UI控件.md#setbuttonscreenexitcallback) | <span style="display:inline;color:#7575f9">客户端</span> | 设置按钮所在画布退出时若鼠标仍未抬起时触发回调函数 |
| [SetButtonTouchCancelCallback](UI控件.md#setbuttontouchcancelcallback) | <span style="display:inline;color:#7575f9">客户端</span> | 设置触控在按钮范围外弹起时触发的回调函数 |
| [SetButtonTouchDownCallback](UI控件.md#setbuttontouchdowncallback) | <span style="display:inline;color:#7575f9">客户端</span> | 设置按钮按下时触发的回调函数 |
| [SetButtonTouchMoveCallback](UI控件.md#setbuttontouchmovecallback) | <span style="display:inline;color:#7575f9">客户端</span> | 设置按下后触控移动时触发的回调函数 |
| [SetButtonTouchMoveInCallback](UI控件.md#setbuttontouchmoveincallback) | <span style="display:inline;color:#7575f9">客户端</span> | 设置按下按钮后进入控件时触发的回调函数 |
| [SetButtonTouchMoveOutCallback](UI控件.md#setbuttontouchmoveoutcallback) | <span style="display:inline;color:#7575f9">客户端</span> | 设置按下按钮后退出控件时触发的回调函数 |
| [SetButtonTouchUpCallback](UI控件.md#setbuttontouchupcallback) | <span style="display:inline;color:#7575f9">客户端</span> | 设置触控在按钮范围内弹起时的回调函数 |
| [SetClipDirection](UI控件.md#setclipdirection) | <span style="display:inline;color:#7575f9">客户端</span> | 设置图片控件的裁剪方向 |
| [SetClipOffset](UI控件.md#setclipoffset) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件的裁剪偏移信息 |
| [SetClipsChildren](UI控件.md#setclipschildren) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件是否开启裁剪内容 |
| [SetCurrentSliceIndex](UI控件.md#setcurrentsliceindex) | <span style="display:inline;color:#7575f9">客户端</span> | 设置轮盘选择的切片 |
| [SetEditText](UI控件.md#setedittext) | <span style="display:inline;color:#7575f9">客户端</span> | 设置edit_box输入框的文本信息 |
| [SetEditTextMaxLength](UI控件.md#setedittextmaxlength) | <span style="display:inline;color:#7575f9">客户端</span> | 设置输入框的最大输入长度 |
| [SetFullPosition](UI控件.md#setfullposition) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件的锚点坐标（全局坐标），支持比例值以及绝对值 |
| [SetFullSize](UI控件.md#setfullsize) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件的大小，支持比例形式以及绝对值 |
| [SetGridDimension](UI控件.md#setgriddimension) | <span style="display:inline;color:#7575f9">客户端</span> | 设置Grid控件的大小 |
| [SetHighestY](UI控件.md#sethighesty) | <span style="display:inline;color:#7575f9">客户端</span> | 设置绘制地图的最大高度 |
| [SetHoverCallback](UI控件.md#sethovercallback) | <span style="display:inline;color:#7575f9">客户端</span> | 设置轮盘选择切片触发回调函数 |
| [SetImageAdaptionType](UI控件.md#setimageadaptiontype) | <span style="display:inline;color:#7575f9">客户端</span> | 设置图片控件的图片适配方式以及信息 |
| [SetIsModal](UI控件.md#setismodal) | <span style="display:inline;color:#7575f9">客户端</span> | 设置当前面板是否为模态框 |
| [SetIsSwallow](UI控件.md#setisswallow) | <span style="display:inline;color:#7575f9">客户端</span> | 设置当前面板输入是否会吞噬事件，isSwallow为Ture时，点击时，点击事件不会穿透到世界。如破坏方块、镜头转向不会被响应 |
| [SetLayer](UI控件.md#setlayer) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件节点的层级，可以通过传入空字符串（""）的方式来调整整个JSON的基础层级 |
| [SetMaxSize](UI控件.md#setmaxsize) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件所允许的最大的大小值 |
| [SetMinSize](UI控件.md#setminsize) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件所允许的最小的大小值 |
| [SetOffsetDelta](UI控件.md#setoffsetdelta) | <span style="display:inline;color:#7575f9">客户端</span> | 设置点击面板的拖拽偏移量 |
| [SetOrientation](UI控件.md#setorientation) | <span style="display:inline;color:#7575f9">客户端</span> | 设置stackPanel的排列方向 |
| [SetPosition](UI控件.md#setposition) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件相对父节点的坐标 |
| [SetPropertyBag](UI控件.md#setpropertybag) | <span style="display:inline;color:#7575f9">客户端</span> | 设置PropertyBag,将使用字典中的每个值来覆盖原本PropertyBag中的值 |
| [SetRotatePivot](UI控件.md#setrotatepivot) | <span style="display:inline;color:#7575f9">客户端</span> | 设置图片自身旋转锚点，该点并不是固定的点，而是相对于自身位置的点 |
| [SetScrollViewPercentValue](UI控件.md#setscrollviewpercentvalue) | <span style="display:inline;color:#7575f9">客户端</span> | 设置当前scroll_view内容的百分比位置 |
| [SetScrollViewPos](UI控件.md#setscrollviewpos) | <span style="display:inline;color:#7575f9">客户端</span> | 设置当前scroll_view内容的位置 |
| [SetSelectOptionByIndex](UI控件.md#setselectoptionbyindex) | <span style="display:inline;color:#7575f9">客户端</span> | 根据提供的索引选中对应下拉框项 |
| [SetSelectOptionByShowName](UI控件.md#setselectoptionbyshowname) | <span style="display:inline;color:#7575f9">客户端</span> | 根据提供的展示文本选中对应下拉框项 |
| [SetSize](UI控件.md#setsize) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件的大小 |
| [SetSliderValue](UI控件.md#setslidervalue) | <span style="display:inline;color:#7575f9">客户端</span> | 设置滑动条的值 |
| [SetSprite](UI控件.md#setsprite) | <span style="display:inline;color:#7575f9">客户端</span> | 给图片控件换指定贴图 |
| [SetSpriteClipRatio](UI控件.md#setspriteclipratio) | <span style="display:inline;color:#7575f9">客户端</span> | 设置图片的裁剪区域比例（不改变控件尺寸）。可以配合image控件的clip_ratio属性控制方向。 |
| [SetSpriteColor](UI控件.md#setspritecolor) | <span style="display:inline;color:#7575f9">客户端</span> | 设置图片颜色 |
| [SetSpriteGray](UI控件.md#setspritegray) | <span style="display:inline;color:#7575f9">客户端</span> | 给图片控件置灰，比直接SetSprite一张灰图片效率要高 |
| [SetSpritePlatformFrame](UI控件.md#setspriteplatformframe) | <span style="display:inline;color:#7575f9">客户端</span> | 设置图片为我的世界移动端启动器当前帐号的头像框 |
| [SetSpritePlatformHead](UI控件.md#setspriteplatformhead) | <span style="display:inline;color:#7575f9">客户端</span> | 设置图片为我的世界移动端启动器当前帐号的头像 |
| [SetSpriteUV](UI控件.md#setspriteuv) | <span style="display:inline;color:#7575f9">客户端</span> | 设置图片的起始uv，与json中的"uv"属性作用一致 |
| [SetSpriteUVSize](UI控件.md#setspriteuvsize) | <span style="display:inline;color:#7575f9">客户端</span> | 设置图片的uv大小，与json中的"uv_size"属性作用一致 |
| [SetText](UI控件.md#settext) | <span style="display:inline;color:#7575f9">客户端</span> | 设置Label的文本信息 |
| [SetTextAlignment](UI控件.md#settextalignment) | <span style="display:inline;color:#7575f9">客户端</span> | 设置文本控件的文本对齐方式 |
| [SetTextColor](UI控件.md#settextcolor) | <span style="display:inline;color:#7575f9">客户端</span> | 设置Label文本的颜色 |
| [SetTextFontSize](UI控件.md#settextfontsize) | <span style="display:inline;color:#7575f9">客户端</span> | 设置Label中文本字体的大小 |
| [SetTextLinePadding](UI控件.md#settextlinepadding) | <span style="display:inline;color:#7575f9">客户端</span> | 设置文本控件的行间距 |
| [SetToggleState](UI控件.md#settogglestate) | <span style="display:inline;color:#7575f9">客户端</span> | 设置Toggle开关控件的值 |
| [SetTouchEnable](UI控件.md#settouchenable) | <span style="display:inline;color:#7575f9">客户端</span> | 设置控件是否可点击交互 |
| [SetTouchUpCallback](UI控件.md#settouchupcallback) | <span style="display:inline;color:#7575f9">客户端</span> | 设置轮盘选择切片并且鼠标按下抬起后触发回调函数 |
| [SetUiItem](UI控件.md#setuiitem) | <span style="display:inline;color:#7575f9">客户端</span> | 设置ItemRenderer控件显示的物品，ItemRenderer控件的配置方式详见<a href="../../../../mcguide/18-界面与交互/30-UI说明文档.html#itemrenderer">控件介绍ItemRenderer</a> |
| [SetValue](UI控件.md#setvalue) | <span style="display:inline;color:#7575f9">客户端</span> | 设置进度条的进度 |
| [SetVisible](UI控件.md#setvisible) | <span style="display:inline;color:#7575f9">客户端</span> | 根据控件路径选择是否显示某控件，可以通过传入空字符串（""）的方式来调整整个JSON的显示/隐藏 |
| [StopAnimation](UI控件.md#stopanimation) | <span style="display:inline;color:#7575f9">客户端</span> | 停止动画，动画将恢复到第一段动画片段的from状态 |
| [ZoomIn](UI控件.md#zoomin) | <span style="display:inline;color:#7575f9">客户端</span> | 放大地图 |
| [ZoomOut](UI控件.md#zoomout) | <span style="display:inline;color:#7575f9">客户端</span> | 缩小地图 |
| [ZoomReset](UI控件.md#zoomreset) | <span style="display:inline;color:#7575f9">客户端</span> | 恢复地图放缩大小为默认值 |
| [asButton](UI控件.md#asbutton) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为ButtonUIControl实例，如当前控件非button类型则返回None |
| [asGrid](UI控件.md#asgrid) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为GridUIControl实例，如当前控件非grid类型则返回None |
| [asImage](UI控件.md#asimage) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为ImageUIControl实例，如当前控件非image类型则返回None |
| [asInputPanel](UI控件.md#asinputpanel) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为InputPanelUIControl实例，如当前控件非inputPanel类型则返回None |
| [asItemRenderer](UI控件.md#asitemrenderer) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为ItemRenderer实例，如当前控件非custom类型则返回None |
| [asLabel](UI控件.md#aslabel) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为LabelUIControl实例，如当前控件非Label类型则返回None |
| [asMiniMap](UI控件.md#asminimap) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为MiniMapUIControl实例，如当前控件非小地图类型则返回None |
| [asNeteaseComboBox](UI控件.md#asneteasecombobox) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为NeteaseComboBoxUIControl实例，如当前控件非panel类型则返回None |
| [asNeteasePaperDoll](UI控件.md#asneteasepaperdoll) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为NeteasePaperDollUIControl实例，如当前控件非custom类型则返回None |
| [asProgressBar](UI控件.md#asprogressbar) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为ProgressBarUIControl实例，如当前控件非panel类型则返回None |
| [asScrollView](UI控件.md#asscrollview) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为ScrollViewUIControl实例，如当前控件非scrollview类型则返回None |
| [asSelectionWheel](UI控件.md#asselectionwheel) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为SelectionWheelUIControl实例，如当前控件非selectionWheel类型则返回None |
| [asSlider](UI控件.md#asslider) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为SliderUIControl实例，如当前控件非滑动条类型则返回None |
| [asStackPanel](UI控件.md#asstackpanel) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为StackPanelUIControl实例，如当前控件非stackPanel类型则返回None |
| [asSwitchToggle](UI控件.md#asswitchtoggle) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为SwitchToggleUIControl实例，如当前控件非panel类型或非toggle则返回None |
| [asTextEditBox](UI控件.md#astexteditbox) | <span style="display:inline;color:#7575f9">客户端</span> | 将当前BaseUIControl转换为TextEditBoxUIControl实例，如当前控件非editbox类型则返回None |
| [resetAnimation](UI控件.md#resetanimation) | <span style="display:inline;color:#7575f9">客户端</span> | 重置该控件的动画 |
Reference in New Issue View Git Blame Copy Permalink