Lua接口/客户端函数索引

来自天龙知识库
雪舞留言 | 贡献2026年9月19日 (六) 07:51的版本 (新建客户端 Lua 接口页:全局函数、对象方法、窗口操作与客户端事件)
(差异) ←上一版本 | 最后版本 (差异) | 下一版本→ (差异)
跳到导航跳到搜索

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

客户端 Lua 接口
面向客户端脚本的接口参考:全局函数与对象方法。客户端脚本负责界面与本地表现,实际数据以服务器下发为准。
213 个全局函数 · 64 个对象类(1344 个方法)· 338 个客户端事件 · 230 个界面脚本
本页参数与返回值由客户端 C++ 绑定源码自动推断(参数取自 args[n]lua_is* 的实际取值点,返回项数取自 return n),未经运行验证;用途摘要按实现体归纳,仅供参考。

调用方式

  • 全局函数直接按名称调用,例如 ShowSystemInfo("文本")
  • 对象方法要先取得对象再用冒号调用,例如 local n = DataPool:GetFriendCount()
  • this 是当前窗口对象,脚本里的 this:RegisterEvent("事件名")this:Show() 属于窗口操作
  • 事件名在客户端事件中查阅。

全局函数

共 213 个,直接作为全局名调用,全部函数见全局函数清单

分组 函数数 说明
界面与提示 77 CallScriptString、CloseAllWindow、CloseBooth、CloseFangDaohao 等
角色、物品与对象 17 AcceptRide、AskDetailByGuid、AskEquipDetial、AskEvaluateAndLevelup 等
系统与设置 17 ClearAllTimer、KillTimer、PlaySound、QuitApplication 等
其他 102 AnswerLevelUpCode、AutoHit、AutoRunToTarget、AxTrace 等

对象方法

对象方法按对象分组;对象名就是脚本里冒号前使用的名称。共 35 个对象类、1200 个方法。

对象
DataPool 实现类 DataPool · 181 个方法 · 脚本使用 360 处
Pet 实现类 Pet · 163 个方法 · 脚本使用 334 处
PlayerShop 实现类 PlayerShop · 87 个方法 · 脚本使用 222 处
Player 实现类 PlayerMySelf · 75 个方法 · 脚本使用 173 处
GameProduceLogin 实现类 CGameProduce_Login · 69 个方法 · 脚本使用 124 处
LifeAbility 实现类 LifeAbility · 61 个方法 · 脚本使用 138 处
Guild 实现类 Guild · 54 个方法 · 脚本使用 113 处
TargetPet 实现类 TargetPet · 48 个方法 · 脚本使用 131 处
GuildLeague 实现类 GuildLeague · 47 个方法 · 脚本使用 68 处
City 实现类 CityTable · 45 个方法 · 脚本使用 105 处
Talk 实现类 Talk · 43 个方法 · 脚本使用 79 处
Target 实现类 Character · 38 个方法 · 脚本使用 82 处
SystemSetup 实现类 SystemSetup · 36 个方法 · 脚本使用 78 处
StallSale 实现类 StallSale · 28 个方法 · 脚本使用 85 处
SuperTooltips 实现类 SuperTooltips · 27 个方法 · 脚本使用 59 处
PlayerPackage 实现类 PlayerPackage · 25 个方法 · 脚本使用 68 处
Exchange 实现类 Exchange · 24 个方法 · 脚本使用 67 处
StallBuy 实现类 StallBuy · 19 个方法 · 脚本使用 64 处
Bank 实现类 Bank · 17 个方法 · 脚本使用 45 处
NpcShop 实现类 NpcShop · 16 个方法 · 脚本使用 48 处
Friend 实现类 Friend · 16 个方法 · 脚本使用 47 处
CActionItem 实现类 CActionItem · 13 个方法 · 脚本使用 45 处
FindFriendDataPool 实现类 CFindFriendDataPool · 10 个方法 · 脚本使用 22 处
PetInviteFriend 实现类 PetInviteFriend · 9 个方法 · 脚本使用 35 处
FriendSearcher 实现类 FriendSearcher · 8 个方法 · 脚本使用 14 处
AbilityTeacher 实现类 AbilityTeacher · 7 个方法 · 脚本使用 13 处
CommisionShop 实现类 CommisionShop · 7 个方法 · 脚本使用 20 处
MissionReply 实现类 MissionReply · 6 个方法 · 脚本使用 27 处
StallBbs 实现类 StallBbs · 5 个方法 · 脚本使用 12 处
Blog 实现类 Blog · 3 个方法 · 脚本使用 14 处
GemCarve 实现类 GemCarve · 3 个方法 · 脚本使用 3 处
Sound 实现类 CSoundSystemFMod · 3 个方法 · 脚本使用 7 处
Helper 实现类 CHelperSystem · 3 个方法 · 脚本使用 5 处
GemMelting 实现类 GemMelting · 2 个方法 · 脚本使用 3 处
Variable 实现类 CVariableSystem · 2 个方法 · 脚本使用 12 处

窗口控件类(29 个类、144 个方法)见客户端窗口操作

约定

  • 参数个数与类型由实现体推断:客户端实现没有结构化注释块,类型来自 args[n].Is/Get*lua_is*/lua_to* 的取值点,取不到类型的参数会缺失。
  • 返回项数来自 return nreturn 0 表示无返回值(赋值接收得到 nil)。
  • 数字 0 与 -1 在 Lua 条件判断中都是真值,判断成功必须用明确比较。
  • 客户端函数只影响本机界面与本地数据,不改变服务器状态。
  • 未在游戏内执行验证,编号类参数与取值需按本服实机确认。