Files

boybook 9a0334ee84 first commit

2025-03-17 13:24:39 +08:00

102 KiB

Raw Blame History

sidebarDepth

sidebarDepth
1

UI控件

BaseUIControl

函数	描述
SetPosition	设置控件相对父节点的坐标
SetFullSize	设置控件的大小，支持比例形式以及绝对值
GetFullSize	获取控件的大小，支持百分比以及绝对值
SetFullPosition	设置控件的锚点坐标（全局坐标），支持比例值以及绝对值
GetFullPosition	获取控件的锚点坐标，支持比例值以及绝对值
SetAnchorFrom	设置控件相对于父节点的锚点
GetAnchorFrom	判断控件相对于父节点的哪个锚点来计算位置与大小
SetAnchorTo	设置控件自身锚点位置
GetAnchorTo	获取控件自身锚点位置信息
SetClipOffset	设置控件的裁剪偏移信息
GetClipOffset	获取控件的裁剪偏移信息
SetClipsChildren	设置控件是否开启裁剪内容
GetClipsChildren	根据控件路径返回某控件是否开启裁剪内容
SetMaxSize	设置控件所允许的最大的大小值
GetMaxSize	获取控件所允许的最大的大小值
SetMinSize	设置控件所允许的最小的大小值
GetMinSize	获取控件所允许的最小的大小值
GetPosition	获取控件相对父节点的坐标
SetSize	设置控件的大小
GetSize	获取控件的大小
SetVisible	根据控件路径选择是否显示某控件，可以通过传入空字符串（""）的方式来调整整个JSON的显示/隐藏
GetVisible	根据控件路径返回某控件是否已显示
SetTouchEnable	设置控件是否可点击交互
SetAlpha	设置节点的透明度，仅对image和label控件生效
SetLayer	设置控件节点的层级，可以通过传入空字符串（""）的方式来调整整个JSON的基础层级
GetChildByName	根据子控件的名称获取BaseUIControl实例
GetChildByPath	根据相对路径获取BaseUIControl实例
resetAnimation	重置该控件的动画
asLabel	将当前BaseUIControl转换为LabelUIControl实例，如当前控件非Label类型则返回None
asButton	将当前BaseUIControl转换为ButtonUIControl实例，如当前控件非button类型则返回None
asImage	将当前BaseUIControl转换为ImageUIControl实例，如当前控件非image类型则返回None
asGrid	将当前BaseUIControl转换为GridUIControl实例，如当前控件非grid类型则返回None
asScrollView	将当前BaseUIControl转换为ScrollViewUIControl实例，如当前控件非scrollview类型则返回None
asSwitchToggle	将当前BaseUIControl转换为SwitchToggleUIControl实例，如当前控件非panel类型或非toggle则返回None
asTextEditBox	将当前BaseUIControl转换为TextEditBoxUIControl实例，如当前控件非editbox类型则返回None
asProgressBar	将当前BaseUIControl转换为ProgressBarUIControl实例，如当前控件非panel类型则返回None
asNeteasePaperDoll	将当前BaseUIControl转换为NeteasePaperDollUIControl实例，如当前控件非custom类型则返回None
asMiniMap	将当前BaseUIControl转换为MiniMapUIControl实例，如当前控件非小地图类型则返回None
asSlider	将当前BaseUIControl转换为SliderUIControl实例，如当前控件非滑动条类型则返回None
asItemRenderer	将当前BaseUIControl转换为ItemRenderer实例，如当前控件非custom类型则返回None
asNeteaseComboBox	将当前BaseUIControl转换为NeteaseComboBoxUIControl实例，如当前控件非panel类型则返回None
asStackPanel	将当前BaseUIControl转换为StackPanelUIControl实例，如当前控件非stackPanel类型则返回None
asInputPanel	将当前BaseUIControl转换为InputPanelUIControl实例，如当前控件非inputPanel类型则返回None

ButtonUIControl

函数	描述
AddTouchEventParams	开启按钮回调功能，不调用该函数则按钮无回调
SetButtonTouchDownCallback	设置按钮按下时触发的回调函数
SetButtonTouchUpCallback	设置触控在按钮范围内弹起时的回调函数
SetButtonTouchCancelCallback	设置触控在按钮范围外弹起时触发的回调函数
SetButtonTouchMoveCallback	设置按下后触控移动时触发的回调函数
SetButtonTouchMoveInCallback	设置按下按钮后进入控件时触发的回调函数
SetButtonTouchMoveOutCallback	设置按下按钮后退出控件时触发的回调函数
SetButtonScreenExitCallback	设置按钮所在画布退出时若鼠标仍未抬起时触发回调函数

GridUIControl

函数	描述
SetGridDimension	设置Grid控件的大小

ImageUIControl

函数	描述
SetSprite	给图片控件换指定贴图
SetSpriteColor	设置图片颜色
SetSpriteGray	给图片控件置灰，比直接SetSprite一张灰图片效率要高
SetSpriteUV	设置图片的起始uv，与json中的"uv"属性作用一致
SetSpriteUVSize	设置图片的uv大小，与json中的"uv_size"属性作用一致
SetSpriteClipRatio	设置图片的裁剪区域比例（不改变控件尺寸）。可以配合image控件的clip_ratio属性控制方向。
SetSpritePlatformHead	设置图片为我的世界移动端启动器当前帐号的头像
SetSpritePlatformFrame	设置图片为我的世界移动端启动器当前帐号的头像框
SetClipDirection	设置图片控件的裁剪方向
GetClipDirection	获取图片控件的裁剪方向
SetImageAdaptionType	设置图片控件的图片适配方式以及信息

InputPanelUIControl

函数	描述
SetIsModal	设置当前面板是否为模态框
GetIsModal	判断当前面板是否为模态框
SetOffsetDelta	设置点击面板的拖拽偏移量
GetOffsetDelta	获得点击面板的拖拽偏移量

ItemRendererUIControl

函数	描述
SetUiItem	设置ItemRenderer控件显示的物品，ItemRenderer控件的配置方式详见控件介绍ItemRenderer

LabelUIControl

函数	描述
SetText	设置Label的文本信息
GetText	获取Label的文本信息，获取失败会返回None
SetTextColor	设置Label文本的颜色
GetTextColor	获取Label文本颜色
SetTextFontSize	设置Label中文本字体的大小
SetTextAlignment	设置文本控件的文本对齐方式
GetTextAlignment	获取文本控件的文本对齐方式
SetTextLinePadding	设置文本控件的行间距
GetTextLinePadding	获取文本控件的行间距
EnableTextShadow	使文本控件显示阴影
DisableTextShadow	关闭文本控件显示阴影
IsTextShadowEnabled	判断文本控件是否显示阴影

MiniMapUIControl

函数	描述
ZoomIn	放大地图
ZoomOut	缩小地图
ZoomReset	恢复地图放缩大小为默认值
SetHighestY	设置绘制地图的最大高度

NeteaseComboBoxUIControl

函数	描述
AddOption	添加下拉框项，若添加成功则返回True，否则返回False
ClearOptions	清空下拉框
ClearSelection	清除当前选中，使下拉框恢复未选中内容状态
GetOptionIndexByShowName	根据展示文本查找对应下拉框项的索引位置，若找不到返回-1
GetOptionShowNameByIndex	根据索引位置查找当前栈式文本，若找不到返回None
GetOptionCount	获得选项数量
GetSelectOptionIndex	获得当前选中项的索引，所无选中项则返回-1
GetSelectOptionShowName	获得当前选中项的展示文本，所无选中项则返回None
RemoveOptionByShowName	根据提供的展示文本移除对应下拉框项，移除成功则返回True，否则返回False
RemoveOptionByIndex	根据提供的索引移除对应下拉框项，移除成功则返回True，否则返回False
SetSelectOptionByIndex	根据提供的索引选中对应下拉框项
SetSelectOptionByShowName	根据提供的展示文本选中对应下拉框项
RegisterOpenComboBoxCallback	注册展开下拉框事件回调
RegisterCloseComboBoxCallback	注册关闭下拉框事件回调
RegisterSelectItemCallback	注册选中下拉框内容事件回调

NeteasePaperDollUIControl

函数	描述
GetModelId	获取渲染的骨骼模型Id
RenderEntity	渲染实体
RenderSkeletonModel	渲染骨骼模型（不依赖实体）
RenderBlockGeometryModel	渲染网格体模型

ProgressBarUIControl

函数	描述
SetValue	设置进度条的进度

ScrollViewUIControl

函数	描述
SetScrollViewPos	设置当前scroll_view内容的位置
GetScrollViewPos	获得当前scroll_view最上方内容的位置
SetScrollViewPercentValue	设置当前scroll_view内容的百分比位置
GetScrollViewContentPath	返回该scroll_view内容的路径
GetScrollViewContentControl	返回该scroll_view内容的BaseUIControl实例

SliderUIControl

函数	描述
GetSliderValue	获取滑动条的值，失败返回0
SetSliderValue	设置滑动条的值

StackPanelUIControl

函数	描述
SetOrientation	设置stackPanel的排列方向
GetOrientation	获取stackPanel的排列方向

SwitchToggleUIControl

函数	描述
SetToggleState	设置Toggle开关控件的值

TextEditBoxUIControl

函数	描述
GetEditText	获取edit_box输入框的文本信息，获取失败会返回None
SetEditText	设置edit_box输入框的文本信息
SetEditTextMaxLength	设置输入框的最大输入长度

BaseUIControl

class in mod.client.ui.controls.baseUIControl

各控件类的基类，包含控件的基础功能接口

SetPosition

描述

设置控件相对父节点的坐标
参数

参数名
数据类型
说明

pos tuple(float,float) 该控件相对父节点的坐标信息，第一项为横轴，第二项为纵轴
返回值

无
示例

参数名	数据类型	说明
pos	tuple(float,float)	该控件相对父节点的坐标信息，第一项为横轴，第二项为纵轴

# we want to set text2 position
text2Path = "/panel/text2"
pos = (10, 10)
baseUIControl = uiNode.GetBaseUIControl(text2Path)
baseUIControl.SetPosition(pos)

SetFullSize

描述

设置控件的大小，支持比例形式以及绝对值

参数

参数名	数据类型	说明
axis	str	设置的轴向，可选的值有["x","y"]，"x"表示设置控件的宽度，"y"表示设置控件的高度
paramDict	dict	设置的参数，具体见备注

