MiniExtend UI

对应源文件： ui.lua

UI 作用域

MiniExtend UI 前身为 Customui ，但以面相对象方式描述界面与元件，且支持 MiniExtend Object 。

约定

大多数 UI 下的函数都会包含一个 [, playerid] 参数，它表示要响应该操作的玩家 id ，该参数不会被检查，如果 playerid 的布尔值为 false ，则以 objid 代替。
UI 下的所有未表明返回值的函数或方法，一律返回 true 表示调用 API 成功，返回 false 表示失败。

UI.getRootSize() 函数

• 返回自定义 UI 界面的大小。
• return:{float} UI 界面的宽度。
• return:{float} UI 界面的高度。
• 返回的是服务器上定义的 UI 界面大小，例如在多人游戏中调用 UI.getRootSize() 会返回房主(或者云服务器)的 UI 界面大小。

UI 下的类之间的关系

UI.UIView 类

一个 UI.UIView 对象代表了一个 UI 界面，以下简称 UIView 。

构造函数

• 使用 UI.UIView:new(uiid); 来构造一个 UIView 对象。
• uiid:{string} 类型，指定该 UI 界面的 id ，该参数不会被检查。
• 函数返回一个 UIView 对象，其 id 属性为 uiid 。
• 如果已经构造过这样的对象则返回之。

属性

• id:{string}UI 界面的 id ，等于构造时传递的 uiid 属性。
• showEvent:{function | nil} UI 界面显示事件

  默认为 nil ，表示在事件发生时无需回调。
  你可以修改它来改变回调的函数。
  与 registerEvent([[$ui.onShow]], showEvent, uiid) 类似，会传递 param 作为参数。
  param 额外包含 uiview 键，表示这个 UIView 对象。

• hideEvent:{function | nil} UI 界面隐藏事件

  与 showEvent 类似，但是在 UI 界面隐藏时回调。
  注意桌面端玩家可能会按下 Esc 键意外地退出 UI 界面。

方法

• show([playerid]) ：使玩家打开该 UI 界面。
• hide([playerid]): 使玩家隐藏该 UI 界面。
• setState(state [, playerid])

  设置该 UI 界面的所有子元件的界面状态为 state 。
  state:{string} 要设置的界面状态。

• newTexture(elementid)

  构造一个 UI.Texture 对象。
  elementid:{string} 元件的 id 。
  以下不再赘述元件对象的构造函数中 elementid 的含义

• newButton(elementid): 构造一个 UI.Button 对象。
• newLabel(elementid): 构造一个 UI.Label 对象。
• newEditBox(elementid): 构造一个 UI.Texture 对象。

UI.Element 类

一个 UI.Element 对象代表一个 UI 元件，以下简称 Element 。
该类非具象类，不能直接构造 Element 对象，应构造 Element 子类的对象。

属性

• uiView:{table<UIView>} 元件所属 UIView 对象。
• id:{stirng} 元件的 id ，等于构造该元件对象时传递的 elementid 参数。

方法

• show([playerid])

  显示元件。

• hide([playerid])

  隐藏元件。

• setDisplay(display [, playerid])

  设置元件的显示状态为 display 。
  display:{boolean} 如果为 true ，显示元件，否则隐藏元件。

• setState(state [, playerid])

  设置元件的界面状态为 state 。
  state:{string} 要设置的界面状态。

• setPosition(x, y [, playerid])

  设置元件的位置为 (x, y) 。
  x:{number} 新位置的 x 坐标。
  y:{number} 新位置的 y 坐标。

• setSize(width, height [, playerid])

  设置元件宽度为 width ，高度为 height 。
  width:{number} 元件的宽度。
  height:{number} 元件的新高度。

• setAngle(angle [, playerid])

  旋转元件至 angle 角度。
  angle:{number} 旋转角。
  将 原始元件(角度为 0 ) 以 元件位置 为旋转点 顺时针 旋转 angle 度得到旋转后的元件。

• setColor(color [, playerid])

  设置元件 RGB 颜色为 color 。
  color:{integer} RGB 颜色值，取值范围为 0x000000~0xffffff。

