文档和工具

UI API

下面是UI的一些API接口文档,关于UI的使用请参照《UI使用文档.md》。

下面的文档分为两个部分,一部分是在extraClientApi中,另一部分是ScreenNode基类的成员函数。

额外的客户端API

extraClientApi中界面的一些有用的API接口函数。

ExtraUI

GetInputVector

  • 描述

    返回值为当前玩家的操作的移动向量

  • 返回值

    数据类型说明
    tuple(x,y) 返回值分别为x轴和y轴的向量值,取值范围为[0, 1],以操作中心为原点,up上和left左为正方向,down下和right右为负方向
  • 示例

HideHudGUI

  • 描述

    隐藏HUD游戏界面的游戏原生UI

  • 参数

    参数名数据类型说明
    isHidebooleanTrue为隐藏原生HUD,False为恢复显示
  • 返回值

  • 示例

HideJumpGui

  • 描述

    隐藏游戏中右下角的跳跃按钮

  • 参数

    参数名数据类型说明
    isHideboolean是否隐藏,True为隐藏,False为显示
  • 返回值

  • 示例

HideNeteaseStoreGui

  • 描述

    隐藏游戏中的网易商店按钮

  • 参数

    参数名数据类型说明
    isHideboolean是否隐藏,True为隐藏,False为显示
  • 返回值

  • 示例

HideSlotBarGui

  • 描述

    隐藏游戏中底部中间的物品栏界面

  • 参数

    参数名数据类型说明
    isHideboolean是否隐藏,True为隐藏,False为显示
  • 返回值

  • 示例

HideSneakGui

  • 描述

    隐藏游戏中左下角方向键的中心处潜行按钮

  • 参数

    参数名数据类型说明
    isHideboolean是否隐藏,True为隐藏,False为显示
  • 返回值

  • 示例

HideSwimGui

  • 描述

    隐藏游戏中的浮潜按钮

  • 参数

    参数名数据类型说明
    isHideboolean是否隐藏,True为隐藏,False为显示
  • 返回值

  • 示例

HideWalkGui

  • 描述

    隐藏游戏中右上角的移动类型按钮

  • 参数

    参数名数据类型说明
    isHideboolean是否隐藏,True为隐藏,False为显示
  • 返回值

  • 示例

SetInputMode

  • 描述

    设置UI的输入模式,输入模式影响是否可以同时控制游戏操作。

  • 参数

    参数名数据类型说明
    modeint取值为0或1,0为HUD的操作模式,1为UI的操作模式。
  • 返回值

  • 示例

SetResponse

  • 描述

    设置原生UI是否响应,详见UI文档

  • 参数

    参数名数据类型说明
    responseboolean点击UI时是否屏蔽下层敲击方块/攻击实体
  • 返回值

  • 示例

SetTextDefaultFont

  • 描述

    设置Label文本框的默认字体,需要在创建某一需要指定默认字体的界面之前调用该接口,防止出现没有汉字时是MC字体,有汉字时是汉字字体。

  • 参数

    参数名数据类型说明
    fontstr字体的取值范围[default, rune, unicode, smooth],其中default是默认MC字体,unicode为中文字体。
  • 返回值

  • 示例

界面节点的API

ScreenNode的一些有用的函数,界面Node节点的获取方式在《UI使用文档.md》中有详细说明。

假设下文中的函数,uiNode为获取到的ScreenNode继承类,调用的UI界面是按下面的节点树组织结构的

ScreenNode

AddTouchEventHandler

  • 描述

    设置按钮的回调函数

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始,被删除控件路径
    callbackFuncfunction回调函数,必须是UI的类函数
    argsdict默认为None,详细说明请见备注。
  • 返回值

  • 示例

  • 备注

    • AddTouchEventHandler参数args说明:

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

若要监听TouchMove事件,button的json里is_handle_button_move_event必须设置为true 且 button_mappings必须设置为[]。json可以参考《3-4 UI说明文档》控件介绍中的Image Button。args参数解释如下:

Clone

  • 描述

    克隆一个已有的控件,修改它的名称,并将它挂接到指定的父节点上。

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
    parentPathstr为从main节点开始,父节点的控件路径
    newNamestr为被克隆的控件名称,因此克隆完了之后新控件的父节点路径为parentPath
  • 返回值

  • 示例

