showUI
函数名称:配置界面,脚本 UI
函数功能:显示一个自定义的界面,用来接收用户相关的自定义配置
函数方法
ret, input_1, input_2, ... = showUI(ui_json)
返回值:ret,input_(*)
参数 | 类型 | 说明 |
---|---|---|
ui_json | string | 自定义界面 json 格式字符串调用时字符串需经过压缩与转义 |
返回值 | 类型 | 说明 |
---|---|---|
ret | number | 1 - 确认输入;0 - 取消输入 |
input_(*) | string | 返回用户输入的多项数据 |
全局属性
参数 | 类型 | 必填 | 说明 | 默认值 |
---|---|---|---|---|
style | string | 否 | 指定界面样式 default 为默认样式,所有控件自动排列,每个控件占据一行。 custom 为自定义样式,当界面样式被指定为这种, 则必须指定每个控件的 rect 属性以调整控件的尺寸以及位置。 |
"default" |
width | number | 否 | 界面的宽度(像素 pixels),不得低于 400。 | - |
height | number | 否 | 界面的高度(像素 pixels),不得低于 120。 | - |
bg | string | 否 | 指定界面的背景图片, 相对路径为 res 资源目录,可填写绝对路径。 |
- |
okname | string | 否 | 确认文字,指定底部右侧确认按钮上显示的文字。 | “确定” |
cancelname | string | 否 | 取消文字,指定底部左侧取消按钮上显示的文字。 | “取消” |
title | string | 否 | 标题,用于指定 UI 顶部标题栏文字, 仅 iOS v2.2.5, Android v1.2.4 以上版本支持 |
“脚本配置” |
titlealign | string | 否 | title 对齐方式,默认左对齐。 可取值为:左对齐 left,右对齐 right,居中 center, 仅支持 Androidv3.2.0、iOSv3.1.5 及其以上版本 |
“left” |
titlesize | number | 否 | title 字体大小,仅支持 Androidv3.2.0、iOSv3.1.5 及其以上版本 | 15 |
titles | string | 否 | 多页标题,用于指定 UI 顶部标题栏文字在多页模式下 可以设置多个标题对应多个页面,以逗号分隔, 仅 iOS v2.3.2, Android v2.2.7 以上版本支持。 |
- |
pagetype | string | 否 | 多页模式,当指定该属性值为 multi 时,UI 可分页显示,左右滑动进行翻页,如不指定该属性,将使用默认的单页模式, 仅 iOSv2.2.5, Androidv2.1.5 以上版本支持。 |
- |
selpage | number | 否 | 多页模式下指定默认停留的页面, iOS 仅支持 v2.2.7 及其以上版本, Android 支持所有引擎版本。 |
1 |
orient | number | 否 | 指定 UI 界面显示方向, 0 - Home 键在设备下方, 1 - Home 键在设备右侧, 2 - Home 键在设备左侧, 仅支持 iOS v2.2.5 及其以上版本 |
0 |
btnbkcolor | string | 否 | 底部按钮背景色,使用 RGB 十进制数值,以英文半角逗号分割, 仅支持 iOSv2.3.5 及其以上版本, Android 暂不支持。 |
“248,248,248” |
bgcolor | string | 否 | 界面背景色,使用 RGB 十进制数值,以英文半角逗号分割, 仅支持 iOSv2.3.5 及其以上版本, Android 暂不支持。 |
“248,248,248” |
pagenumtype | string | 否 | 页码样式,dot - 小圆点, number - 数字, default - 不显示, 仅支持 iOSv2.3.5 及其以上版本,Android 暂不支持; tab - 底部不显示页码样式, 在顶部将分页标题显示为二级标签, 仅支持 Androidv3.2.0、iOSv3.1.5 及其以上版本 |
“default” |
config | string | 否 | 配置保存文件名,保存配置到该文件, 注意不写此文件将无法保存修改的 UI 配置 并且将无法还原修改的配置 |
- |
timer | number | 否 | 自动确认时间,倒计时完成自动开始, 专业版 iOSv3.0.6、 Androidv3.2.0 及其以上版本客户端 此参数最高只能显示 999 秒; Androidv3.2.0、iOSv3.1.5 及以上版本将倒计时图标挪到数字右侧, 数字和图标均为右对齐,文字修改为只有数字不显示单位, 调整位置为右对齐 |
- |
rettype | string | 否 | 指定返回值类型,default - 默认模式,保持旧版格式,可使用此属性兼容旧版 UI; array - 数组模式,将所有控件返回值按添加顺序放入一个 table 中返回; table - table 模式,将所有控件返回值以 key, values 形式的 table 返回, key 为控件 id 属性所指定的值,仅支持 iOSv2.2.6, Androidv1.2.7 及以上版本。 |
“default” |
指定控件尺寸与位置
界面的样式 style 为 default 时,即默认样式,这个样式下的控件将会自动排列,不需要指定其坐标。 另一种界面样式为 custom,当界面样式被指定为这种,则必须指定每个控件的 rect 属性以调整控件的尺寸以及位置,例如:
{
"type": "Edit", "size": 15, "align": "left",
"prompt": "提示文字",
"text": "默认文字",
"color": "255,0,0",
"rect": "0,0,100,40"
}
参数 | 类型 | 说明 |
---|---|---|
rect | string | 尺寸与位置,该属性适用于全部五种控件, 将控件的左上角顶点横坐标、纵坐标, 控件宽度、高度分别以英文半角逗号分割 |
注意事项
config 写了配置文件运行脚本后将保存当前修改的 UI 配置信息到配置文件,再次运行脚本将读取配置文件显示上次上次选择的 UI 配置。
默认配置文件路径:
触动精灵 iOS 配置文件目录:/var/mobile/Media/TouchSprite/config/
触动精灵安卓配置文件目录:/mnt/sdcard/TouchSprite/config/
iOS 小精灵配置文件目录:/var/mobile/Media/小精灵包名/config/
安卓小精灵配置文件目录:/mnt/sdcard/
当在
iOS 9
以上版本的 iPad 设备上使用 showUI 界面时,务必使用 orient 属性指定正确的屏幕方向,否则将可能出现确定、取消按钮无法点击的情况。如果配置文件已存在,调用该界面会自动载入该文件中的配置,如果更新了 UI 代码,必须要删除旧的配置文件才会正常显示。
使用 timer 属性必须要设定 config 属性,第一次存储配置文件不存在时,此属性不生效,当配置文件存在时,此属性会在生成 UI 上进行倒计时。
在脚本 UI 界面点击闹钟标志则取消倒计时功能。
在引擎版本 iOS v2.2.6 以上版本中,自定义模式坐标计算方式由原来的分辨率(pt)改为分辨率(px),开发者使用自定义模式时需要做对应修改,新的方式只需将原自定义模式坐标乘以 Render 屏对应的倍数即可。
引擎版本 Android v3.1.7、iOS v3.1.1 及其以上版本修改了脚本配置文件的存储方式同时增加了自动还原脚本配置数据的功能。
使用 pagenumtype 参数中的 tab 会在顶部将 titles 内容显示为二级标签,title 为空顶部标题显示为脚本配置,有内容将内容显示为顶部标题。