雪舞：整理当前服务端 Lua 接口：注册名称、参数、返回值与调用说明

2026-09-07T11:16:09Z

整理当前服务端 Lua 接口：注册名称、参数、返回值与调用说明

新页面

__NOTOC__
<div class="lua-reference" style="max-width:1200px;margin:0 auto;line-height:1.8;color:#29343a;font-family:Arial,'Microsoft YaHei',sans-serif;letter-spacing:0;overflow-wrap:anywhere;">
[[首页|首页]] · [[Lua接口/服务端函数索引|服务端接口]] · [[Lua接口/服务端调用约定|调用约定]]

<div style="padding:14px 0;border-top:3px solid #287568;">场景与副本：44 个接口，44 个调用名称。</div>
{| class="wikitable" style="width:100%;table-layout:fixed;border-collapse:collapse;font-size:13px;"
! scope="col" style="text-align:left;background:#edf3f2;padding:8px;width:36%;" | 函数 / 别名
! scope="col" style="text-align:left;background:#edf3f2;padding:8px;" | 调用与用途
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/FindCopySceneIDByCopySceneParams|FindCopySceneIDByCopySceneParams]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">FindCopySceneIDByCopySceneParams(sceneId, copySceneType, checkParamNum, ...)</code> 按指定的副本参数查找正在运行的副本场景。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/GetMonsterCount|GetMonsterCount]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">GetMonsterCount(sceneId)</code> 取得此场景中的怪物数量
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/GetMonsterObjID|GetMonsterObjID]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">GetMonsterObjID(sceneId, nIndex)</code> 根据索引号取得怪物的ObjID
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/IsCanEnterCopyScene|IsCanEnterCopyScene]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">IsCanEnterCopyScene(sceneId, guid)</code> 判断玩家是否可以进入场景sceneId,
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LoadMonsterIni|LoadMonsterIni]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LoadMonsterIni(sceneId, monsterIni)</code> 在指定场景执行怪物分布文件。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnAskNpcScriptMail|LuaFnAskNpcScriptMail]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnAskNpcScriptMail(sceneId, selfId, scriptType)</code> 请求世界服务器下发 NPC 脚本邮件。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnCreateCopyScene|LuaFnCreateCopyScene]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnCreateCopyScene(sceneId)</code> 根据当前场景已设置的副本创建参数，创建或选择副本场景。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnGetCopyScene_HumanCount|LuaFnGetCopyScene_HumanCount]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnGetCopyScene_HumanCount(sceneId)</code> 返回当前场景里面的玩家数量
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnGetCopyScene_HumanObjId|LuaFnGetCopyScene_HumanObjId]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnGetCopyScene_HumanObjId(sceneId, uIndex)</code> 读取场景参数信息
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnGetCopySceneData_NoUserCloseTime|LuaFnGetCopySceneData_NoUserCloseTime]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnGetCopySceneData_NoUserCloseTime(sceneId)</code> 返回没有人后副本场景自动关闭清除的时间（毫秒）。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnGetCopySceneData_Param|LuaFnGetCopySceneData_Param]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnGetCopySceneData_Param(sceneId, uIndex)</code> 读取场景参数信息
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnGetCopySceneData_TeamLeader|LuaFnGetCopySceneData_TeamLeader]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnGetCopySceneData_TeamLeader(sceneId)</code> 返回副本创建数据里的队长GUID，失败－1
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnGetCopySceneData_Timer|LuaFnGetCopySceneData_Timer]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnGetCopySceneData_Timer(sceneId)</code> 读取场景定时器的时间间隔，如果为0表示没有设置。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnGetCopySceneIDByTeamLeaderGUID|LuaFnGetCopySceneIDByTeamLeaderGUID]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnGetCopySceneIDByTeamLeaderGUID(sceneId, teamLeaderGUID, copySceneType)</code> 按队长和副本类型查找正在运行的副本场景。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnGetSceneAttr_CanCreateRascalKiller|LuaFnGetSceneAttr_CanCreateRascalKiller]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnGetSceneAttr_CanCreateRascalKiller(sceneId)</code> 返回场景是否允许创建惩罚恶人 NPC，缺少配置时返回 0。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnGetSceneAttr_RandomMonsterDataID|LuaFnGetSceneAttr_RandomMonsterDataID]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnGetSceneAttr_RandomMonsterDataID(sceneId)</code> 从场景配置的候选怪物中随机返回一个数据编号。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnGetSceneClientResID|LuaFnGetSceneClientResID]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnGetSceneClientResID(sceneId)</code> 返回场景使用的客户端资源编号。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnGetSceneSafeLevel|LuaFnGetSceneSafeLevel]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnGetSceneSafeLevel(sceneId)</code> 返回场景的安全等级限制。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnGetSceneType|LuaFnGetSceneType]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnGetSceneType(sceneId)</code> 返回当前场景的类型，详见:Config/SceneInfo.ini 里Type字段描述
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnGetSceneWeather|LuaFnGetSceneWeather]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnGetSceneWeather(sceneId)</code> 返回场景当前天气编号，未设置天气时返回 -1。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnIsCharacterLiving|LuaFnIsCharacterLiving]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnIsCharacterLiving(sceneId, objId)</code> 判断objId号的Obj是否是活的
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnIsObjValid|LuaFnIsObjValid]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnIsObjValid(sceneId, objId)</code> 判断是否拥有objId号的Obj
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSendMailToAllFriend|LuaFnSendMailToAllFriend]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSendMailToAllFriend(sceneId, selfId, szMail, numArg, ...)</code> 给所有好友发送普通邮件
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSendMailToGUID|LuaFnSendMailToGUID]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSendMailToGUID(sceneId, guid, szMail)</code> 按角色 GUID 发送系统邮件。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSendNormalMail|LuaFnSendNormalMail]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSendNormalMail(sceneId, selfId, szName, szMail)</code> 发送普通邮件
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSendScriptMail|LuaFnSendScriptMail]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSendScriptMail(sceneId, szName, uParam0, uParam1, uParam2, uParam3)</code> 发送可执行邮件
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSendSystemMail|LuaFnSendSystemMail]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSendSystemMail(sceneId, szName, szMail)</code> 发送系统邮件
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetCopySceneData_NoUserCloseTime|LuaFnSetCopySceneData_NoUserCloseTime]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetCopySceneData_NoUserCloseTime(sceneId, closeTime)</code> 设置副本创建数据里的:没有人后副本场景自动关闭清除的时间。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetCopySceneData_Param|LuaFnSetCopySceneData_Param]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetCopySceneData_Param(sceneId, uIndex, nValue)</code> 设置副本创建数据里的:场景参数信息
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetCopySceneData_PvpRuler|LuaFnSetCopySceneData_PvpRuler]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetCopySceneData_PvpRuler(sceneId, pvpRuler)</code> 设置副本场景的 PVP 规则。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetCopySceneData_TeamLeader|LuaFnSetCopySceneData_TeamLeader]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetCopySceneData_TeamLeader(sceneId, guidLeader)</code> 设置副本创建数据里的队长GUID
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetCopySceneData_Timer|LuaFnSetCopySceneData_Timer]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetCopySceneData_Timer(sceneId, uTime)</code> 设置副本创建数据里的:场景定时器的时间间隔，如果为0表示没有设置。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetIsCityCopyScene|LuaFnSetIsCityCopyScene]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetIsCityCopyScene(sceneId, isCityCopyScene)</code> 设置场景的城市副本标志。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetSceneCopySceneCityData|LuaFnSetSceneCopySceneCityData]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetSceneCopySceneCityData(sceneId, destSceneId)</code> 将源场景的城市初始化数据复制到目标场景。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetSceneLoad_Area|LuaFnSetSceneLoad_Area]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetSceneLoad_Area(sceneId, areaName)</code> 设置副本创建选项里的事件区分布文件,类似"*_area.ini",
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetSceneLoad_GrowPointData|LuaFnSetSceneLoad_GrowPointData]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetSceneLoad_GrowPointData(sceneId, growpointdataName)</code> 设置副本创建选项里的生长点分布文件,类似"*_growpoint.ini",
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetSceneLoad_GrowPointSetup|LuaFnSetSceneLoad_GrowPointSetup]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetSceneLoad_GrowPointSetup(sceneId, growpointsetupName)</code> 设置副本创建选项里的从生长点里能生成的物品分布文件,类似"*_growpointsetup.ini",
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetSceneLoad_Map|LuaFnSetSceneLoad_Map]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetSceneLoad_Map(sceneId, mapName)</code> 设置副本创建选项里的导航图文件，类似"*.nav", 不需要带路径
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetSceneLoad_Monster|LuaFnSetSceneLoad_Monster]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetSceneLoad_Monster(sceneId, monsterName)</code> 设置副本创建选项里的怪物分布文件,类似"*_monster.ini",
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetSceneLoad_PatrolPointData|LuaFnSetSceneLoad_PatrolPointData]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetSceneLoad_PatrolPointData(sceneId, patrolpointdataName)</code> 设置副本创建选项里的巡逻路径分布文件,类似"*_patrolpoint.ini",
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetSceneLoad_Pet|LuaFnSetSceneLoad_Pet]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetSceneLoad_Pet(sceneId, petName)</code> 设置副本创建选项里的宠物分布文件,类似"*_pet.ini",
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetSceneLoad_Platform|LuaFnSetSceneLoad_Platform]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetSceneLoad_Platform(sceneId, platformName)</code> 设置副本创建选项里的操作台分布文件,类似"*_platform.ini",
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetSceneSafeLevel|LuaFnSetSceneSafeLevel]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetSceneSafeLevel(sceneId, safeLevel)</code> 设置场景的安全等级限制。
|-
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | [[Lua接口/服务端/LuaFnSetSceneWeather|LuaFnSetSceneWeather]]
| style="padding:8px;vertical-align:top;overflow-wrap:anywhere;" | <code style="white-space:normal;overflow-wrap:anywhere;">LuaFnSetSceneWeather(sceneId, weather, leftTime)</code> 设置场景天气及其剩余持续时间（毫秒）。
|}
</div>

Lua接口/服务端函数索引/场景与副本 - 版本历史

雪舞：​整理当前服务端 Lua 接口：注册名称、参数、返回值与调用说明

雪舞：整理当前服务端 Lua 接口：注册名称、参数、返回值与调用说明