新版表单

索引

OreUIForm

客户端

• 描述
  打开新版多功能表单

• 参数
  

• 返回值
  无

• 备注
  

  • 图例
  • IsIcon为True时，按钮控件配置参数FunctionName为EditItemIcon的函数将直接调用物品选择器来编辑图标(物品图标数据Key为ItemIconData，不要冲突了！)
  • FormConfig控件说明。

    • 左侧按钮控件(接收一个参数)

      参数名	数据类型	说明
      Type	str	控件类型button_green(绿色按钮),button_white(白色按钮),button_red(红色按钮)
      SubType	str	控件次类型default(普通按钮),commit(提交按钮)，默认为default
      ButtonName	str	按钮显示文字
      FunctionName	str	按钮函数名称(选填)
      FunctionObject	object	按钮函数所在类(选填)
      FunctionInstance	function	按钮函数实例(选填)

      • 备注
        
        • 按钮绑定的函数需要接收一个参数，当次类型为default时，接收的参数为按钮原生事件数据。当此类型为commit时，接收的参数为表单输出数据。
        • FunctionName和FunctionInstance都可以填写，但是FunctionInstance优先级最高，FunctionName填写了但是没有FunctionObject的时候默认使用该UI界面的Object。

    • 分类控件

      参数名	数据类型	说明
      Type	str	控件类型tab
      ButtonName	str	按钮显示文字
      TexturePath	str	分类图标路径，如textures/ui/aaa
      ContentData	list	子控件配置信息，子控件不能存在tab类型控件

    • 提示控件

      参数名	数据类型	说明
      Type	str	控件类型tips
      Key	str	填写不重复即可
      Title	str	控件标题
      Tips	str	控件详细说明

    • 输入控件

      参数名	数据类型	说明
      Type	str	控件类型input(单行输入),input_large(多行输入)
      Key	str	数据输出时所在键(不同tab下Key一致无法共存)
      Title	str	控件标题
      Tips	str	控件说明(选填)
      Content	str	控件默认文字(选填)

    • 按钮型输入控件

      参数名	数据类型	说明
      Type	str	控件类型input_button
      Key	str	数据输出时所在键(不同tab下Key一致无法共存)
      Title	str	控件标题
      Tips	str	控件说明(选填)
      Content	str	控件默认文字(选填)
      ButtonName	str	按钮名称
      FunctionName	str	按钮函数名称(选填)
      FunctionObject	object	按钮函数所在类(选填)
      FunctionInstance	function	按钮函数实例(选填)

      • 备注
        • 绑定的按钮事件函数需要接收一个参数，该参数类型为按钮类型返回。可以通过Key为ButtonPath来获取同级的输入框edit_box路径。

    • 单选控件

      参数名	数据类型	说明
      Type	str	控件类型select
      Key	str	数据输出时所在键(不同tab下Key一致无法共存)
      Title	str	控件标题
      Tips	str	控件说明(选填)
      Content	list[str]	选项内容
      NormalSelect	str	默认选项内容

    • 信息型按钮列表控件

      参数名	数据类型	说明
      Type	str	控件类型list_button
      Key	str	填写不重复即可
      Title	str	控件标题
      Tips	str	控件说明(选填)
      Content	list	信息型按钮列表

      • 信息型按钮组说明，Content下每个list代表一行，在一行中填写按钮配置即可。

      • 信息型按钮配置说明

        参数名	数据类型	说明
        Title	str	列表标题
        ButtonName	str	右侧按钮名称
        Information	str	列表详细信息(选填)
        IconPath	str	列表图标路径(选填)
        IconItem	str	列表图标物品名称(选填)
        FunctionName	str	按钮函数名称(选填)
        FunctionObject	object	按钮函数所在类(选填)
        FunctionInstance	function	按钮函数实例(选填)

      • IconPath与IconItem选填其一即可，其中IconItem优先级更高。

    • 开关控件

      参数名	数据类型	说明
      Type	str	控件类型toggle
      Key	str	数据输出时所在键(不同tab下Key一致无法共存)
      Title	str	控件标题
      Tips	str	控件说明(选填)
      Content	bool	开关默认状态(选填，默认为False)

    • 按钮组控件

      参数名	数据类型	说明
      Type	str	控件类型button
      Key	str	填写不重复即可
      Title	str	控件标题
      Tips	str	控件说明(选填)
      Content	list	按钮组

      • 按钮组说明，Content下每个list代表一行，在一行中填写按钮配置即可。

      • 按钮配置说明

        参数名	数据类型	说明
        ButtonType	str	按钮类型white,red,green,locked(禁用)
        ButtonName	str	按钮名称
        FunctionName	str	按钮函数名称(选填)
        FunctionObject	object	按钮函数所在类(选填)
        FunctionInstance	function	按钮函数实例(选填)

GetOreUIFormData

客户端

• 描述
  获取或更新*新版多功能表单数据

  • 更新：指进行合并操作，而不是直接替换

• 参数
  

• 返回值
  表单数据字典 (dict)

• 备注
  无

GetOreUIFormConfig

客户端

• 描述
  获取新版多功能表单配置

• 参数
  无

• 返回值
  表单配置列表 (dict)

• 备注
  无

OreUIFormRightContentRefresh

客户端

• 描述
  获取新版多功能表单配置

• 参数
  

• 返回值
  无

• 备注
  无