返回值

数据类型
说明

bool 设置是否成功

数据类型	说明
bool	设置是否成功

备注

paramDict的键值

参数名	参数类型	解释
"fit"	bool	是否自适应父控件，默认值为False，可以不写该键值
"followType"	str	跟随类型，默认值为"none"，可以不写该键值
"relativeValue"	float	相对于跟随控件的比例值，默认值为0，可以不写该键值
"absoluteValue"	float	设置的绝对值，默认值为0，可以不写该键值

控件的大小支持复杂的计算来实现自适应布局，形式为“absoluteValue + relativeValue * 跟随值”。其中跟随值由跟随的控件以及当前设置的属性共同决定。比如当前设置的是控件的宽度，并且跟随控件为父控件，则跟随值为父控件的宽度。而跟随的控件是特定的，是与控件本身有一定关系的，比如控件的父控件，子控件等，可以通过设置followType的值来指定。

followType可选的值

值	解释
"none"	无跟随，实际计算的时候只考虑absoluteValue
"parent"	跟随控件为父控件
"maxChildren"	跟随控件为最大子控件（设置宽度则为最大宽度，设置高度则为最大高度），relativeValue无论如何设置都为1.0
"maxSibling"	跟随控件为最大兄弟控件（设置宽度则为最大宽度，设置高度则为最大高度），relativeValue无论如何设置都为1.0
"children"	跟随值等于所有子节点之和
"x"	跟随值等于控件本身的宽度，该值仅当 axis == "y" 才生效
"y"	跟随值等于控件本身的高度，该值仅当 axis == "x" 才生效

fit参数用来指定是否自适应父控件，如果是自适应父控件，则absoluteValue，followType，relativeValue参数均会失效，控件的值直接取自父控件的值
设置跟随类型的时候请务必小心，不要造成依赖循环，比如父控件宽度依赖子控件的宽度，而子控件的宽度又依赖于父控件这类情况，这样即使设置成功，结果也是未知的

示例

imagePath = "/panel/image1"
baseUIControl = uiNode.GetBaseUIControl(imagePath)
# 设置image1的宽度为父节点的一半，
ret = baseUIControl.SetFullSize(axis="x", paramDict={"followType":"parent", "relativeValue":0.5})
# 设置image1的高度为所有子节点的高度的2倍并且多20像素
ret = baseUIControl.SetFullSize(axis="y", paramDict={"absoluteValue":20, "followType":"children", "relativeValue":2})
# 设置image1的宽，高为父亲节点的宽，高
ret = baseUIControl.SetFullSize(axis="x", {"fit":True})
ret = baseUIControl.SetFullSize(axis="y", {"fit":True})

GetFullSize

描述

获取控件的大小，支持百分比以及绝对值
参数

参数名
数据类型
说明

axis str 要获取的轴向，可选的值有["x","y"]，"x"表示获取控件的宽度，"y"表示获取控件的高度
返回值

数据类型
说明

dict 控件的大小信息，详见备注
备注
- 参见SetFullSize接口，控件的大小信息描述可由 absoluteValue， followType， relativeValue， fit四个属性描述因此返回值的结构如下：
  
  键值类型
  
  "absoluteValue" float
  
  "followType" str
  
  "relativeValue" float
  
  "fit" bool
示例

参数名	数据类型	说明
axis	str	要获取的轴向，可选的值有["x","y"]，"x"表示获取控件的宽度，"y"表示获取控件的高度

数据类型	说明
dict	控件的大小信息，详见备注

键值	类型
"absoluteValue"	float
"followType"	str
"relativeValue"	float
"fit"	bool

imagePath = "/panel/image1"
baseUIControl = uiNode.GetBaseUIControl(imagePath)
# 获取image1的宽度信息
ret = baseUIControl.GetFullSize(axis="x")

SetFullPosition

描述

设置控件的锚点坐标（全局坐标），支持比例值以及绝对值

参数

参数名	数据类型	说明
axis	str	设置的轴向，可选的值有["x","y"]，"x"表示设置控件锚点的x坐标，"y"表示设置控件锚点的y坐标
paramDict	dict	设置的参数，具体见备注

返回值

数据类型
说明

bool 设置是否成功

数据类型	说明
bool	设置是否成功

备注

paramDict的键值

参数名	参数类型	解释
"followType"	str	跟随类型，默认值为"none"，可以不写该键值
"relativeValue"	float	相对于跟随控件的比例值，默认值为0，可以不写该键值
"absoluteValue"	float	设置的绝对值，默认值为0，可以不写该键值

控件的大小支持复杂的计算来实现自适应布局，形式为“absoluteValue + relativeValue * 跟随值”。其中跟随值由跟随的控件以及当前设置的属性共同决定。比如当前设置的是控件的x坐标，并且跟随控件为父控件，而跟随值为父控件的宽度。而跟随的控件是特定的，是与控件本身有一定关系的，比如控件的父控件，子控件等，可以通过设置followType的值来指定。

followType可选的值

值	解释
"none"	无跟随，实际计算的时候只考虑absoluteValue
"parent"	跟随控件为父控件
"maxChildren"	跟随控件为最大子控件（设置x则为最大宽度，设置y则为最大高度），relativeValue无论如何设置都为1.0
"maxSibling"	跟随控件为最大兄弟控件（设置x则为最大宽度，设置y则为最大高度），relativeValue无论如何设置都为1.0
"children"	跟随值等于所有子节点之和（如果是x则计算的是子节点的宽度之和，如果是y则计算的是子节点的高度之和）
"x"	跟随值等于控件本身的宽度，该值仅当 axis == "y" 才生效
"y"	跟随值等于控件本身的高度，该值仅当 axis == "x" 才生效

设置跟随类型的时候请务必小心，不要造成依赖循环，比如父控件x坐标依赖子控件的宽度，而子控件的宽度又依赖于父控件这类情况，这样即使设置成功，结果也是未知的

示例

imagePath = "/panel/image1"
baseUIControl = uiNode.GetBaseUIControl(imagePath)
# 设置image1的位置在父控件的中间
ret = baseUIControl.SetFullPosition(axis="x", paramDict={"followType":"parent", "relativeValue":0.5})
ret = baseUIControl.SetFullPosition(axis="y", paramDict={"followType":"parent", "relativeValue":0.5})

GetFullPosition

描述

获取控件的锚点坐标，支持比例值以及绝对值
参数

参数名
数据类型
说明

axis str 要获取的轴向，可选的值有["x","y"]，"x"表示获取控件的x坐标，"y"表示获取控件的y坐标
返回值

数据类型
说明

dict 控件的大小信息，详见备注
备注
- 参见SetFullPosition接口，控件的大小信息描述可由 absoluteValue， followType， relativeValue三个属性描述因此返回值的结构如下：
  
  键值类型
  
  "absoluteValue" float
  
  "followType" str
  
  "relativeValue" float
示例

参数名	数据类型	说明
axis	str	要获取的轴向，可选的值有["x","y"]，"x"表示获取控件的x坐标，"y"表示获取控件的y坐标

数据类型	说明
dict	控件的大小信息，详见备注

键值	类型
"absoluteValue"	float
"followType"	str
"relativeValue"	float

imagePath = "/panel/image1"
baseUIControl = uiNode.GetBaseUIControl(imagePath)
# 获取image1的锚点x坐标
ret = baseUIControl.GetFullPosition(axis="x")

SetAnchorFrom

描述

设置控件相对于父节点的锚点
参数

参数名
数据类型
说明

anchorFrom str 相对于父节点的锚点，可选的值详见备注
返回值

数据类型
说明

bool 设置是否成功

参数名	数据类型	说明
anchorFrom	str	相对于父节点的锚点，可选的值详见备注

数据类型	说明
bool	设置是否成功

备注

anchorFrom可选的值

值	解释
"top_left"	相对于父节点的左上角
"top_middle"	相对于父节点的上边中间
"top_right"	相对于父节点的右上角
"left_middle"	相对于父节点的左边中间
"center"	相对于父节点的中间
"right_middle"	相对于父节点的右边中间
"bottom_left"	相对于父节点的底部左边
"bottom_middle"	相对于父节点的部中间
"bottom_right"	相对于父节点的底部右边

示例

# 设置image1控件相对于父节点的左上角
imagePath = "/panel/image1"
anchorFrom = "top_left"
baseUIControl = uiNode.GetBaseUIControl(imagePath)
ret = baseUIControl.SetAnchorFrom(anchorFrom)

GetAnchorFrom

描述

判断控件相对于父节点的哪个锚点来计算位置与大小
参数

无
返回值

数据类型
说明

str 控件计算位置大小所依赖的父节点锚点位置信息，具体返回值的意义可参考SetAnchorFrom接口的备注
示例

数据类型	说明
str	控件计算位置大小所依赖的父节点锚点位置信息，具体返回值的意义可参考SetAnchorFrom接口的备注

# we want to get image1 anchorFrom
imagePath = "/panel/image1"
baseUIControl = uiNode.GetBaseUIControl(imagePath)
anchorFrom = baseUIControl.GetAnchorFrom()

SetAnchorTo

描述

设置控件自身锚点位置
参数

参数名
数据类型
说明

anchorTo str 控件自身锚点位置，可选的值详见备注
返回值

数据类型
说明

bool 设置是否成功

参数名	数据类型	说明
anchorTo	str	控件自身锚点位置，可选的值详见备注

数据类型	说明
bool	设置是否成功

备注

anchorTo可选的值

值	解释
"top_left"	自身锚点位于左上角
"top_middle"	自身锚点位于上边中间
"top_right"	自身锚点位于右上角
"left_middle"	自身锚点位于左边中间
"center"	自身锚点位于中间
"right_middle"	自身锚点位于右边中间
"bottom_left"	自身锚点位于底部左边
"bottom_middle"	自身锚点位于底部中间
"bottom_right"	自身锚点位于底部右边

示例

# 设置image1控件锚点到自身中间
imagePath = "/panel/image1"
anchorTo = "center"
baseUIControl = uiNode.GetBaseUIControl(imagePath)
ret = baseUIControl.SetAnchorTo(anchorTo)

GetAnchorTo

描述

获取控件自身锚点位置信息
参数

无
返回值

数据类型
说明

str 该控件自身锚点位置信息，具体返回值的意义可参考SetAnchorTo接口的备注
示例

