Lua接口/服务端/SetTimer:修订间差异
来自雪舞天龙知识库
跳到导航跳到搜索
整理当前服务端 Lua 接口:注册名称、参数、返回值与调用说明 |
维护服务端 Lua 接口:核对参数、返回值、边界条件与调用示例 |
||
| (未显示2个用户的6个中间版本) | |||
| 第1行: | 第1行: | ||
__NOTOC__ | __NOTOC__ | ||
<div class="lua-reference | <div class="lua-reference"> | ||
[[首页|首页]] · [[Lua接口/服务端函数索引|服务端接口]] · [[Lua接口/服务端函数索引/通用与活动|通用与活动]] · [[Lua接口/服务端调用约定|调用约定]] | [[首页|首页]] · [[Lua接口/服务端函数索引|服务端接口]] · [[Lua接口/服务端函数索引/通用与活动|通用与活动]] · [[Lua接口/服务端调用约定|调用约定]] | ||
<div | <div class="lua-lead lua-rule">给玩家打开计时器,时间到时将自动调用OnTimer函数</div> | ||
== Lua 调用 == | == Lua 调用 == | ||
<pre | <pre>SetTimer(sceneId, selfId, scriptId, funcName, tickTime)</pre> | ||
服务端脚本中共出现 7 处调用,实参个数出现过:5 个(7 处)。 | |||
实现位于 <code>LuaFnTbl_Misc.h</code>。 | |||
== 参数 == | == 参数 == | ||
{| class="wikitable | {| class="wikitable" | ||
! scope="col" | ! scope="col" class="lua-w11" | 序号 | ||
! scope="col" | ! scope="col" class="lua-w36" | 参数 / 类型 | ||
! scope="col | ! scope="col" | 说明 | ||
|- | |- | ||
| 1 | |||
| <code>sceneId</code><br /><span class="lua-muted"><code>number</code></span> | |||
| | | 当前调用所在的场景 ID。<br /><span class="lua-muted">脚本中的实参:<code>sceneId</code>(7 处)</span> | ||
|- | |- | ||
| 2 | |||
| <code>selfId</code><br /><span class="lua-muted"><code>number</code></span> | |||
| | | 当前场景内的对象 ID。玩家接口需传入有效玩家对象;不是角色 GUID。<br /><span class="lua-muted">脚本中的实参:<code>selfId</code>(5 处)、<code>playerId</code>(2 处)</span> | ||
|- | |- | ||
| 3 | |||
| <code>scriptId</code><br /><span class="lua-muted"><code>number</code></span> | |||
| | | 执行脚本ID,short类型<br /><span class="lua-muted">脚本中的实参:<code>005116</code>、<code>212115</code>、<code>300001</code></span> | ||
|- | |- | ||
| 4 | |||
| <code>funcName</code><br /><span class="lua-muted"><code>string</code></span> | |||
| | | 计时器回调调函数名,字符串类型<br /><span class="lua-muted">脚本中的实参:<code>"OnSceneTimer"</code>(4 处)、<code>"OnScneneTimer"</code>、<code>"OnTimer"</code></span> | ||
|- | |- | ||
| 5 | |||
| <code>tickTime</code><br /><span class="lua-muted"><code>number</code></span> | |||
| | | 计时器调用间隔时间<br /><span class="lua-muted">脚本中的实参:<code>1</code>(3 处)、<code>1000</code>、<code>10000</code></span> | ||
|} | |} | ||
== 返回值 == | == 返回值 == | ||
返回 1 个值。返回类型包括 <code | 返回 1 个值。返回类型包括 <code>number</code>。明确的固定返回组合包括 <code>-1</code>。 | ||
== 用法补充 == | == 用法补充 == | ||
给玩家打开计时器,时间到时将自动调用OnTimer函数<br /> | 给玩家打开计时器,时间到时将自动调用OnTimer函数<br /> | ||
玩家本身身上并没有计时器,脚本程序需要计时器时向系统申请“租用”,由系统分配 | 玩家本身身上并没有计时器,脚本程序需要计时器时向系统申请“租用”,由系统分配 | ||
== 调用示例 == | |||
以下取自随包服务端脚本的真实调用,可对照上方参数表确认参数顺序: | |||
<pre>-- event/juqing/juxianzhuang_03.lua | |||
SetTimer(sceneId, selfId, x200022_g_ScriptId, "OnSceneTimer", 1) | |||
-- event/sceneevent/emiaojiang_639.lua | |||
SetTimer(sceneId, selfId, 212115, "OnScneneTimer", 1) | |||
-- event/sceneevent/shilin_940.lua | |||
SetTimer(sceneId, selfId, x212124_g_ScriptId, "OnSceneTimer", 1)</pre> | |||
== 注意事项 == | == 注意事项 == | ||
* 调用对象必须是当前场景中的有效玩家。 | * 调用对象必须是当前场景中的有效玩家。 | ||
* 实现体检查 <code>sceneTimerIndex>=0 && sceneTimerIndex < g_Config.m_ConfigInfo.m_MaxTimerCount</code>,不满足时记录断言「No Timer resource for allocate」。 | |||
< | |||
</div> | </div> | ||
2026年10月27日 (二) 12:33的最新版本
给玩家打开计时器,时间到时将自动调用OnTimer函数
Lua 调用
SetTimer(sceneId, selfId, scriptId, funcName, tickTime)
服务端脚本中共出现 7 处调用,实参个数出现过:5 个(7 处)。
实现位于 LuaFnTbl_Misc.h。
参数
| 序号 | 参数 / 类型 | 说明 |
|---|---|---|
| 1 | sceneIdnumber
|
当前调用所在的场景 ID。 脚本中的实参: sceneId(7 处)
|
| 2 | selfIdnumber
|
当前场景内的对象 ID。玩家接口需传入有效玩家对象;不是角色 GUID。 脚本中的实参: selfId(5 处)、playerId(2 处)
|
| 3 | scriptIdnumber
|
执行脚本ID,short类型 脚本中的实参: 005116、212115、300001
|
| 4 | funcNamestring
|
计时器回调调函数名,字符串类型 脚本中的实参: "OnSceneTimer"(4 处)、"OnScneneTimer"、"OnTimer"
|
| 5 | tickTimenumber
|
计时器调用间隔时间 脚本中的实参: 1(3 处)、1000、10000
|
返回值
返回 1 个值。返回类型包括 number。明确的固定返回组合包括 -1。
用法补充
给玩家打开计时器,时间到时将自动调用OnTimer函数
玩家本身身上并没有计时器,脚本程序需要计时器时向系统申请“租用”,由系统分配
调用示例
以下取自随包服务端脚本的真实调用,可对照上方参数表确认参数顺序:
-- event/juqing/juxianzhuang_03.lua SetTimer(sceneId, selfId, x200022_g_ScriptId, "OnSceneTimer", 1) -- event/sceneevent/emiaojiang_639.lua SetTimer(sceneId, selfId, 212115, "OnScneneTimer", 1) -- event/sceneevent/shilin_940.lua SetTimer(sceneId, selfId, x212124_g_ScriptId, "OnSceneTimer", 1)
注意事项
- 调用对象必须是当前场景中的有效玩家。
- 实现体检查
sceneTimerIndex>=0 && sceneTimerIndex < g_Config.m_ConfigInfo.m_MaxTimerCount,不满足时记录断言「No Timer resource for allocate」。