• setAlpha(alpha [, playerid]

  设置元件透明度为 alpha 。
  alpha:{number} 透明度，取值范围为 0~100 。
  alpha 为 0 表示完全透明， 100 表示完全不透明。

UI.Texture 类

一个 UI.Texture 对象代表一个 UI 图片元件，以下简称 Texture 。
使用 UI.Texture:new(uiview, elementid); 来构造一个 Texture 对象。

• uiview:{table<UIView>} 元件的父 UIView 对象。
• 函数等价于 uiview:newTexture(elementid); 。
• 下面提到的元件对象构造函数与该函数类似，所以会省略描述。

方法

• setTexture(url [, playerid])

  设置图片的纹理为 url 。 url:{string} 图案纹理 id 。
  可以通过 "ID库" -> "图片" 来获取 url 。

UI.Button 类

一个 UI.Button 对象代表一个 UI 图片元件，以下简称 Button 。
使用 UI.Button:new(uiview, elementid); 来构造一个 Button 对象。

属性

• pressEvent:{function | nil} 按钮按下事件

  默认为 nil ，表示在事件发生时无需回调。
  你可以修改它来改变回调的函数。
  与 registerEvent([[$ui.onPress]], pressEvent, uiid) 类似，会传递 param 作为参数。
  param 额外包含 element 键，表示这个 Button 对象。

• clickEvent:{function | nil} 按钮点击事件

  与 pressEvent 类似，但是在按钮被点击时回调。

UI.Label 类

一个 UI.Label 对象代表一个 UI 文字元件，以下简称 Label 。
使用 UI.Label:new(uiview, elementid); 来构造一个 Label 对象。

方法

• setText(text [, playerid])

  设置文字元件显示的文本为 text 。
  text:{string} 显示的文本。
  如果 text 太长，这似乎不会起作用。
  显示的文本不会被屏蔽。

• setFontSize(size [, playerid])

  设置文本元件的字体大小为 size 。
  size:{number} 字体大小。
  要想知道多大的 size 是合适的，你可以在 UI 编辑器中测试。

UI.EditBox 类

一个 UI.EditBox 对象代表一个 UI 输入框元件，以下简称 EditBox 。
使用 UI.EditBox:new(uiview, elementid); 来构造一个 EditBox 对象。

属性

• lostFocusEvent:{function | nil} 输入框失去焦点事件。

  默认为 nil ，表示在事件发生时无需回调。
  你可以修改它来改变回调的函数。
  与 registerEvent([[$ui.onLostFocus]], lostFocusEvent, uiid) 类似，会传递 param 作为参数。
  param 额外包含 element 键，表示这个 Button 对象。
  提示: param 中 content:{string} 是最有用的参数，表示输入框输入的信息。
  输入框的内容会先被和谐然后才会回调，这意味着 content 是和谐后的内容。
  注意 setText() 方法不会使文本被和谐。

实例

情形

已知一 UI 界面 u 下有一个输入框元件 e 和一个文字元件 l ，要求如下：

• 在玩家没有输入 e 时， l 总是显示 "输入 16 进制数" ，开始输入时 e 的内容清空
• e 完成输入时，尝试将其解释为 16 进制数，并转化为 10 进制数，并将结果反应在 l上。
• 如果输入不合法，无法将其转化，则设置 l 的文本为 "错误的输入"

分析

• 要在开始输入时清空 e 的内容，需要处理一个 $ui.onClick 事件。实现方法是再创建一个按钮元件，设为 b ，将 e 设为 b 的子集，调整 b 的外观并将使其刚好覆盖 e ，这样当玩家点击输入框开始输入时，也会触发按钮的点击事件(clickEvent)，这时就能修改 e 的内容了。
• 经测试，当按钮被点击时焦点才会进入输入框，所以不要使用按下事件。
• 使用 tonumber(e [, base]) 函数来转化数字。

代码

Env.__init__()
-- 需替换以下 id
local uiview_id = [[]]
local editBox_id = [[]]
local label_id = [[]]
local button_id = [[]]
uiview = UI.UIView:new(uiview_id)
editBox = uiview:newEditBox(editBox_id)
label = uiview:newLabel(label_id)
button = uiview:newButton(button_id)
-- 初始化
registerEvent([[Game.AnyPlayer.EnterGame]], function(param)
    uiview:show()
    label:setText("")
    editBox:setText("输入 16 进制数")
end)
function button.clickEvent(param)
    -- 清空输入框
    editBox:setText("")
end
function editBox.lostFocusEvent(param)
    local num = tonumber(param["content"], 16)
    if num then
        label:setText(tostring(num))
    else
        label:setText("错误的输入")
    end
    editBox:setText("输入 16 进制数")
end