数据类型	说明
str	该控件自身锚点位置信息，具体返回值的意义可参考SetAnchorTo接口的备注

# we want to get image1 anchorTo
imagePath = "/panel/image1"
baseUIControl = uiNode.GetBaseUIControl(imagePath)
anchorTo = baseUIControl.GetAnchorTo()

SetClipOffset

描述

设置控件的裁剪偏移信息
参数

参数名
数据类型
说明

clipOffset tuple(float,float) 该控件的裁剪偏移信息，第一项为横轴，第二项为纵轴
返回值

数据类型
说明

bool 设置是否成功
示例

参数名	数据类型	说明
clipOffset	tuple(float,float)	该控件的裁剪偏移信息，第一项为横轴，第二项为纵轴

数据类型	说明
bool	设置是否成功

# we want to set image1 maxSize
imagePath = "/panel/image1"
clipOffset = (20, 20)
baseUIControl = uiNode.GetBaseUIControl(imagePath)
ret = baseUIControl.SetClipOffset(clipOffset)

GetClipOffset

描述

获取控件的裁剪偏移信息
参数

无
返回值

数据类型
说明

tuple(float,float) 该控件的裁剪偏移信息，第一项为横轴，第二项为纵轴
示例

数据类型	说明
tuple(float,float)	该控件的裁剪偏移信息，第一项为横轴，第二项为纵轴

# we want to get image1 clipOffset
imagePath = "/panel/image1"
baseUIControl = uiNode.GetBaseUIControl(imagePath)
clipOffset = baseUIControl.GetClipOffset()

SetClipsChildren

描述

设置控件是否开启裁剪内容
参数

参数名
数据类型
说明

clipsChildren bool True表示开启，False表示关闭
返回值

数据类型
说明

bool 设置是否成功
示例

参数名	数据类型	说明
clipsChildren	bool	True表示开启，False表示关闭

数据类型	说明
bool	设置是否成功

# we want to enable image1 clipsChildren
imagePath = "/panel/image1"
baseUIControl = uiNode.GetBaseUIControl(imagePath)
ret = baseUIControl.SetClipsChildren(True)

GetClipsChildren

描述

根据控件路径返回某控件是否开启裁剪内容
参数

无
返回值

数据类型
说明

bool 该控件是否已开启裁剪内容
示例

数据类型	说明
bool	该控件是否已开启裁剪内容

# we want to know whether image1 enables clipsChildren
imagePath = "/panel/image1"
baseUIControl = uiNode.GetBaseUIControl(imagePath)
clipsChildrenEnabled = baseUIControl.GetClipsChildren()

SetMaxSize

描述

设置控件所允许的最大的大小值
参数

参数名
数据类型
说明

maxSize tuple(float,float) 该控件所允许的最大的大小值，第一项为横轴，第二项为纵轴
返回值

数据类型
说明

bool 设置是否成功
备注
- maxSize = (0, 0)表示无限制
示例

参数名	数据类型	说明
maxSize	tuple(float,float)	该控件所允许的最大的大小值，第一项为横轴，第二项为纵轴

数据类型	说明
bool	设置是否成功

# we want to set image1 maxSize
imagePath = "/panel/image1"
imageMaxSize = (10, 10)
baseUIControl = uiNode.GetBaseUIControl(imagePath)
ret = baseUIControl.SetMaxSize(imageMaxSize)

GetMaxSize

描述

获取控件所允许的最大的大小值
参数

无
返回值

数据类型
说明

tuple(float,float) 该控件所允许的最大的大小值，第一项为横轴，第二项为纵轴
备注
- 返回值为(0, 0)表示无限制
示例

数据类型	说明
tuple(float,float)	该控件所允许的最大的大小值，第一项为横轴，第二项为纵轴

# we want to get image1 maxSize
imagePath = "/panel/image1"
baseUIControl = uiNode.GetBaseUIControl(imagePath)
imageMaxSize = baseUIControl.GetMaxSize()

SetMinSize

描述

设置控件所允许的最小的大小值
参数

参数名
数据类型
说明

minSize tuple(float,float) 该控件所允许的大小值，第一项为横轴，第二项为纵轴
返回值

数据类型
说明

bool 设置是否成功
备注
- minSize = (0, 0)表示无限制
示例

参数名	数据类型	说明
minSize	tuple(float,float)	该控件所允许的大小值，第一项为横轴，第二项为纵轴

# we want to set image1 minSize
imagePath = "/panel/image1"
imageMinSize = (10, 10)
baseUIControl = uiNode.GetBaseUIControl(imagePath)
ret = baseUIControl.SetMinSize(imageMinSize)

GetMinSize

描述

获取控件所允许的最小的大小值
参数

无
返回值

数据类型
说明

tuple(float,float) 该控件所允许的最小的大小值，第一项为横轴，第二项为纵轴
备注
- 返回值为(0, 0)表示无限制
示例

# we want to get image1 minSize
imagePath = "/panel/image1"
baseUIControl = uiNode.GetBaseUIControl(imagePath)
imageMinSize = baseUIControl.GetMinSize()

GetPosition

描述

获取控件相对父节点的坐标
参数

无
返回值

数据类型
说明

tuple(float,float) 该控件相对父节点的坐标信息，第一项为横轴，第二项为纵轴
示例

# we want to get text2 position
text2Path = "/panel/text2"
baseUIControl = uiNode.GetBaseUIControl(text2Path)
textPosition = baseUIControl.GetPosition()

SetSize

描述

设置控件的大小

参数

参数名	数据类型	说明
size	tuple(float,float)	该控件的大小信息，第一项为横轴，第二项为纵轴
resizeChildren	bool	是否同时调整子控件尺寸，默认为False

返回值

无
示例

# we want to set text2 size
text2Path = "/panel/text2"
text2Size = (10, 10)
baseUIControl = uiNode.GetBaseUIControl(text2Path)
baseUIControl.SetSize(text2Size)

GetSize

描述

获取控件的大小
参数

无
返回值

数据类型
说明

tuple(float,float) 该控件的大小信息，第一项为横轴，第二项为纵轴
示例

# we want to get text2 size
text2Path = "/panel/text2"
baseUIControl = uiNode.GetBaseUIControl(text2Path)
text2Size = baseUIControl.GetSize()

SetVisible

描述

根据控件路径选择是否显示某控件，可以通过传入空字符串（""）的方式来调整整个JSON的显示/隐藏

参数

参数名	数据类型	说明
visible	bool	False为隐藏该控件，True为显示该控件
forceUpdtae	bool	是否需要强制刷新，默认值为True。置True则按照马上进行刷新，新的visible状态生效。置False，则需要再次调用UpdateScreen使新状态生效。如有大量SetVisible操作且非在同一帧执行，建议设置为False,需要更新时再调用UpdateScreen接口刷新界面及相关控件数据

返回值

无
备注
- 特殊情况说明：当该接口的调用来自滚动列表内容控件中的按钮回调，且调用目的是隐藏滚动列表控件或其父节点控件时，将forceUpdate参数置True会导致滚动列表数据异常。若没有刷新界面的必要请将forceUpdate参数置False，若有请使用定时器延迟执行手动UpdateScreen接口。
示例

# 隐藏panel的子控件text2
text2Path = "/panel/text2"
baseUIControl = uiNode.GetBaseUIControl(text2Path)
baseUIControl.SetVisible(False)
# 在非同一帧，隐藏panel的子控件text1, text2, text3
parentPath = "/panel"
textPrefabPath = "/panel/text_prefab"
def _tickSetVisible(pathName):
    baseUIControl = uiNode.GetBaseUIControl(pathName)
    baseUIControl.SetVisible(False, False)
def _tickUpdateScreen():
    uiNode.UpdateScreen(True)
comp = clientApi.GetEngineCompFactory().CreateGame(levelId)
comp.AddTimer(100, _tickSetVisible, "/panel/text1")
comp.AddTimer(200, _tickSetVisible, "/panel/text2")
comp.AddTimer(300, _tickSetVisible, "/panel/text3")
comp.AddTimer(300, _tickUpdateScreen)

GetVisible

描述

根据控件路径返回某控件是否已显示
参数

无
返回值

数据类型
说明

bool 该控件是否已显示
示例

# 我们获得panel下面的text2是否显示
text2Path = "/panel/text2"
baseUIControl = uiNode.GetBaseUIControl(text2Path)
textVisible = baseUIControl.GetVisible()

SetTouchEnable

描述

设置控件是否可点击交互
参数

参数名
数据类型
说明

enable bool False为不响应，True为恢复响应
返回值

无
示例

# we want to set image_button unable
imageButtonPath = "/image_button"
baseUIControl = uiNode.GetBaseUIControl(imageButtonPath)
baseUIControl.SetTouchEnable(False)

SetAlpha

描述

设置节点的透明度，仅对image和label控件生效
参数

参数名
数据类型
说明

alpha float 透明度，取值0-1之间，0表示完全透明，1表示完全不透明
返回值

无
示例

# 设置text2的透明度为半透明
text2Path = "/panel/text2"
baseUIControl = uiNode.GetBaseUIControl(text2Path)
baseUIControl.SetAlpha(0.5)

SetLayer

描述

设置控件节点的层级，可以通过传入空字符串（""）的方式来调整整个JSON的基础层级

参数

参数名	数据类型	说明
layer	int	设置层级
syncRefresh	bool	是否需要同步刷新，默认值为True。置True为游戏在同一帧根据该控件的层级进行相关计算，置False则在下一帧进行计算。如同一帧有大量SetLayer操作建议置False，操作结束后调用一次ScreenNode.UpdateScreen接口刷新界面及相关控件数据
forceUpdtae	bool	是否需要强制刷新，默认值为True。置True则按照syncRefresh逻辑进行同步或者下一帧刷新，置False则当前帧和下一帧均不刷新，需要手动调用UpdateScreen进行刷新。如有大量SetLayer操作且非在同一帧执行，建议设置为False,需要更新时再调用UpdateScreen接口刷新界面及相关控件数据

返回值

无
示例

# 设置text2的控件的层级
text2Path = "/panel/text2"
baseUIControl = uiNode.GetBaseUIControl(text2Path)
baseUIControl.SetLayer(2)
# 同一帧设置若干控件的层级
text1Path = "/panel/text1"
uiNode.GetBaseUIControl(text1Path).SetLayer(1,False)
text2Path = "/panel/text2"
uiNode.GetBaseUIControl(text2Path).SetLayer(2,False)
text3Path = "/panel/text3"
uiNode.GetBaseUIControl(text3Path).SetLayer(3,False)
# 不同帧设置若干控件的层级
def _setLyerText1(path, layer):
    uiNode.GetBaseUIControl(text1Path).SetLayer(1,False,False)