GetAllChildrenPath

  • 描述

    获取所有子节点的路径list

  • 参数

    参数名数据类型说明
    parentPathstr为从main节点开始,父节点的控件路径
  • 返回值

    数据类型说明
    list返回父节点下的子节点的路径,会递归返回所有子节点,若节点无子节点,返回空list
  • 示例

GetChildrenName

  • 描述

    获取子节点的名称list

  • 参数

    参数名数据类型说明
    parentPathstr为从main节点开始,父节点的控件路径
  • 返回值

    数据类型说明
    list返回父节点下的子节点的名称,不会递归返回所有子节点,若节点无子节点,返回空list
  • 示例

GetPosition

  • 描述

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

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
  • 返回值

    数据类型说明
    tuple(x,y)该控件相对父节点的坐标信息,x为横轴,y为纵轴
  • 示例

GetSize

  • 描述

    获取控件的大小

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
  • 返回值

    数据类型说明
    tuple(x,y)该控件的大小信息,x为横轴,y为纵轴
  • 示例

GetTextColor

  • 描述

    获取Label文本颜色

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
  • 返回值

    数据类型说明
    tuple(r,g,b,a)获取文本的颜色信息(r, g, b, a), 取值[0, 1]
  • 示例

RemoveComponent

  • 描述

    动态删除某一控件

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始,被删除控件路径
    parentPathstr为从main节点开始,父节点的控件路径
  • 返回值

  • 示例

SetCrossHair

  • 描述

    设置屏幕中心的十字是否显示

  • 参数

    参数名数据类型说明
    visibleboolTrue为隐藏十字光标,False为恢复
  • 返回值

  • 示例

SetEditTextMaxLength

  • 描述

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

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
    maxLengthint输入框可输入的最大长度,取值[0, +∞)
  • 返回值

  • 示例

SetGridDimension

  • 描述

    设置Grid控件的大小

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始,Grid控件的路径
    dimensiontuple(x,y)x,y均为int类型,设置网格大小
  • 返回值

  • 示例

SetPosition

  • 描述

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

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
    postuple(x,y)该控件相对父节点的坐标信息,x为横轴,y为纵轴
  • 返回值

  • 示例

SetRemove

  • 描述

    删除本界面节点

  • 返回值

  • 示例

SetScreenVisible

  • 描述

    设置是否显示本界面

  • 参数

    参数名数据类型说明
    visiblebooleanFalse为隐藏该界面,True为显示该界面
  • 返回值

  • 示例

SetSize

  • 描述

    设置控件的大小

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
    sizetuple(x,y)该控件的大小信息,x为横轴,y为纵轴
  • 返回值

  • 示例

SetSprite

  • 描述

    给图片空间换指定贴图

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
    texturePathstr贴图的路径,需要从resource_pack下面的textures目录开始
  • 返回值

SetSpriteBright

  • 描述

    给图片设置亮度,比直接SetSprite一张图片效率要高

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
    brightint取值为[-1, 0, 1]三个值,分别代表着[暗, 正常,亮]三个效果
  • 返回值

  • 示例

SetSpriteGray

  • 描述

    给图片空间置灰,比直接SetSprite一张灰图片效率要高

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
    grayboolTrue为将图片置灰,False为恢复原色
  • 返回值

  • 示例

SetStackGridCount

  • 描述

    设置StackGrid控件的大小

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始,Grid控件的路径
    countint设置StackGrid的内容数量
  • 返回值

  • 示例

SetText

  • 描述

    设置Label的文本信息

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
    textstr文本的内容,可以支持样式代码(§可以设置文字的颜色、格式等,该种用法更加灵活多变)
  • 返回值

  • 示例

SetTextColor

  • 描述

    设置Label文本的颜色

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
    colortuple(r,g,b,a)文本的颜色信息(r, g, b, a),取值[0, 1]
  • 返回值

  • 示例

SetTextFontSize

  • 描述

    设置Label中文本字体的大小

  • 参数

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

  • 示例

SetTouchEnable

  • 描述

    设置控件是否可点击交互

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
    enableboolFalse为不响应,True为恢复响应
  • 返回值

  • 示例

SetUiModel

  • 描述

    删除本界面节点

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始,被删除控件路径
    modelNamestr骨骼模型的名称
  • 返回值

  • 示例

SetVisible

  • 描述

    根据控件路径选择是否显示某控件

  • 参数

    参数名数据类型说明
    componentPathstr为从main节点开始的控件路径
    visiblebooleanFalse为隐藏该控件,True为显示该控件
  • 返回值

  • 示例