Lua接口/客户端窗口操作

首页 · 客户端接口 · 窗口操作 · 客户端事件

客户端窗口操作

界面脚本通过窗口对象操作控件：29 个控件类 · 144 个方法

本页信息由客户端 C++ 绑定源码与 230 个界面脚本自动整理：参数取实现体的 args[n] 取值点（对象方法已扣除 self 占用的栈位），调用示例取脚本中的真实调用，未经运行验证；用途摘要按实现体归纳，仅供参考。

使用方式

界面脚本里的 this 就是当前窗口对象，在界面事件回调里直接调用：

function ChatInfo_OnEvent(event, arg1, arg2)
    if event == "OPEN_WINDOW" then
        this:Show()
        local visible = this:IsVisible()
    end
end

• this:RegisterEvent("事件名") 订阅本窗口关心的事件，事件名见客户端事件。
• this:Show() 与 this:Hide() 控制显示与隐藏，this:IsVisible() 返回当前是否可见。
• this:CareObject(对象编号) 关注某个对象，服务器状态变化时触发 OBJECT_CARED_EVENT。
• CEArg 是事件参数对象，用 CEArg:GetValue(索引) 取事件携带的数据。

控件方法

控件对象由界面管理器创建后交给脚本，脚本中多以 this 或局部变量持有，没有固定的全局对象名。下表按控件类分组，方法名可点进独立页查看参数与返回值；页面标题用的是脚本侧名称，与实现类不同时在标题处注明。

Window（27）