def _updateScreen():
    uiNode.UpdateScreen(True)
comp = clientApi.GetEngineCompFactory().CreateGame(levelId)
comp.AddTimer(100, _setLyerText1, "/panel/text1", 1)
comp.AddTimer(200, _setLyerText1, "/panel/text2", 2)
comp.AddTimer(300, _setLyerText1, "/panel/text3", 3)
comp.AddTimer(300, _updateScreen)

GetChildByName

描述

根据子控件的名称获取BaseUIControl实例
参数

参数名
数据类型
说明

childName str 子节点名称
返回值

数据类型
说明

BaseUIControl 子控件的BaseUIControl实例
示例

# text1的BaseUIControl实例获得text2的BaseUIControl实例
text1Path = "/text1"
text1Control = uiNode.GetBaseUIControl(text1Path)
text2Control = text1Control.GetChildByName("text2")

GetChildByPath

描述

根据相对路径获取BaseUIControl实例
参数

参数名
数据类型
说明

childPath str 相对当前BaseUIControl路径的路径
返回值

数据类型
说明

BaseUIControl 子控件的BaseUIControl实例
示例

# 根据路径"/text1"的BaseUIControl实例获得路径为"/text1/text2/text3"的BaseUIControl实例
text1Path = "/text1"
text1Control = uiNode.GetBaseUIControl(text1Path)
text3Control = text1Control.GetChildByPath("/text2/text3")

resetAnimation

描述

重置该控件的动画
参数

无
返回值

无
备注
- UI属性动画相关，详见属性动画
示例

# 重置/text1控件上的属性动画
text1Path = "/text1"
text1Control = uiNode.GetBaseUIControl(text1Path)
text1Control.resetAnimation()

asLabel

描述

将当前BaseUIControl转换为LabelUIControl实例，如当前控件非Label类型则返回None
参数

无
返回值

数据类型
说明

LabelUIControl LabelUIControl实例
示例

text1Path = "/text1"
text1BaseControl = uiNode.GetBaseUIControl(text1Path)
text1LabelControl = text1BaseControl.asLabel()

asButton

描述

将当前BaseUIControl转换为ButtonUIControl实例，如当前控件非button类型则返回None
参数

无
返回值

数据类型
说明

ButtonUIControl ButtonUIControl实例
示例

buttonPath = "/button"
buttonBaseControl = uiNode.GetBaseUIControl(buttonPath)
buttonControl = buttonBaseControl.asButton()

asImage

描述

将当前BaseUIControl转换为ImageUIControl实例，如当前控件非image类型则返回None
参数

无
返回值

数据类型
说明

ImageUIControl ImageUIControl实例
示例

imagePath = "/image"
imageBaseControl = uiNode.GetBaseUIControl(imagePath)
imageControl = imageBaseControl.asImage()

asGrid

描述

将当前BaseUIControl转换为GridUIControl实例，如当前控件非grid类型则返回None
参数

无
返回值

数据类型
说明

GridUIControl GridUIControl实例
示例

gridPath = "/grid"
gridBaseControl = uiNode.GetBaseUIControl(gridPath)
gridControl = gridBaseControl.asGrid()

asScrollView

描述

将当前BaseUIControl转换为ScrollViewUIControl实例，如当前控件非scrollview类型则返回None
参数

无
返回值

数据类型
说明

ScrollViewUIControl ScrollViewUIControl实例
示例

scrollViewPath = "/scroll_view"
scrollViewBaseControl = uiNode.GetBaseUIControl(scrollViewPath)
scrollViewControl = scrollviewBaseControl.asScrollView()

asSwitchToggle

描述

将当前BaseUIControl转换为SwitchToggleUIControl实例，如当前控件非panel类型或非toggle则返回None
参数

无
返回值

数据类型
说明

SwitchToggleUIControl SwitchToggleUIControl实例
示例

switchTogglePath = "/switch_toggle"
switchToggleBaseControl = uiNode.GetBaseUIControl(switchTogglePath)
switchToggleControl = switchToggleBaseControl.asSwitchToggle()

asTextEditBox

描述

将当前BaseUIControl转换为TextEditBoxUIControl实例，如当前控件非editbox类型则返回None
参数

无
返回值

数据类型
说明

TextEditBoxUIControl TextEditBoxUIControl实例
示例

textEditBoxPath = "/text_edit_box"
textEditBoxBaseControl = uiNode.GetBaseUIControl(textEditBoxPath)
textEditBoxControl = textEditBoxBaseControl.asTextEditBox()

asProgressBar

描述

将当前BaseUIControl转换为ProgressBarUIControl实例，如当前控件非panel类型则返回None
参数

参数名
数据类型
说明

fillImagePath str 进度条填充图片路径，默认为"/filled_progress_bar",该参数影响该控件API的效果
返回值

数据类型
说明

ProgressBarUIControl ProgressBarUIControl实例
示例

progressBarPath = "/progress_bar"
progressBarBaseControl = uiNode.GetBaseUIControl(progressBarPath)
progressBarControl = progressBarBaseControl.asProgressBar()

asNeteasePaperDoll

描述

将当前BaseUIControl转换为NeteasePaperDollUIControl实例，如当前控件非custom类型则返回None
参数

无
返回值

数据类型
说明

NeteasePaperDollUIControl NeteasePaperDollUIControl实例
示例

paperDollPath = "/paper_doll"
paperDollBaseControl = uiNode.GetBaseUIControl(paperDollPath)
paperDollControl = paperDollBaseControl.asNeteasePaperDoll()

asMiniMap

描述

将当前BaseUIControl转换为MiniMapUIControl实例，如当前控件非小地图类型则返回None
参数

无
返回值

数据类型
说明

MiniMapUIControl MiniMapUIControl实例
示例

path = "/mini_map"
miniMapBaseControl = uiNode.GetBaseUIControl(path)
miniMapControl = miniMapBaseControl.asMiniMap()

asSlider

描述

将当前BaseUIControl转换为SliderUIControl实例，如当前控件非滑动条类型则返回None
参数

无
返回值

数据类型
说明

SliderUIControl SliderUIControl
示例

path = "/slider0"
sliderBaseControl = uiNode.GetBaseUIControl(path)
sliderControl = sliderBaseControl.asSlider()

asItemRenderer

描述

将当前BaseUIControl转换为ItemRenderer实例，如当前控件非custom类型则返回None
参数

无
返回值

数据类型
说明

ItemRendererUIControl ItemRendererUIControl实例
示例

itemRendererPath = "/item_renderer"
itemRendererBaseControl = uiNode.GetBaseUIControl(itemRendererPath)
itemRendererControl = itemRendererBaseControl.asItemRenderer()

asNeteaseComboBox

描述

将当前BaseUIControl转换为NeteaseComboBoxUIControl实例，如当前控件非panel类型则返回None
参数

无
返回值

数据类型
说明

NeteaseComboBoxUIControl NeteaseComboBoxUIControl实例
示例

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()

asStackPanel

描述

将当前BaseUIControl转换为StackPanelUIControl实例，如当前控件非stackPanel类型则返回None
参数

无
返回值

数据类型
说明

StackPanelUIControl StackPanelUIControl实例
示例

stackPanelPath = "/stackPanel"
stackPanelUIControl = uiNode.GetBaseUIControl(stackPanelPath).asStackPanel()

asInputPanel

描述

将当前BaseUIControl转换为InputPanelUIControl实例，如当前控件非inputPanel类型则返回None
参数

无
返回值

数据类型
说明

InputPanelUIControl InputPanelUIControl实例
示例

inputPanelPath = "/inputPanel"
inputPanelUIControl = uiNode.GetBaseUIControl(inputPanelPath).asInputPanel()

ButtonUIControl

class in mod.client.ui.controls.buttonUIControl

按钮控件类，继承自BaseUIControl，除基础功能接口外包含按钮相关功能接口

AddTouchEventParams

描述

开启按钮回调功能，不调用该函数则按钮无回调
参数

参数名
数据类型
说明

args dict 默认为None，详细说明请见备注。
返回值

无

备注

AddTouchEventParams参数args说明：

关键字	数据类型	说明
isSwallow	bool	默认为True, 按钮是否吞噬事件；或为Ture时，点击按钮时，点击事件不会穿透到世界。如破坏方块、镜头转向不会被响应

示例

buttonPath = "/panel/test_btn"
buttonUIControl = uiNode.GetBaseUIControl("/panel/test_btn").asButton()
buttonUIControl.AddTouchEventParams({"isSwallow":True})

SetButtonTouchDownCallback

描述

设置按钮按下时触发的回调函数
参数

参数名
数据类型
说明

callbackFunc function 回调函数，必须是UI的类函数
返回值

无

备注

onButtonTouchDownCallback参数args说明：

参数	类型	解释
#collection_name	str	按钮所属的集合名称
#collection_index	int	按钮在集合所属的集合序号
ButtonState	int	按钮的状态：Up为0，Down为1，默认是-1，建议使用New
TouchEvent	int	按钮的状态新版本：Up为0，Down为1，Cancel为3，Move为4，默认是-1
PrevButtonDownID	str	上一个被点击Down的按钮的ID，如果没有取值为"-1"
TouchPosX	float	按钮被点击时屏幕上的UI坐标X值
TouchPosY	float	按钮被点击时屏幕上的UI坐标Y值
ButtonPath	str	被点击的按钮的ComponentPath
AddTouchEventParams	dict	在调用AddTouchEventParams接口时传入的参数字典

事件之间的关系如下图所示：

示例

def onButtonTouchDownCallback(args):
    pass

buttonPath = "/panel/test_btn"
buttonUIControl = uiNode.GetBaseUIControl("/panel/test_btn").asButton()
buttonUIControl.AddTouchEventParams({"isSwallow":True})
buttonUIControl.SetButtonTouchDownCallback(onButtonTouchDownCallback)

SetButtonTouchUpCallback

描述

设置触控在按钮范围内弹起时的回调函数
参数

参数名
数据类型
说明

callbackFunc function 回调函数，必须是UI的类函数
返回值

无
备注
- 其他相关说明见SetButtonTouchDownCallback接口：
示例

def onButtonTouchUpCallback(args):
    pass

buttonPath = "/panel/test_btn"
buttonUIControl = uiNode.GetBaseUIControl("/panel/test_btn").asButton()
buttonUIControl.AddTouchEventParams({"isSwallow":True})
buttonUIControl.SetButtonTouchUpCallback(onButtonTouchUpCallback)

SetButtonTouchCancelCallback

描述

设置触控在按钮范围外弹起时触发的回调函数
参数

参数名
数据类型
说明

callbackFunc function 回调函数，必须是UI的类函数
返回值

无
备注
- 其他相关说明见SetButtonTouchDownCallback接口：
示例

def onButtonTouchCancelCallback(args):
    pass

buttonPath = "/panel/test_btn"
buttonUIControl = uiNode.GetBaseUIControl("/panel/test_btn").asButton()
buttonUIControl.AddTouchEventParams({"isSwallow":True})
buttonUIControl.SetButtonTouchCancelCallback(onButtonTouchCancelCallback)

SetButtonTouchMoveCallback

描述

设置按下后触控移动时触发的回调函数
参数

参数名
数据类型
说明

callbackFunc function 回调函数，必须是UI的类函数
返回值

无
备注
- 其他相关说明见SetButtonTouchDownCallback接口：
示例

def onButtonTouchMoveCallback(args):
    pass

buttonPath = "/panel/test_btn"
buttonUIControl = uiNode.GetBaseUIControl("/panel/test_btn").asButton()
buttonUIControl.AddTouchEventParams({"isSwallow":True})
buttonUIControl.SetButtonTouchMoveCallback(onButtonTouchMoveCallback)

SetButtonTouchMoveInCallback

描述

设置按下按钮后进入控件时触发的回调函数
参数

参数名
数据类型
说明

callbackFunc function 回调函数，必须是UI的类函数
返回值

无
备注
- 其他相关说明见SetButtonTouchDownCallback接口：
示例

def onButtonTouchMoveInCallback(args):
    pass

buttonPath = "/panel/test_btn"
buttonUIControl = uiNode.GetBaseUIControl("/panel/test_btn").asButton()
buttonUIControl.AddTouchEventParams({"isSwallow":True})
buttonUIControl.SetButtonTouchMoveInCallback(onButtonTouchMoveInCallback)

SetButtonTouchMoveOutCallback

描述

设置按下按钮后退出控件时触发的回调函数
参数

参数名
数据类型
说明

callbackFunc function 回调函数，必须是UI的类函数
返回值

无
备注
- 其他相关说明见SetButtonTouchDownCallback接口：
示例

def onButtonTouchMoveOutCallback(args):
    pass

buttonPath = "/panel/test_btn"
buttonUIControl = uiNode.GetBaseUIControl("/panel/test_btn").asButton()
buttonUIControl.AddTouchEventParams({"isSwallow":True})
buttonUIControl.SetButtonTouchMoveOutCallback(onButtonTouchMoveOutCallback)

SetButtonScreenExitCallback

描述

设置按钮所在画布退出时若鼠标仍未抬起时触发回调函数
参数

参数名
数据类型
说明

callbackFunc function 回调函数，必须是UI的类函数
返回值

无
备注
- 其他相关说明见SetButtonTouchDownCallback接口：
示例

def onButtonScreenExitCallback(args):
    pass

buttonPath = "/panel/test_btn"
buttonUIControl = uiNode.GetBaseUIControl("/panel/test_btn").asButton()
buttonUIControl.AddTouchEventParams({"isSwallow":True})
buttonUIControl.SetButtonScreenExitCallback(onButtonScreenExitCallback)

GridUIControl

class in mod.client.ui.controls.gridUIControl

网格控件类，继承自BaseUIControl，除基础功能接口外包含网格相关功能接口

SetGridDimension

描述

设置Grid控件的大小
参数

参数名
数据类型
说明

dimension tuple(int,int) 设置网格的横向与纵向大小
返回值

无
示例

# we want change grid dimension
gridPath = "/grid1"
gridUIControl = uiNode.GetBaseUIControl(gridPath).asGrid()
gridUIControl.SetGridDimension((2, 2))

ImageUIControl

class in mod.client.ui.controls.imageUIControl

图片控件类，继承自BaseUIControl，除基础功能接口外包含图片相关功能接口

SetSprite

描述

给图片控件换指定贴图
参数

参数名
数据类型
说明

texturePath str 贴图的路径，需要从resource_pack下面的textures目录开始
返回值

无
备注
- 给ImageButton换贴图的时候注意使用子控件路径(default / hover / pressed)获得ImageUIControl
示例

# we want to set image_button textures
imageButtonPath = "/image_button"
buttonUIControl = uiNode.GetBaseUIControl(imageButtonPath).asButton()
buttonDefaultUIControl = buttonUIControl.GetChildByName("default").asImage()
buttonHoverUIControl = buttonUIControl.GetChildByName("hover").asImage()
buttonPressedUIControl = buttonUIControl.GetChildByName("pressed").asImage()
buttonDefaultUIControl.SetSprite("textures/button01_default")
buttonHoverUIControl.SetSprite("textures/button01_hover")
buttonPressedUIControl.SetSprite("textures/button01_pressed")

SetSpriteColor

描述

设置图片颜色
参数

参数名
数据类型
说明

color tuple(float,float,float) 图片颜色rgb，取值[0, 1]
返回值

无
示例

# 我们想对耐久度条随耐久度变化颜色，满的时候为绿色，空的时候为红色，其中barPath为耐久度条路径
durabilityRatio = 0.8  # 耐久度比例，1为满耐久
barPath = "/image_bar"
imageUIControl = uiNode.GetBaseUIControl(barPath).asImage()
imageUIControl.SetSpriteColor((1 - durabilityRatio, durabilityRatio, 0))

SetSpriteGray

描述

给图片控件置灰，比直接SetSprite一张灰图片效率要高
参数

参数名
数据类型
说明

gray bool True为将图片置灰，False为恢复原色
返回值

无
示例

# we want set image gray
imagePath = "/image"
imageUIControl = uiNode.GetBaseUIControl(imagePath).asImage()
imageUIControl.SetSpriteGray(True)

SetSpriteUV

描述

设置图片的起始uv，与json中的"uv"属性作用一致
参数

参数名
数据类型
说明

uv tuple(float,float) 图片的左上角为(0,0)，向右为x轴，向下为y轴
返回值

无
示例

imagePath = "/image"
imageUIControl = uiNode.GetBaseUIControl(imagePath).asImage()
imageUIControl.SetSpriteUV((10, 0))

SetSpriteUVSize

描述

设置图片的uv大小，与json中的"uv_size"属性作用一致
参数

参数名
数据类型
说明

uvSize tuple(float,float) 图片向右为x轴，向下为y轴
返回值

无
示例

imagePath = "/image"
imageUIControl = uiNode.GetBaseUIControl(imagePath).asImage()
imageUIControl.SetSpriteUVSize((40, 30))

SetSpriteClipRatio

描述

设置图片的裁剪区域比例（不改变控件尺寸）。可以配合image控件的clip_ratio属性控制方向。
参数

参数名
数据类型
说明

clipRatio float 图片的裁剪比例（范围0到1），裁剪精度与图片分辨率相关
返回值

无
示例

# 我们想对UI编辑器创建的进度条设置进度
# 编辑器进度条包含两个image控件（名为empty_progress_bar和filled_progress_bar）
progress = 0.8  # 用于模拟进度时，下面的裁剪比例需设为(1-进度)，才能得到正确的视觉效果
imagePath = "/progress_bar0/filled_progress_bar"
imageUIControl = uiNode.GetBaseUIControl(imagePath).asImage()
imageUIControl.SetSpriteClipRatio(1.0 - progress)

SetSpritePlatformHead

描述

设置图片为我的世界移动端启动器当前帐号的头像
参数

无
返回值

无
备注
- 该接口仅支持移动端调用，其他平台该接口无效：
示例

# 我们想将当前图片控件设置为我的世界移动端启动器当前帐号的头像
imagePath = "/image"
imageUIControl = uiNode.GetBaseUIControl(imagePath).asImage()
imageUIControl.SetSpritePlatformHead()

SetSpritePlatformFrame

描述

设置图片为我的世界移动端启动器当前帐号的头像框
参数

无
返回值

无
备注
- 该接口仅支持移动端调用，其他平台该接口无效：
- 当我的世界移动端启动器账号的头像框是动态头像框时，该头像框图片将无法被加载，该问题将在下个版本修复：
示例

# 我们想将当前图片控件设置为我的世界移动端启动器当前帐号的头像框
imagePath = "/image"
imageUIControl = uiNode.GetBaseUIControl(imagePath).asImage()
imageUIControl.SetSpritePlatformFrame()

SetClipDirection

描述

设置图片控件的裁剪方向
参数

参数名
数据类型
说明

clipDirection str 图片控件的裁剪方向，可选的值详见备注
返回值

数据类型
说明

bool 设置是否成功
备注
- clipDirection可选的值
  
  值解释
  
  "fromLeftToRight" 从左到右
  
  "fromRightToLeft" 从右到左
  
  "fromOutsideToInside" 从外到内
  
  "fromTopToBottom" 从上到下
  
  "fromBottomToTop" 从下到上
示例

imagePath = "/image"
imageUIControl = uiNode.GetBaseUIControl(imagePath).asImage()
clipDirection = "fromOutsideToInside"
ret = imageUIControl.SetClipDirection(clipDirection)

GetClipDirection

描述

获取图片控件的裁剪方向
参数

无
返回值

数据类型
说明

str 图片控件的裁剪方向，返回值的意义可见SetClipDirection接口的备注
示例

imagePath = "/image"
imageUIControl = uiNode.GetBaseUIControl(imagePath).asImage()
imageUIControl.GetClipDirection()

SetImageAdaptionType

描述

设置图片控件的图片适配方式以及信息

参数

参数名	数据类型	说明
imageAdaptionType	str	图片控件的图片适配方式，可选的值详见备注
imageAdaptionData	tuple(float,float,float,float)	如果图片不是九宫适配方式，无需传该值，否则需要设置，tuple的每个值分别代表九宫格切割的四个参数：左，右，上，下

返回值

数据类型
说明

bool 设置是否成功

备注

imageAdaptionType可选的值如下