方法	说明
Window:AutoMousePosition(string, string) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:CaptureInput() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:CenterWindow() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:Disable() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.h
Window:Enable() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.h
Window:FlashMe(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:GetItemElementsString() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:GetName() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.h
Window:GetPixelRect() 4 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:GetProperty(string) 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:GetText() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:GetToolTip() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:GetType() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.h
Window:GetWindowSize() 2 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:Hide() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:IsVisible() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.h
Window:SetClippedByParent(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:SetForce() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:SetItemElementsString(string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
Window:SetProperty(string, string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
Window:SetText(number) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
Window:SetTextOriginal(string) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:SetToolTip(string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
Window:SetWindowCenter(number, number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:SetWindowSize(number, number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Window:Show() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.h
Window:TransText() 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp

ListBox（18）

方法	说明
ListBox:AddItem(string, number, string, number) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
ListBox:ClearListBox() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:ClearSelectState() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:DelItem(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:EnsureItemIsVisable(number) 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:GetClickItem() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:GetCurrentFirstItem() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:GetFirstSelectItem() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:GetItem(number) 2 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:GetItemByText(string) 1 个返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
ListBox:GetItemNumber() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:GetItemUserData(number) 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:SetCurrentFirstItem(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:SetItemSelect(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:SetItemSelectByItemID(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:SetItemTooltip(number, string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
ListBox:SetItemUserData(number, number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ListBox:SetListItemText(number, string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp

CtrlList（17）

方法	说明
CtrlList:AddColumn(string, number) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
CtrlList:AddNewItem(string, number, number) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
CtrlList:DeleteItem(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
CtrlList:GetColumnCount() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
CtrlList:GetItemCount() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
CtrlList:GetItemText(number, number) 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
CtrlList:GetRowUserData(number) 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
CtrlList:GetSelectItem() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
CtrlList:InsertColumn(string, number, number) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
CtrlList:RemoveAllItem() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
CtrlList:RemoveColumnByPos(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
CtrlList:SetItemData(number, number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
CtrlList:SetItemText(number, number, string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
CtrlList:SetRowTooltip(number, string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
CtrlList:SetRowUserData(number, number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
CtrlList:SetSelectItem(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
CtrlList:SetVertScollPosition(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

ComplexWindow（12）

方法	说明
ComplexWindow:AddActionElement(number, number, number, number) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
ComplexWindow:AddChatBoardElement(string, number) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
ComplexWindow:AddImpactElement(string, number, number) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
ComplexWindow:AddItemElement(number, number, number, number) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
ComplexWindow:AddJiaoZiElement(string) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ComplexWindow:AddMoneyElement(string) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ComplexWindow:AddOptionElement(string, string, string, string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
ComplexWindow:AddTextElement(string, string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
ComplexWindow:ClearAllElement() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ComplexWindow:PageEnd() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ComplexWindow:RemoveTopElement() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ComplexWindow:SetTextColour() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

ActionButton（10）

方法	说明
ActionButton:Bright() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ActionButton:DoAction() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ActionButton:DoSubAction() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ActionButton:GetActionItem() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ActionButton:Gloom() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ActionButton:SetActionItem(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ActionButton:SetFlash(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ActionButton:SetNewFlash() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ActionButton:SetPushed(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ActionButton:ShowPercentage(number, number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

Scenemap（8）

方法	说明
Scenemap:CloseSceneMap() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Scenemap:DoScroll(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Scenemap:GetMouseScenePos() 2 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Scenemap:SetSceneFileName(number, number, string) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Scenemap:SetSceneZoomMode(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Scenemap:UpdateFlag() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Scenemap:UpdateSceneMap() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Scenemap:UpdateViewRect() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

CUIWindowItem（8）

方法	说明
CUIWindowItem:CareObject(number, number, string) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UIWindowMng.cpp
CUIWindowItem:ClickHide() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UIWindowMng.cpp
CUIWindowItem:Hide() 无返回值	读取客户端本地数据 CEGUISystem/UIWindowMng.cpp
CUIWindowItem:IsVisible() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UIWindowMng.cpp
CUIWindowItem:RegisterEvent(string) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UIWindowMng.cpp
CUIWindowItem:Show() 无返回值	读取客户端本地数据 CEGUISystem/UIWindowMng.cpp
CUIWindowItem:TogleShow() 无返回值	读取客户端本地数据 CEGUISystem/UIWindowMng.cpp
CUIWindowItem:TransAllWindowText() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UIWindowMng.cpp

ComboBox（5）

方法	说明
ComboBox:AddTextItem(string, number) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
ComboBox:ComboBoxAddItem() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ComboBox:GetCurrentSelect() 2 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ComboBox:ResetList() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ComboBox:SetCurrentSelect(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

ChatHistory（4）

方法	说明
ChatHistory:ExtendClearRegion() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ChatHistory:InsertChatString(string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
ChatHistory:RemoveAllChatString() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ChatHistory:ScrollToEnd() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

PopMenu（3）

方法	说明
PopMenu:ClosePopMenu() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
PopMenu:OpenPopMenu() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
PopMenu:SetPopMenuPos(string, string) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

MeshWindow（3）

方法	说明
MeshWindow:RotateBegin(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
MeshWindow:RotateEnd() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
MeshWindow:SetFakeObject(string) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

ChatChannel（3）

方法	说明
ChatChannel:AddChannel(string, string, string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
ChatChannel:ClearAllChannel() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ChatChannel:GetHoverChannelName() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

Worldmap（3）

方法	说明
Worldmap:GetCurrentSelectScene() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Worldmap:InitWorldMap() 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
Worldmap:UpdateWorldMap() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

ProgressBar（2）

方法	说明
ProgressBar:GetProgress(number) 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ProgressBar:SetProgress(number, number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

Minimap（2）

方法	说明
Minimap:SetFlagShow(number, boolean) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
Minimap:UpdateFlag() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

CheckButton（2）

方法	说明
CheckButton:GetCheck() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
CheckButton:SetCheck(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

StaticImage（2）

方法	说明
StaticImage:SetImage(string, string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp
StaticImage:SetImageColor(string) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

ScrollBar（2）

方法	说明
ScrollBar:GetPosition() 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ScrollBar:SetPosition(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

ScrollInfoFixed（2）

方法	说明
ScrollInfoFixed:ClearInfo() 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
ScrollInfoFixed:SetScrollInfoFixed(string, string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp

IMEEditBox（2）

方法	说明
IMEEditBox:SetBlinkText(number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp
IMEEditBox:SetSelected(number, number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

ImageListBox（1）

方法	说明
ImageListBox:AddItem(string, number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

ImageListBoxEx（1）

方法	说明
ImageListBoxEx:AddItem(string, number, number) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

SuperTooltip（1）

方法	说明
SuperTooltip:PositionSelf(string, string) 2 个返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

ChatBoard（1）

方法	说明
ChatBoard:SetChatString(string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp

InfoList（1）

方法	说明
InfoList:AddInfo(string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp

ScrollInfo（1）

方法	说明
ScrollInfo:SetScrollInfo(string, string) 无返回值	读取客户端本地数据 CEGUISystem/UILuaControl.cpp

SoftKeyWindow（1）

方法	说明
SoftKeyWindow:SetAimEditBox(string) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

AnimateWindow（1）

方法	说明
AnimateWindow:Play(boolean) 无返回值	实现体未体现明确的外部效果 CEGUISystem/UILuaControl.cpp

CEArg（实现类 CEventArg）（1）

方法	说明
CEArg:GetValue(string) 1 个返回值	实现体未体现明确的外部效果 CEGUISystem/UIScript.cpp