值	解释
"normal"	普通适配，不开启九宫并保持宽高比
"filled"	填充适配，不开启九宫并保持宽高比
"oldNineSlice"	旧版九宫格适配
"originNineSlice"	原版九宫格适配

示例

imagePath = "/image"
imageUIControl = uiNode.GetBaseUIControl(imagePath).asImage()
# 普通适配
ret = imageUIControl.SetImageAdaptionType("normal")
# 原版九公格适配，并设置边距
ret = imageUIControl.SetImageAdaptionType("originNineSlice", (0, 0, 0, 0))

InputPanelUIControl

class in mod.client.ui.controls.inputPanelUIControl

布局面板控件类，继承自BaseUIControl，除基础功能接口外包含文本相关功能接口

SetIsModal

描述

设置当前面板是否为模态框
参数

参数名
数据类型
说明

isModal bool 当前面板是否为模态框
返回值

数据类型
说明

bool 设置是否成功
示例

# we want to set inputPanel1 isModal
inputPanelPath = "/inputPanel1"
inputPanel = uiNode.GetBaseUIControl(inputPanelPath).asInputPanel()
ret = inputPanel.SetIsModal(True)

GetIsModal

描述

判断当前面板是否为模态框
参数

无
返回值

数据类型
说明

bool 当前面板是否为模态框
示例

# we want to know whether inputPanel1 isModal
inputPanelPath = "/inputPanel1"
inputPanel = uiNode.GetBaseUIControl(inputPanelPath).asInputPanel()
inputPanel.GetIsModal()

SetOffsetDelta

描述

设置点击面板的拖拽偏移量
参数

参数名
数据类型
说明

offset_delta tuple(float,float) 该控件的拖拽偏移量，第一项为横轴，第二项为纵轴
返回值

数据类型
说明

bool 是否设置成功
备注
- 点击面板拖拽功能及拖拽偏移量相关，详见InputPanel
示例

# we want to set inputPanel's offset_delta
inputPanelPath = "/inputPanel1"
inputPanel = uiNode.GetBaseUIControl(inputPanelPath).asInputPanel()
success = inputPanel.SetOffsetDelta((100, 100))

GetOffsetDelta

描述

获得点击面板的拖拽偏移量
参数

无
返回值

数据类型
说明

tuple(float,float) 该控件的拖拽偏移量，第一项为横轴，第二项为纵轴
备注
- 点击面板拖拽功能及拖拽偏移量相关，详见InputPanel
示例

# we want to get inputPanel1's offset_delta
inputPanelPath = "/inputPanel1"
inputPanel = uiNode.GetBaseUIControl(inputPanelPath).asInputPanel()
offset_delta = inputPanel.GetOffsetDelta()

ItemRendererUIControl

class in mod.client.ui.controls.itemRendererUIControl

物品渲染控件类，继承自BaseUIControl，除基础功能接口外包含物品渲染控件相关功能接口

SetUiItem

描述

设置ItemRenderer控件显示的物品，ItemRenderer控件的配置方式详见控件介绍ItemRenderer

参数

参数名	数据类型	说明
itemName	str	物品identifier
auxValue	int	物品附加值
isEnchanted	bool	可选参数，是否显示附魔效果，默认为False不显示
userData	dict	可选参数，如果是灾厄旗帜或焰火之星等带有userData的需要传入该参数才能正确显示，目前已知仅有灾厄旗帜和焰火之星需要传

返回值

数据类型
说明

bool 是否设置结果，True为成功
示例

#设置显示为木板block
itemRenderPath = "/panel/item_renderer"
itemName = "minecraft:wool"
auxValue = 0
itemRendererBaseControl = uiNode.GetBaseUIControl(itemRenderPath)
itemRendererControl = itemRendererBaseControl.asItemRenderer()
itemRendererControl.SetUiItem(itemName, auxValue)

LabelUIControl

class in mod.client.ui.controls.labelUIControl

文本控件类，继承自BaseUIControl，除基础功能接口外包含文本相关功能接口

SetText

描述

设置Label的文本信息

参数

参数名	数据类型	说明
text	str	文本的内容，可以支持样式代码（§可以设置文字的颜色、格式等，该种用法更加灵活多变）
syncSize	bool	是否设置文本时同步更新文本框大小，默认值为False

返回值

无
示例

# we want to set text2 content
text2Path = "/panel/text2"
text = "Hello World!"
labelUIControl = uiNode.GetBaseUIControl(text2Path).asLabel()
labelUIControl.SetText(text)

GetText

描述

获取Label的文本信息，获取失败会返回None
参数

无
返回值

数据类型
说明

str 文本信息
备注
- 获取失败通常是由于路径填写错误，或该控件不是Label类型
示例

# we want to get text2 content
text2Path = "/panel/text2"
labelUIControl = uiNode.GetBaseUIControl(text2Path).asLabel()
labelUIControl.GetText()

SetTextColor

描述

设置Label文本的颜色
参数

参数名
数据类型
说明

color tuple(float,float,float) 文本的颜色信息(r, g, b)，取值[0, 1]
返回值

无
备注
- 该接口不支持传入alpha通道改变透明度，建议使用SetAlpha接口
示例

# we want to set text2 green
text2Path = "/panel/text2"
color = (0, 1, 0)
labelUIControl = uiNode.GetBaseUIControl(text2Path).asLabel()
labelUIControl.SetTextColor(color)

GetTextColor

描述

获取Label文本颜色
参数

无
返回值

数据类型
说明

tuple(float,float,float,float) 获取文本的颜色信息(r, g, b, a), 取值[0, 1]
示例

# we want to get text2 color
text2Path = "/panel/text2"
labelUIControl = uiNode.GetBaseUIControl(text2Path).asLabel()
labelUIControl.GetTextColor()

SetTextFontSize

描述

设置Label中文本字体的大小

参数

参数名	数据类型	说明
componentPath	str	为从main节点开始的控件路径
scale	float	label的font_size的作用是Label中的默认字体大小，取值有限为[small normal large]，这个scale是在这个默认字体的基础上进行缩放字体大小，默认字体大小为1.0

返回值

无
示例

# set text font size
text2Path = "/panel/text2"
labelUIControl = uiNode.GetBaseUIControl(text2Path).asLabel()
labelUIControl.SetTextFontSize(0.8)

SetTextAlignment

描述

设置文本控件的文本对齐方式
参数

参数名
数据类型
说明

textAlignment str 文本控件的文本对齐方式，可选的值详见备注
返回值

数据类型
说明

bool 设置是否成功
备注
- textAlignment可选的值
  
  值解释
  
  "left" 文本左对齐（水平方向）
  
  "right" 文本右对齐（水平方向）
  
  "center" 文本居中对齐（水平方向）
示例

# we want to align text2 to center
text2Path = "/panel/text2"
labelUIControl = uiNode.GetBaseUIControl(text2Path).asLabel()
textAlignment = "center"
ret = labelUIControl.SetTextAlignment(textAlignment)

GetTextAlignment

描述

获取文本控件的文本对齐方式
参数

无
返回值

数据类型
说明

str 文本控件的文本对齐方式，具体返回值的意义可参考SetTextAlignment接口的备注
示例

# we want to get text2 textAlignment
text2Path = "/panel/text2"
labelUIControl = uiNode.GetBaseUIControl(text2Path).asLabel()
labelUIControl.GetTextAlignment()

SetTextLinePadding

描述

设置文本控件的行间距
参数

参数名
数据类型
说明

textLinePadding float 文本控件的行间距，单位为像素
返回值

数据类型
说明

bool 设置是否成功
示例

# we want to set text2 textLinePadding
text2Path = "/panel/text2"
labelUIControl = uiNode.GetBaseUIControl(text2Path).asLabel()
textLinePadding = 20
ret = labelUIControl.SetTextLinePadding(textLinePadding)

GetTextLinePadding

描述

获取文本控件的行间距
参数

无
返回值

数据类型
说明

float 文本控件的行间距，单位为像素
示例

# we want to get text2 textLinePadding
text2Path = "/panel/text2"
labelUIControl = uiNode.GetBaseUIControl(text2Path).asLabel()
labelUIControl.GetTextLinePadding()

EnableTextShadow

描述

使文本控件显示阴影
参数

无
返回值

数据类型
说明

bool 设置是否成功
示例

# we want to enable text2 textShadow
text2Path = "/panel/text2"
labelUIControl = uiNode.GetBaseUIControl(text2Path).asLabel()
ret = labelUIControl.EnableTextShadow()

DisableTextShadow

描述

关闭文本控件显示阴影
参数

无
返回值

数据类型
说明

bool 设置是否成功
示例

# we want to diable text2 textShadow
text2Path = "/panel/text2"
labelUIControl = uiNode.GetBaseUIControl(text2Path).asLabel()
ret = labelUIControl.DisableTextShadow()

IsTextShadowEnabled

描述

判断文本控件是否显示阴影
参数

无
返回值

数据类型
说明

bool 文本控件是否显示阴影
示例

# we want to know whether text2 has shadow
text2Path = "/panel/text2"
labelUIControl = uiNode.GetBaseUIControl(text2Path).asLabel()
labelUIControl.IsTextShadowEnabled()

MiniMapUIControl

class in mod.client.ui.controls.minimapUIControl

UI面向对象小地图控件类用于在UI上渲染实时地图

ZoomIn

描述

放大地图
参数

参数名
数据类型
说明

value float 在原有基础上的增量值，可以控制放大速度，默认为0.05
返回值

数据类型
说明

bool 是否成功
示例

path = "/demoPanel/netease_mini_map"
doll = uiNode.GetBaseUIControl(path).asMiniMap()
doll.ZoomIn(0.2)

ZoomOut

描述

缩小地图
参数

参数名
数据类型
说明

value float 在原有基础上的减少值，可以控制缩小速度，默认为0.05
返回值

数据类型
说明

bool 是否成功
备注
- 客户端地图区块加载有限，如果地图UI界面太大或者缩小地图倍数太大，会导致小地图无法显示未加载的区块。
示例

path = "/demoPanel/netease_mini_map"
doll = uiNode.GetBaseUIControl(path).asMiniMap()
doll.ZoomOut(0.2)

ZoomReset

描述

恢复地图放缩大小为默认值
参数

无
返回值

数据类型
说明

bool 是否成功
示例

path = "/demoPanel/netease_mini_map"
doll = uiNode.GetBaseUIControl(path).asMiniMap()
doll.ZoomReset(0.2)

SetHighestY

描述

设置绘制地图的最大高度
参数

参数名
数据类型
说明

highestY int 绘制高度值
返回值

数据类型
说明

bool 是否成功
备注
- 动态调整高度值后，已经绘制过的区块不会刷新为新的高度值，只有没有绘制过的区块会以新的高度值来绘制。
示例

path = "/demoPanel/netease_mini_map"
doll = uiNode.GetBaseUIControl(path).asMiniMap()
doll.SetHighestY(255)

NeteaseComboBoxUIControl

class in mod.client.ui.controls.neteaseComboBoxUIControl

网易版单选下拉框控件类，继承自BaseUIControl，除基础功能接口外包含单选下拉框相关功能接口

AddOption

描述

添加下拉框项，若添加成功则返回True，否则返回False

参数

参数名	数据类型	说明
showName	str	显示文本，必填参数
icon	str	贴图路径，若填写则在下拉框项前端会显示该icon，默认为None
userData	any	自定义数据，在选中该下拉框项时会跟随回调函数传回，默认为None

返回值

数据类型
说明

bool 是否添加成功
示例

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
success = comboBoxUIControl.AddOption("测试项", "textures/ui/test_icon", {"mydata": "netease"})

ClearOptions

描述

清空下拉框
参数

无
返回值

无
示例

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
comboBoxUIControl.ClearOptions()

ClearSelection

描述

清除当前选中，使下拉框恢复未选中内容状态
参数

无
返回值

无
示例

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
comboBoxUIControl.ClearSelection()

GetOptionIndexByShowName

描述

根据展示文本查找对应下拉框项的索引位置，若找不到返回-1
参数

参数名
数据类型
说明

name str 显示文本
返回值

数据类型
说明

int 索引位置
示例

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
index = comboBoxUIControl.GetOptionIndexByShowName("测试项")

GetOptionShowNameByIndex

描述

根据索引位置查找当前栈式文本，若找不到返回None
参数

参数名
数据类型
说明

index int 索引位置
返回值

数据类型
说明

str 显示文本
示例

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
text = comboBoxUIControl.GetOptionShowNameByIndex(0)

GetOptionCount

描述

获得选项数量
参数

无
返回值

数据类型
说明

int 当前下拉框选项数量
示例

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
totalNum = comboBoxUIControl.GetOptionCount()

GetSelectOptionIndex

描述

获得当前选中项的索引，所无选中项则返回-1
参数

无
返回值

数据类型
说明

int 当前下拉框选中项索引
示例

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
currentIndex = comboBoxUIControl.GetSelectOptionIndex()

GetSelectOptionShowName

描述

获得当前选中项的展示文本，所无选中项则返回None
参数

无
返回值

数据类型
说明

str 当前选中项的展示文本
示例

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
currentText = comboBoxUIControl.GetSelectOptionShowName()

RemoveOptionByShowName

描述

根据提供的展示文本移除对应下拉框项，移除成功则返回True，否则返回False
参数

参数名
数据类型
说明

showName str 展示文本
返回值

数据类型
说明

bool 是否移除成功
示例

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
success = comboBoxUIControl.RemoveOptionByShowName("测试项")

RemoveOptionByIndex

描述

根据提供的索引移除对应下拉框项，移除成功则返回True，否则返回False
参数

参数名
数据类型
说明

index int 索引
返回值

数据类型
说明

bool 是否移除成功
示例

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
success = comboBoxUIControl.RemoveOptionByIndex(0)

SetSelectOptionByIndex

描述

根据提供的索引选中对应下拉框项
参数

参数名
数据类型
说明

index int 索引
返回值

无
示例

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
comboBoxUIControl.SetSelectOptionByIndex(0)

SetSelectOptionByShowName

描述

根据提供的展示文本选中对应下拉框项
参数

参数名
数据类型
说明

name str 索引
返回值

无
示例

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
comboBoxUIControl.SetSelectOptionByShowName("测试项")

RegisterOpenComboBoxCallback

描述

注册展开下拉框事件回调
参数

参数名
数据类型
说明

callback function 回调函数，必须是UI的类函数
返回值

无
示例

# 注册展开下拉框事件回调，在点击展开下拉框时会调用注册的回调函数
def onOpenComboBoxCallback(args):
    pass

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
comboBoxUIControl.RegisterOpenComboBoxCallback(onOpenComboBoxCallback)

RegisterCloseComboBoxCallback

描述

注册关闭下拉框事件回调
参数

参数名
数据类型
说明

callback function 回调函数，必须是UI的类函数
返回值

无
示例

# 注册关闭下拉框事件回调，在点击关闭下拉框时会调用注册的回调函数
def onCloseComboBoxCallback(args):
    pass

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
comboBoxUIControl.RegisterCloseComboBoxCallback(onCloseComboBoxCallback)

RegisterSelectItemCallback

描述

注册选中下拉框内容事件回调
参数

参数名
数据类型
说明

callback function 回调函数，必须是UI的类函数
返回值

无

备注

onSelectItemCallback参数说明：

参数	类型	解释
index	int	当前选中项的索引
showName	str	当前选中项的显示文本
userData	Unknown	当前选中项的自定义数据，若添加下拉框项时未传入自定义数据则此处为None

示例

# 注册选中下拉框内容事件回调，在点击关闭下拉框时会调用注册的回调函数
def onSelectItemCallback(index, showName, userData):
    pass

comboBoxPath = "/panel/comboBoxPanel"
comboBoxUIControl = uiNode.GetBaseUIControl(comboBoxPath).asNeteaseComboBox()
comboBoxUIControl.RegisterSelectItemCallback(onSelectItemCallback)

NeteasePaperDollUIControl

class in mod.client.ui.controls.neteasePaperDollUIControl

纸娃娃控件类，继承自BaseUIControl，除基础功能接口外包含纸娃娃相关功能接口用于在UI上渲染实体/骨骼模型/特效

GetModelId

描述

获取渲染的骨骼模型Id
参数

无
返回值

数据类型
说明

int 骨骼模型Id，失败或者不存在返回-1
备注
- 注意：请不要在RenderEntity/RenderSkeletonModel调用之后立即执行。骨骼模型Id可用于一下情形： 1.绑定一个另外的骨骼模型； 2.绑定序列帧动画； 3.绑定特效粒子动画
示例

import mod.client.extraClientApi as clientApi
path = '/demoPanel/paper_doll'
doll = uiNode.GetBaseUIControl(path).asNeteasePaperDoll()
modelId = doll.GetModelId()
if modelId == -1:
    return
#用途1：绑定一个另外的骨骼模型
modelComp = clientApi.GetEngineCompFactory().CreateModel(modelId)
newModelId = modelComp.BindModelToModel("rightHand", "gun") # 把名称为gun的骨骼模型挂接到rightHand骨骼上
#用途2：绑定序列帧动画
sfxId = clientSystem.CreateEngineSfxFromEditor("effects/example_sfx.json") # 创建特效
comp = clientApi.GetEngineCompFactory().CreateFrameAniSkeletonBind(sfxId)
comp.Bind(modelId, "root", (0, 1, 0), (0, 0, 0)) # 把特效绑定到骨骼模型的骨骼节点上
frameComp = clientApi.GetEngineCompFactory().CreateFrameAniControl(sfxId)
frameComp.Play() # 播放动画
clientSystem.DestroyEntity(sfxId) # 销毁动画
#用途3：绑定特效粒子动画
particleEntityId = clientSystem.CreateEngineParticle("effects/example_particle.json", (0,0,0)) # 创建特效
comp = clientApi.GetEngineCompFactory().CreateParticleSkeletonBind(particleEntityId)
comp.Bind(modelId, "root", (0, 1, 0), (0, 0, 0)) # 把特效绑定到骨骼模型的骨骼节点上
particleComp = clientApi.GetEngineCompFactory().CreateParticleControl(particleEntityId)
particleComp.Play() # 播放动画
clientSystem.DestroyEntity(particleEntityId) # 销毁动画

RenderEntity

描述

渲染实体
参数

参数名
数据类型
说明

params dict 渲染参数，详细说明请见备注
返回值

数据类型
说明

bool 是否成功

备注

RenderEntity参数params说明： params参数解释如下：

参数	类型	解释
entity_id	str	渲染生物的实体Id
scale	float	渲染缩放比例，默认为1.0
render_depth	int	渲染深度，对于玩家默认-50，普通生物-15，该参数可解决UI遮挡剔除问题
init_rot_y	float	初始Y方向的朝向
molang_dict	dict	molang表达式字典，其中key为str，value为float

示例

path = '/demoPanel/paper_doll'
param = {
    "entity_id": "-8589934591",
    "scale": 0.5,
    "render_depth": -50,
    "init_rot_y": 60,
    "molang_dict": {"variable.liedownamount": 1}
}
doll = uiNode.GetBaseUIControl(path).asNeteasePaperDoll()
doll.RenderEntity(param)

RenderSkeletonModel

描述

渲染骨骼模型（不依赖实体）
参数

参数名
数据类型
说明

params dict 渲染参数，详细说明请见备注
返回值

数据类型
说明

bool 是否成功

备注

RenderSkeletonModel参数params说明： params参数解释如下：

参数	类型	解释
skeleton_model_name	str	骨骼模型名称
animation	str	骨骼动作名称，默认为idle
animation_looped	bool	骨骼动作是否循环播放，默认True
scale	float	渲染缩放比例，默认为1.0
render_depth	int	渲染深度，对于玩家默认-50，普通生物-15，该参数可解决UI遮挡剔除问题
init_rot_y	float	初始Y方向的朝向
molang_dict	dict	molang表达式字典，其中key为str，value为float

示例

import mod.client.extraClientApi as clientApi
path = '/demoPanel/paper_doll'
param = {
    "skeleton_model_name": "ty_yuanshenghuli_0_0",
    "animation": "idle_stand",
    "scale": 0.5,
    "render_depth": -50,
    "init_rot_y": 60,
    "molang_dict": {"variable.liedownamount": 1}
}
doll = uiNode.GetBaseUIControl(path).asNeteasePaperDoll()
doll.RenderSkeletonModel(param)

RenderBlockGeometryModel

描述

渲染网格体模型
参数

参数名
数据类型
说明

params dict 渲染参数，详细说明请见备注
返回值

数据类型
说明

bool 是否成功

备注

网格体模型使用CombineBlockPaletteToGeometry生成
每次进入游戏需要重新调用本接口渲染网格体模型，可使用SerializeBlockPalette和DeserializeBlockPalette实现调色板保存并重载调色板，重新生成网格体模型进行渲染。

RenderBlockGeometryModel参数params说明： params参数解释如下：

参数	类型	解释
block_geometry_model_name	str	网格体模型名称, 可用CombineBlockPaletteToGeometry返回值
scale	float	渲染缩放比例，默认为1.0
init_rot_y	float	初始Y方向的朝向
molang_dict	dict	molang表达式字典，其中key为str，value为float

示例

import mod.client.extraClientApi as clientApi
path = '/demoPanel/paper_doll'
param = {
    "block_geometry_model_name": "my_geometry_model",
    "scale": 0.5,
    "init_rot_y": 60,
    "molang_dict": {"variable.liedownamount": 1}
}
doll = uiNode.GetBaseUIControl(path).asNeteasePaperDoll()
doll.RenderBlockGeometryModel(param)

ProgressBarUIControl

class in mod.client.ui.controls.progressBarUIControl

进度条控件类，继承自BaseUIControl，除基础功能接口外包含进度条相关功能接口

SetValue

描述

设置进度条的进度
参数

参数名
数据类型
说明

progress float 进度，取值[0, 1]
返回值

无
示例

# we want to set progress
progressBarPath = "/panel/progress_bar"
progressBarUIControl = uiNode.GetBaseUIControl(progressBarPath).asProgressBar()
progressBarUIControl.SetValue(0.8)

ScrollViewUIControl

class in mod.client.ui.controls.scrollViewUIControl

滚动列表控件类，继承自BaseUIControl，除基础功能接口外包含滚动列表相关功能接口

SetScrollViewPos

描述

设置当前scroll_view内容的位置
参数

参数名
数据类型
说明

pos float 需要跳转到的位置，一般设置的位置会出现在scroll_view的最上方。
返回值

无
示例

# we want set scroll_view pos
scrollViewPath = "/scroll_view0"
scrollViewUIControl = uiNode.GetBaseUIControl(scrollViewPath).asScrollView()
scrollViewUIControl.SetScrollViewPos(100)

GetScrollViewPos

描述

获得当前scroll_view最上方内容的位置
参数

无
返回值

数据类型
说明

float 当前scroll_view最上方内容的位置
示例

# we want get scroll_view pos
scrollViewPath = "/scroll_view0"
scrollViewUIControl = uiNode.GetBaseUIControl(scrollViewPath).asScrollView()
scrollViewUIControl.GetScrollViewPos()

SetScrollViewPercentValue

描述

设置当前scroll_view内容的百分比位置
参数

参数名
数据类型
说明

percent_value int 需要跳转到的百分比位置，一般设置的位置会出现在scroll_view的最上方。该值取值范围0-100
返回值

无
示例

# we want set scroll_view percent pos
scrollViewPath = "/scroll_view0"
scrollViewUIControl = uiNode.GetBaseUIControl(scrollViewPath).asScrollView()
scrollViewUIControl.SetScrollViewPercentValue(20)

GetScrollViewContentPath

描述

返回该scroll_view内容的路径
参数

无
返回值

数据类型
说明

str 该scroll_view内容的路径
示例

# we want get scroll_view content path
scrollViewPath = "/scroll_view0"
scrollViewUIControl = uiNode.GetBaseUIControl(scrollViewPath).asScrollView()
path = scrollViewUIControl.GetScrollViewContentPath()

GetScrollViewContentControl

描述

返回该scroll_view内容的BaseUIControl实例
参数

无
返回值

数据类型
说明

BaseUIControl 该scroll_view内容的BaseUIControl实例
示例

# we want get scroll_view content
scrollViewPath = "/scroll_view0"
scrollViewUIControl = uiNode.GetBaseUIControl(scrollViewPath).asScrollView()
contentUIControl = scrollViewUIControl.GetScrollViewContentControl()

SliderUIControl

class in mod.client.ui.controls.sliderUIControl

文本输入框控件类，继承自BaseUIControl，除基础功能接口外包含文本输入框相关功能接口

GetSliderValue

描述

获取滑动条的值，失败返回0
参数

无
返回值

数据类型
说明

float 滑动条的值
示例

# we want to get slider value
sliderPath = "/panel/slider0"
sliderUIControl = uiNode.GetBaseUIControl(sliderPath).asSlider()
value = sliderUIControl.GetSliderValue()

SetSliderValue

描述

设置滑动条的值
参数

参数名
数据类型
说明

value float 滑动条的值
返回值

无
示例

# we want to set slider value
sliderPath = "/panel/slider0"
sliderUIControl = uiNode.GetBaseUIControl(sliderPath).asSlider()
sliderUIControl.SetSliderValue(0.5) # 百分比滑动条
# sliderUIControl.SetSliderValue(5) # 固定格类型滑动条

StackPanelUIControl

class in mod.client.ui.controls.stackPanelUIControl

布局面板控件类，继承自BaseUIControl，除基础功能接口外包含文本相关功能接口

SetOrientation

描述

设置stackPanel的排列方向
参数

参数名
数据类型
说明

orientation str stackPanel的排列方向，取值有限为["vertical", "horizontal"]，分别表示垂直方向，水平方向
返回值

数据类型
说明

bool 设置是否成功
示例

# we want to set stackPanel1 orientation
stackPanelPath = "/stackPanel1"
stackPanel = uiNode.GetBaseUIControl(stackPanelPath).asStackPanel()
orientation = "vertical"
stackPanel.SetOrientation(orientation)

GetOrientation

描述

获取stackPanel的排列方向
参数

无
返回值

数据类型
说明

str stackPanel的排列方向，取值有限为["vertical", "horizontal"]，分别表示垂直方向，水平方向
示例

# we want to get stackPanel1 orientation
stackPanelPath = "/stackPanel1"
stackPanel = uiNode.GetBaseUIControl(stackPanelPath).asStackPanel()
stackPanel.GetOrientation()

SwitchToggleUIControl

class in mod.client.ui.controls.switchToggleUIControl

开关控件类，继承自BaseUIControl，除基础功能接口外包含开关相关功能接口

SetToggleState

描述

设置Toggle开关控件的值

参数

参数名	数据类型	说明
is_on	bool	设置Toggle开关控件是打开还是关闭状态
toggle_path	bool	实际toggle控件相对路径，由UI编辑器生成的开关控件该参数即为默认值"/this_toggle"

返回值

无
示例

togglePath = "/toggle1"
switchToggleUIControl = uiNode.GetBaseUIControl(togglePath).asSwitchToggle()
switchToggleUIControl.SetToggleState(True)

TextEditBoxUIControl

class in mod.client.ui.controls.textEditBoxUIControl

文本输入框控件类，继承自BaseUIControl，除基础功能接口外包含文本输入框相关功能接口

GetEditText

描述

获取edit_box输入框的文本信息，获取失败会返回None
参数

无
返回值

数据类型
说明

str 文本信息
备注
- 获取失败通常是由于路径填写错误，或该控件不是edit_box类型
示例

# we want to get edit2 content
editBoxPath = "/panel/edit2"
textEditBoxUIControl = uiNode.GetBaseUIControl(editBoxPath).asTextEditBox()
text = textEditBoxUIControl.GetEditText()

SetEditText

描述

设置edit_box输入框的文本信息
参数

参数名
数据类型
说明

text str 文本的内容
返回值

无
示例

# we want to clear edit2 content
editBoxPath = "/panel/edit2"
text = ""
textEditBoxUIControl = uiNode.GetBaseUIControl(editBoxPath).asTextEditBox()
textEditBoxUIControl.SetEditText(text)

SetEditTextMaxLength

描述

设置输入框的最大输入长度
参数

参数名
数据类型
说明

maxLength int 输入框可输入的最大长度，取值[0, +∞)
返回值

无
示例

# we want to set text_edit_box max input length 10
editTextPath = "/panel2/text_edit_box"
textEditBoxUIControl = uiNode.GetBaseUIControl(editBoxPath).asTextEditBox()
textEditBoxUIControl.SetEditTextMaxLength(10)

值	解释
"fromLeftToRight"	从左到右
"fromRightToLeft"	从右到左
"fromOutsideToInside"	从外到内
"fromTopToBottom"	从上到下
"fromBottomToTop"	从下到上

值	解释
"left"	文本左对齐（水平方向）
"right"	文本右对齐（水平方向）
"center"	文本居中对齐（水平方向）

102 KiB Raw Blame History Unescape Escape

UI控件

BaseUIControl

ButtonUIControl

GridUIControl

ImageUIControl

InputPanelUIControl

ItemRendererUIControl

LabelUIControl

MiniMapUIControl

NeteaseComboBoxUIControl

NeteasePaperDollUIControl

ProgressBarUIControl

ScrollViewUIControl

SliderUIControl

StackPanelUIControl

SwitchToggleUIControl

TextEditBoxUIControl

BaseUIControl

SetPosition

SetFullSize

GetFullSize

SetFullPosition

GetFullPosition

SetAnchorFrom

GetAnchorFrom

SetAnchorTo

GetAnchorTo

SetClipOffset

GetClipOffset

SetClipsChildren

GetClipsChildren

SetMaxSize

GetMaxSize

SetMinSize

GetMinSize

GetPosition

SetSize

GetSize

SetVisible

GetVisible

SetTouchEnable

SetAlpha

SetLayer

GetChildByName

GetChildByPath

resetAnimation

asLabel

asButton

asImage

asGrid

asScrollView

asSwitchToggle

asTextEditBox

asProgressBar

asNeteasePaperDoll

asMiniMap

asSlider

asItemRenderer

asNeteaseComboBox

asStackPanel

asInputPanel

ButtonUIControl

AddTouchEventParams

SetButtonTouchDownCallback

SetButtonTouchUpCallback

SetButtonTouchCancelCallback

SetButtonTouchMoveCallback

SetButtonTouchMoveInCallback

SetButtonTouchMoveOutCallback

SetButtonScreenExitCallback

GridUIControl

SetGridDimension

ImageUIControl

SetSprite

SetSpriteColor

SetSpriteGray

SetSpriteUV

SetSpriteUVSize

SetSpriteClipRatio

102 KiB

Raw Blame History